Merge pull request #54 from Brushfam/release/3.1.1

Cargo.toml

@@ -7,12 +7,11 @@ members = [
 exclude = [
     "examples",
     "example_project_structure",
-    "mock"
 ]
 
 [package]
 name = "openbrush"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2018"
 
@@ -31,8 +30,8 @@ ink = { version = "4.1.0", default-features = false}
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 scale-info = { version = "2.3", default-features = false, features = ["derive"], optional = true }
 
-openbrush_contracts = { version = "~3.0.0", path = "contracts", default-features = false }
-openbrush_lang = { version = "~3.0.0", path = "lang", default-features = false }
+openbrush_contracts = { version = "~3.1.1", path = "contracts", default-features = false }
+openbrush_lang = { version = "~3.1.1", path = "lang", default-features = false }
 
 [lib]
 name = "openbrush"

contracts/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "openbrush_contracts"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 
@@ -19,7 +19,7 @@ ink = { version = "4.1.0", default-features = false}
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 scale-info = { version = "2.3", default-features = false, features = ["derive"], optional = true }
 
-openbrush = { version = "~3.0.0", package = "openbrush_lang", path = "../lang", default-features = false }
+openbrush = { version = "~3.1.1", package = "openbrush_lang", path = "../lang", default-features = false }
 
 pallet-assets-chain-extension = { git = "https://github.com/727-ventures/pallet-assets-chain-extension", branch = "polkadot-v0.9.37", default-features = false, features = ["ink-lang"]  }
 

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 = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 
@@ -29,7 +29,7 @@ scale-info = { version = "2.3", default-features = false, features = ["derive"],
 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 = "~3.0.0", default-features = false, features = ["pausable", "access_control"] }
+openbrush = { version = "~3.1.1", default-features = false, features = ["pausable", "access_control"] }
 
 [lib]
 name = "lending_contract"

docs/docs/smart-contracts/overview.md

@@ -24,7 +24,7 @@ scale = { package = "parity-scale-codec", version = "3", default-features = fals
 scale-info = { version = "2.3", default-features = false, features = ["derive"], optional = true }
 
 # Brush dependency
-openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.0.0", default-features = false }
+openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.1.1", default-features = false }
 
 [features]
 default = ["std"]
@@ -73,17 +73,17 @@ The name of the feature is the same as the name of the module. For example:
 
 To enable `psp22`:
 ```toml
-openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.0.0", default-features = false, features = ["psp22"] }
+openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.1.1", default-features = false, features = ["psp22"] }
 ```
 
 To enable `ownable`:
 ```toml
-openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.0.0", default-features = false, features = ["ownable"] }
+openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.1.1", default-features = false, features = ["ownable"] }
 ```
 
 To enable both:
 ```toml
-openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.0.0", default-features = false, features = ["psp22, ownable"] }
+openbrush = { git = "https://github.com/727-Ventures/openbrush-contracts", version = "~3.1.1", default-features = false, features = ["psp22, ownable"] }
 ```
 
 After enabling the feature and importing the corresponding module, you need to embed the module 

docs/docs/smart-contracts/proxy.md

@@ -8,6 +8,7 @@ This example shows how you can use the implementation of [proxy](https://github.
 ## Disclaimer
 
 Delegate calls [were marked](https://github.com/paritytech/ink/pull/1331#discussion_r953736863) as a possible attack vector in ink! Therefore the `Proxy` pattern will not work within OpenBrush until this is reimplemented in ink! 4.
+You can use this tutorial for general understanding of `Proxy` pattern.
 
 ## Step 1: Import default implementation
 

docs/docs/smart-contracts/upgradeable.md

@@ -13,7 +13,14 @@ Upgradeability allows experimenting and deploying the product at the early stage
 
 Decentralization can be achieved by providing the right to upgrade only to decentralized authority like governance, multisig, or another analog.
 
-There is also a possibility of smart contract upgradeability via `Proxy` and `Diamond` patterns, but these use `DelegateCall`. Delegate calls [were marked](https://github.com/paritytech/ink/pull/1331#discussion_r953736863) as a possible attack vector in ink! Therefore the `Proxy` and `Diamond` patterns will not work within OpenBrush until this is reimplemented in ink! 4.
+There is also a possibility of smart contract upgradeability via `Proxy` and `Diamond` patterns, but these use `DelegateCall`.
+Right now contracts that use `DelegateCall` are not supported by OpenBrush due to latest ink! changes, for more information, please check the following issues:
+
+- https://github.com/paritytech/ink/pull/1331#discussion_r953736863
+- https://github.com/Brushfam/openbrush-contracts/issues/36
+
+Our team is currently working on the new approach of working with `DelegateCall`. For now, we recommend using `Lazy` struct
+for the upgradeable contracts. `Lazy` is a wrapper for a storage field, that allows you to set it to its definite storage key.
 
 ## Storage layout
 
@@ -84,11 +91,12 @@ With this approach, you can order your units as you wish. You can add/remove/swa
 logic units and don't worry about storage layout because each logic unit will have its space 
 in the blockchain's storage. If storage keys are unique, those spaces don't overlap.
 
-OpenBrush provides [`openbrush::upgradeable_storage`](https://github.com/727-Ventures/openbrush-contracts/blob/main/lang/macro/src/lib.rs#L447) 
-attribute macro that implements all required traits with specified storage key(storage key is required input argument to macro). 
-Also, macro initializes the field with a default value if the field is not initialized before
-(it can be actual during the upgrade because new fields are not initialized yet).
-You can use that macro to define a logic unit.
+OpenBrush provides [`openbrush::upgradeable_storage`](https://github.com/727-Ventures/openbrush-contracts/blob/main/lang/macro/src/lib.rs#L447)
+attribute macro that implements some of the required traits with specified storage key(storage key is required input argument to macro).
+This way, macro will define the storage key for this struct, but WILL NOT set this struct by it's storage key automatically.
+So, you will need to perform such actions manually, or use `Lazy` wrapper. All of the `Lazy` and `Mapping` units that are defined inside of the type
+will have their definite storage keys to prevent storage corruption, also it will implement traits to ease the work with storage,
+like `Storage` to be accessible by using `.data()` method later.
 
 > **Note**: Each logic unit should have a unique storage key.
 The storage key should be used only once in the contract.
@@ -393,6 +401,9 @@ of your contract, permission system, etc.
 
 ### The `Diamond` Standard
 
+### Disclaimer
+Right now, you can't use diamond standard in OpenBrush because of the problems with delegate calls.
+
 Using `Diamond` Standard you can add support for several facets(logic layers) that 
 can be upgraded. [This standard](https://eips.ethereum.org/EIPS/eip-2535) came 
 from the ethereum network. It works in the same way in ink! but instead of the 
@@ -410,9 +421,6 @@ Each selector is unique and belongs only to one facet. So selectors of facets ca
 call to the smart contract to the corresponding facet (logic layer).
 `Diamond` contract has a function `diamond_cut` that allows registering each facet.
 
-OpenBrush provides default implementation for `Diamond` standard on ink!.
-For more details you can check [Diamond](diamond/diamond.md).
-
 All suggestions above ideally describe how to develop an upgradeable contract
 with multi-logic layers and many logic units.
 So here we will describe how to write facets (logic layers) with OpenBrush.
@@ -425,13 +433,7 @@ with storage.
 Each logic unit should have a unique storage key and be upgradeable (support initialization
 on demand, use storage key as an offset for all inner fields). It can be a struct with 
 one or many fields (structs without fields are useless) or an enum with at least two 
-variants (an enum with one variant is a structure). You can define struct/enum with the 
-`openbrush::upgradeable_storage` macro and have an independent logic unit. You can 
-create several units and combine them into one contract.
-
-> **Note**: If your contract has at least one field that is not defined with the 
-`openbrush::upgradeable_storage`, it will fail during execution. Each field should be 
-upgradeable in the facet.
+variants (an enum with one variant is a structure).
 
 As an example, we will define logic units for `PSP22` and `Ownable` facets.
 

example_project_structure/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lending_project"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected], [email protected]>"]
 edition = "2021"
 

example_project_structure/contracts/lending/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lending_contract"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

example_project_structure/contracts/loan/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "loan_contract"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

example_project_structure/contracts/shares/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "shares_contract"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

example_project_structure/contracts/stable_coin/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "stable_coin_contract"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/access_control/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_access_control"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/access_control_extensions/enumerable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_access_control_enumerable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/alternatives/diamond/ink/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_diamond"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/alternatives/diamond/rust/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rust_diamond"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/diamond/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_diamond"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/diamond/diamond_caller/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "diamond_caller"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/diamond/psp22_facet_v1/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_facet_v1"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/diamond/psp22_facet_v2/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_facet_v2"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/diamond/psp22_metadata_facet/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata_facet"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

mock/flash-borrower/Cargo.toml → examples/flash-borrower/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flash_borrower"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/ownable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_ownable"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/pausable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_pausable"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/payment_splitter/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_payment_splitter"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/proxy/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_proxy"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/proxy/psp22_metadata_upgradeable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata_upgradeable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/proxy/psp22_upgradeable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_upgradeable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/burnable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_burnable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/capped/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_capped"
-version = "3.0.0-beta.1"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/flashmint/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_flashmint"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/metadata/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_metadata"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/mintable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_mintable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/pausable/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_pausable"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"
 

examples/psp22_extensions/wrapper/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "my_psp22_wrapper"
-version = "3.0.0"
+version = "3.1.1"
 authors = ["Brushfam <[email protected]>"]
 edition = "2021"