From 99d06a65a461da76bac2c626315f81dd36e8078e Mon Sep 17 00:00:00 2001 From: Ethan Frey Date: Wed, 9 Mar 2022 20:13:11 +0100 Subject: [PATCH 1/3] Clarify the stability of cw-storage-plus, no longer Experimental --- packages/storage-plus/Cargo.toml | 2 +- packages/storage-plus/README.md | 25 ++++++++++++++++++------- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/packages/storage-plus/Cargo.toml b/packages/storage-plus/Cargo.toml index 7d49d877e..6032e7384 100644 --- a/packages/storage-plus/Cargo.toml +++ b/packages/storage-plus/Cargo.toml @@ -3,7 +3,7 @@ name = "cw-storage-plus" version = "0.13.0" authors = ["Ethan Frey "] 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" diff --git a/packages/storage-plus/README.md b/packages/storage-plus/README.md index ac07718fd..2b1e53c0e 100644 --- a/packages/storage-plus/README.md +++ b/packages/storage-plus/README.md @@ -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, butwe consider it mature enough +to be the standard storage layer for your contracts. ## Usage Overview From c7acbb573bc911b2673ebfc066847bd05c686fed Mon Sep 17 00:00:00 2001 From: Ethan Frey Date: Thu, 10 Mar 2022 13:08:44 +0100 Subject: [PATCH 2/3] Update packages/storage-plus/README.md Co-authored-by: Jakub Bogucki --- packages/storage-plus/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/storage-plus/README.md b/packages/storage-plus/README.md index 2b1e53c0e..56c5b0f16 100644 --- a/packages/storage-plus/README.md +++ b/packages/storage-plus/README.md @@ -18,7 +18,7 @@ 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, butwe consider it mature enough +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 From bd110774cc182105e8ec6a8f83f04677059a1cc3 Mon Sep 17 00:00:00 2001 From: Ethan Frey Date: Thu, 10 Mar 2022 13:08:50 +0100 Subject: [PATCH 3/3] Update packages/storage-plus/README.md Co-authored-by: Mauro Lacy --- packages/storage-plus/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/storage-plus/README.md b/packages/storage-plus/README.md index 56c5b0f16..3e2691df1 100644 --- a/packages/storage-plus/README.md +++ b/packages/storage-plus/README.md @@ -19,7 +19,7 @@ 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. +to be the **standard storage layer** for your contracts. ## Usage Overview