Merge pull request #156 from Supercolony-net/feature/release-2.2.0

Release of OpenBrush `2.2.0`
Supercolony-net · Jul 23, 2022 · d6e29f0 · d6e29f0
2 parents fe8738e + 239c50b
commit d6e29f0
Show file tree

Hide file tree

Showing 56 changed files with 75 additions and 69 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,7 @@ exclude = [
 
 [package]
 name = "openbrush"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2018"
 
@@ -38,8 +38,8 @@ ink_engine = { version = "~3.3.0", default-features = false, optional = true }
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 
-openbrush_contracts = { version = "~2.1.0", path = "contracts", default-features = false }
-openbrush_lang = { version = "~2.1.0", path = "lang", default-features = false }
+openbrush_contracts = { version = "~2.2.0", path = "contracts", default-features = false }
+openbrush_lang = { version = "~2.2.0", path = "lang", default-features = false }
 
 [lib]
 name = "openbrush"

diff --git a/README.md b/README.md
@@ -75,23 +75,29 @@ to call methods of that trait from some contract in the network
 (do a cross contract call).
 
 ```rust
+// Somewhere defined trait
 #[openbrush::trait_definition]
 pub trait Trait1 {
     #[ink(message)]
     fn foo(&mut self) -> bool;
 }
 
+// You can create wrapper in the place where you defined the trait
+// Or if you import **everything** from the file where you define trait
 #[openbrush::wrapper]
 type Trait1Ref = dyn Trait1;
 
 {
-    // It should be `AccountId` of some contract in the network
+    // It should be `AccountId` of contract in the network that implements `Trait1` trait
     let callee: openbrush::traits::AccountId = [1; 32].into();
     // This code will execute a cross contract call to `callee` contract
     let result_of_foo: bool = Trait1Ref::foo(&callee);
 }
 ```
 
+> **Note**: The trait should be defined with `openbrush::trait_definition`.
+The callee contract should implement that trait.
+
 ### Additional stuff
 
 - You can use [`test_utils`](https://github.com/Supercolony-net/openbrush-contracts/blob/main/lang/src/test_utils.rs#L39)
@@ -154,16 +160,16 @@ More common roadmap of tasks:
 - [x] Agnostic traits.
 - [x] Wrapper around the trait definition to do a cross-contract calls.
 - [X] PSP for NFT token and refactoring according new interface.
-- [ ] PSP for Multi token and refactoring according new interface.
+- [x] PSP for Multi token and refactoring according new interface.
 - [x] Add extension: `PSP34Enumerable`.
 - [x] Import all extensions for tokens from OpenZeppelin.
 - [x] Add support of upgradeable contracts to ink!/contract-pallet level.
 - [x] Implement `Proxy` pattern.
 - [x] Implement `Diamond` standard.
 - [x] Publish `openbrush` into [crates.io](https://crates.io/crates/openbrush)
-- [ ] Add documentation for upgradeable contracts(blocked until [resolving](https://github.com/paritytech/ink/pull/1217)).
-- [ ] Add extension: `AccessControlEnumerable`.
-- [ ] Add extension: `PSP35Enumerable`.
+- [x] Add documentation for upgradeable contracts.
+- [x] Add extension: `AccessControlEnumerable`.
+- [x] Add extension: `PSP35Enumerable`.
 - [ ] Force/help ink! to create new independent events. During this task decide how ink! can generate metadata for
   events/traits from other crates.
 - [ ] Cover everything with UT and integration tests.

diff --git a/contracts/Cargo.toml b/contracts/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "openbrush_contracts"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 
@@ -26,7 +26,7 @@ ink_engine = { version = "~3.3.0", default-features = false, optional = true }
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 
-openbrush = { version = "~2.1.0", package = "openbrush_lang", path = "../lang", default-features = false }
+openbrush = { version = "~2.2.0", package = "openbrush_lang", path = "../lang", default-features = false }
 
 [lib]
 name = "openbrush_contracts"

diff --git a/docs/docs/smart-contracts/example/contract.md b/docs/docs/smart-contracts/example/contract.md
@@ -16,7 +16,7 @@ implementation of `Lending` and `LendingPermissioned` traits defined in the `len
 ```toml
 [package]
 name = "lending_contract"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 
@@ -36,7 +36,7 @@ scale-info = { version = "2", default-features = false, features = ["derive"], o
 shares_contract = { path = "../shares", default-features = false, features = ["ink-as-dependency"]  }
 loan_contract = { path = "../loan", default-features = false, features = ["ink-as-dependency"]  }
 lending_project = { path = "../..", default-features = false }
-openbrush = { version = "~2.1.0", default-features = false, features = ["pausable", "access_control"] }
+openbrush = { version = "~2.2.0", default-features = false, features = ["pausable", "access_control"] }
 
 [lib]
 name = "lending_contract"

diff --git a/docs/docs/smart-contracts/overview.md b/docs/docs/smart-contracts/overview.md
@@ -30,7 +30,7 @@ scale = { package = "parity-scale-codec", version = "3", default-features = fals
 scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 
 # Brush dependency
-openbrush = { version = "~2.1.0", default-features = false }
+openbrush = { version = "~2.2.0", default-features = false }
 
 [features]
 default = ["std"]
@@ -89,17 +89,17 @@ The name of the feature is the same as the name of the module. For example:
 
 To enable `psp22`:
 ```toml
-openbrush = { version = "~2.1.0", default-features = false, features = ["psp22"] }
+openbrush = { version = "~2.2.0", default-features = false, features = ["psp22"] }
 ```
 
 To enable `ownable`:
 ```toml
-openbrush = { version = "~2.1.0", default-features = false, features = ["ownable"] }
+openbrush = { version = "~2.2.0", default-features = false, features = ["ownable"] }
 ```
 
 To enable both:
 ```toml
-openbrush = { version = "~2.1.0", default-features = false, features = ["psp22", "ownable"] }
+openbrush = { version = "~2.2.0", default-features = false, features = ["psp22", "ownable"] }
 ```
 
 After enabling the feature and importing the corresponding module, you need to embed the module 

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openbrush",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/example_project_structure/Cargo.toml b/example_project_structure/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "lending_project"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected], [email protected]>"]
 edition = "2021"
 

diff --git a/example_project_structure/contracts/lending/Cargo.toml b/example_project_structure/contracts/lending/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "lending_contract"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/example_project_structure/contracts/loan/Cargo.toml b/example_project_structure/contracts/loan/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "loan_contract"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/example_project_structure/contracts/shares/Cargo.toml b/example_project_structure/contracts/shares/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "shares_contract"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/example_project_structure/contracts/stable_coin/Cargo.toml b/example_project_structure/contracts/stable_coin/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "stable_coin_contract"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/access_control/Cargo.toml b/examples/access_control/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_access_control"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/access_control_extensions/enumerable/Cargo.toml b/examples/access_control_extensions/enumerable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_access_control_enumerable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/alternatives/diamond/ink/Cargo.toml b/examples/alternatives/diamond/ink/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_diamond"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/diamond/Cargo.toml b/examples/diamond/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_diamond"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/diamond/diamond_caller/Cargo.toml b/examples/diamond/diamond_caller/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "diamond_caller"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/diamond/psp22_facet_v1/Cargo.toml b/examples/diamond/psp22_facet_v1/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_facet_v1"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/diamond/psp22_facet_v2/Cargo.toml b/examples/diamond/psp22_facet_v2/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_facet_v2"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/diamond/psp22_metadata_facet/Cargo.toml b/examples/diamond/psp22_metadata_facet/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata_facet"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/ownable/Cargo.toml b/examples/ownable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_ownable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/pausable/Cargo.toml b/examples/pausable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_pausable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/payment_splitter/Cargo.toml b/examples/payment_splitter/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_payment_splitter"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/proxy/Cargo.toml b/examples/proxy/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_proxy"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/proxy/psp22_metadata_upgradeable/Cargo.toml b/examples/proxy/psp22_metadata_upgradeable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata_upgradeable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/proxy/psp22_upgradeable/Cargo.toml b/examples/proxy/psp22_upgradeable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_upgradeable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22/Cargo.toml b/examples/psp22/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/burnable/Cargo.toml b/examples/psp22_extensions/burnable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_burnable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/capped/Cargo.toml b/examples/psp22_extensions/capped/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_capped"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/flashmint/Cargo.toml b/examples/psp22_extensions/flashmint/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_flashmint"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/metadata/Cargo.toml b/examples/psp22_extensions/metadata/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/mintable/Cargo.toml b/examples/psp22_extensions/mintable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_mintable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/pausable/Cargo.toml b/examples/psp22_extensions/pausable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_pausable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_extensions/wrapper/Cargo.toml b/examples/psp22_extensions/wrapper/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_wrapper"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp22_utils/token_timelock/Cargo.toml b/examples/psp22_utils/token_timelock/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_token_timelock"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp34/Cargo.toml b/examples/psp34/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp34"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp34_extensions/burnable/Cargo.toml b/examples/psp34_extensions/burnable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp34_burnable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"
 

diff --git a/examples/psp34_extensions/enumerable/Cargo.toml b/examples/psp34_extensions/enumerable/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "my_psp34_enumerable"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Supercolony <[email protected]>"]
 edition = "2021"