Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the stability of cw-storage-plus, no longer Experimental #676

Merged
merged 3 commits into from
Mar 10, 2022
Merged

Clarify the stability of cw-storage-plus, no longer Experimental #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99d06a6
Clarify the stability of cw-storage-plus, no longer Experimental
ethanfrey Mar 9, 2022
c7acbb5
Update packages/storage-plus/README.md
ethanfrey Mar 10, 2022
bd11077
Update packages/storage-plus/README.md
ethanfrey Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/storage-plus/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "cw-storage-plus"
version = "0.13.0"
authors = ["Ethan Frey <[email protected]>"]
edition = "2018"
description = "Enhanced/experimental storage engines"
description = "Enhanced storage engines"
license = "Apache-2.0"
repository = "https://github.com/CosmWasm/cw-plus"
homepage = "https://cosmwasm.com"
Expand Down
25 changes: 18 additions & 7 deletions packages/storage-plus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# CW-Storage-Plus: Enhanced/experimental storage engines for CosmWasm
# CW-Storage-Plus: Enhanced storage engines for CosmWasm

The ideas in here are based on the `cosmwasm-storage` crate. However,
after much usage, we decided a complete rewrite could allow us to add
more powerful and easy to use interfaces. Here are those interfaces.
After building `cosmwasm-storage`, we realized many of the design decisions were
limiting us and producing a lot of needless boilerplate. The decision was made to leave
those APIs stable for anyone wanting a very basic abstraction on the KV-store and to
build a much more powerful and complex ORM layer that can provide powerful accessors
using complex key types, which are transparently turned into bytes.

This led to a number of breaking API changes in this package of the course of several
releases as we updated this with lots of experience, user feedback, and deep dives to harness
the full power of generics.

**Status: beta**

This has been heavily used in many production-quality contracts and
heavily refined. The code has demonstrated itself to be stable and powerful.
Please feel free to use it in your contracts.
As of `cw-storage-plus` `v0.12` the API should be quite stable.
There are no major API breaking issues pending, and all API changes will be documented
in [`MIGRATING.md`](../../MIGRATING.md).

This has been heavily used in many production-quality contracts.
The code has demonstrated itself to be stable and powerful.
It has not been audited, and Confio assumes no liability, but we consider it mature enough
to be the **standard storage layer** for your contracts.

## Usage Overview

Expand Down