Merge pull request #66 from srdtrk/cw-v1.0-storage

v0.7 Upgrade with Storage and Readme Updates (for Cosmwasm v1.0)

Author: toml01

Releases.md

@@ -2,8 +2,12 @@
 
 ## v0.7.0
 
-This release changes the internal toolkit package to be part of the workspace - this fixes default-features flags in some of the 
-crates. In addition, crates used by the toolkit have been bumped, and the edition of the toolkit crates has been bumped to 2021
+- This release changes the internal toolkit package to be part of the workspace - this fixes default-features flags in some of the crates. In addition, crates used by the toolkit have been bumped, and the edition of the toolkit crates has been bumped to 2021.
+
+- Added the `Keyset` storage object (A hashset like storage object).
+- Allowed further customisation of Keymap and Keyset with new constructor structs called `KeymapBuilder` and `KeysetBuilder` which allow the user to disable the iterator feature (saving gas) or adjust the internal indexes' page size so that the user may determine how many objects are to be stored/loaded together in the iterator.
+- `::new_with_page_size(namespace, page_size)` method was added to `AppendStore` and `DequeStore` so that the user may adjust the internal indexes' page size which determine how many objects are to be stored/loaded together in the iterator.
+- Minor performance upgrades to `Keymap`, `AppendStore`, and `DequeStore`.
 
 ### Breaking
 

packages/incubator/Readme.md

@@ -96,7 +96,7 @@ assert_eq!(heap_store.remove(), Ok(Tx{
 
 Also known as a slot map, a generational index storage is an iterable data structure where each element in the list is identified by a unique key that is a pair (index, generation). Each time an item is removed from the list the generation of the storage increments by one. If a new item is placed at the same index as a previous item which had been removed previously, the old references will not point to the new element. This is because although the index matches, the generation does not. This ensures that each reference to an element in the list is stable and safe.
 
-Starting with an empty set, if we insert A we will have key: (index: 0, generation: 0). Inserting B will have the key: (index: 1, generation: 0). When we remove A the generation will increment by 1 and index 0 will be freed up. When we insert C it will go to the head of our list of free slots and be given the key (index: 0, generation: 1). If you attempt to get A the result will be None, even though A and C have both been at "0" position in the list. 
+Starting with an empty set, if we insert A we will have key: (index: 0, generation: 0). Inserting B will have the key: (index: 1, generation: 0). When we remove A the generation will increment by 1 and index 0 will be freed up. When we insert C it will go to the head of our list of free slots and be given the key (index: 0, generation: 1). If you attempt to get A the result will be None, even though A and C have both been at "0" position in the list.
 
 Unlike AppendStore, iteration over a generational index storage is not in order of insertion.
 

packages/incubator/src/generational_store.rs

@@ -881,7 +881,7 @@ mod tests {
         assert_eq!(gen_store.get(delta.clone()), Some(String::from("Delta")));
         // check that the generation has updated
         assert_ne!(
-            delta.clone(),
+            delta,
             Index {
                 index: 1,
                 generation: 0

packages/snip20/Readme.md

@@ -11,13 +11,14 @@ You can create a HandleMsg variant and call the `to_cosmos_msg` function to gene
 Or you can call the individual function for each Handle message to generate the appropriate callback CosmosMsg.
 
 Example:
+
 ```ignore
-    let recipient = HumanAddr("ADDRESS_TO_TRANSFER_TO".to_string());
+    let recipient = "ADDRESS_TO_TRANSFER_TO".to_string();
     let amount = Uint128(10000);
     let padding = None;
     let block_size = 256;
     let callback_code_hash = "TOKEN_CONTRACT_CODE_HASH".to_string();
-    let contract_addr = HumanAddr("TOKEN_CONTRACT_ADDRESS".to_string());
+    let contract_addr = "TOKEN_CONTRACT_ADDRESS".to_string();
 
     let cosmos_msg = transfer_msg(
         recipient,
@@ -28,19 +29,17 @@ Example:
         contract_addr,
     )?;
 
-    Ok(HandleResponse {
-        messages: vec![cosmos_msg],
-        log: vec![],
-        data: None,
-    })
+    Ok(Response::new().add_message(cosmos_msg))
 ```
+
 All you have to do to call a SNIP-20 Handle function is call the appropriate toolkit function, and place the resulting `CosmosMsg` in the `messages` Vec of the InitResponse or HandleResponse.  In this example, we are transferring 10000 (in the lowest denomination of the token) to the recipient address.  We are not using the `padding` field of the Transfer message, but instead, we are padding the entire message to blocks of 256 bytes.
 
 You probably have also noticed that CreateViewingKey is not supported.  This is because a contract can not see the viewing key that is returned because it has already finished executing by the time CreateViewingKey would be called.  If a contract needs to have a viewing key, it must create its own sufficiently complex viewing key, and pass it as a parameter to SetViewingKey. You can see an example of creating a complex viewing key in the [Snip20 Reference Implementation](http://github.com/enigmampc/snip20-reference-impl).  It is also highly recommended that you use the block_size padding option to mask the length of the viewing key your contract has generated.
 
 ## Queries
 
 These are the types that SNIP20 tokens can return from queries
+
 ```ignore
 pub struct TokenInfo {
     pub name: String,
@@ -56,8 +55,8 @@ pub struct ExchangeRate {
 }
 
 pub struct Allowance {
-    pub spender: HumanAddr,
-    pub owner: HumanAddr,
+    pub spender: String,
+    pub owner: String,
     pub allowance: Uint128,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub expiration: Option<u64>,
@@ -69,9 +68,9 @@ pub struct Balance {
 
 pub struct Tx {
     pub id: u64,
-    pub from: HumanAddr,
-    pub sender: HumanAddr,
-    pub receiver: HumanAddr,
+    pub from: String,
+    pub sender: String,
+    pub receiver: String,
     pub coins: Coin,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub memo: Option<String>,
@@ -87,17 +86,17 @@ pub struct TransferHistory {
 #[serde(rename_all = "snake_case")]
 pub enum TxAction {
     Transfer {
-        from: HumanAddr,
-        sender: HumanAddr,
-        recipient: HumanAddr,
+        from: String,
+        sender: String,
+        recipient: String,
     },
     Mint {
-        minter: HumanAddr,
-        recipient: HumanAddr,
+        minter: String,
+        recipient: String,
     },
     Burn {
-        burner: HumanAddr,
-        owner: HumanAddr,
+        burner: String,
+        owner: String,
     },
     Deposit {},
     Redeem {},
@@ -119,22 +118,25 @@ pub struct TransactionHistory {
 }
 
 pub struct Minters {
-    pub minters: Vec<HumanAddr>,
+    pub minters: Vec<String>,
 }
 ```
+
 You can create a QueryMsg variant and call the `query` function to query a SNIP20 token contract.
 
 Or you can call the individual function for each query.
 
 Example:
+
 ```ignore
-    let address = HumanAddr("ADDRESS_WHOSE_BALANCE_IS_BEING_REQUESTED".to_string());
+    let address = "ADDRESS_WHOSE_BALANCE_IS_BEING_REQUESTED".to_string();
     let key = "THE_VIEWING_KEY_PREVIOUSLY_SET_BY_THE_ADDRESS".to_string();
     let block_size = 256;
     let callback_code_hash = "TOKEN_CONTRACT_CODE_HASH".to_string();
-    let contract_addr = HumanAddr("TOKEN_CONTRACT_ADDRESS".to_string());
+    let contract_addr = "TOKEN_CONTRACT_ADDRESS".to_string();
 
     let balance =
-        balance_query(&deps.querier, address, key, block_size, callback_code_hash, contract_addr)?;
+        balance_query(deps.querier, address, key, block_size, callback_code_hash, contract_addr)?;
 ```
+
 In this example, we are doing a Balance query for the specified address/key pair and storing the response in the balance variable, which is of the Balance type defined above.  The query message is padded to blocks of 256 bytes.

packages/snip721/Readme.md

@@ -11,14 +11,15 @@ You can create a HandleMsg variant and call the `to_cosmos_msg` function to gene
 Or you can call the individual function for each Handle message to generate the appropriate callback CosmosMsg.
 
 Example:
+
 ```ignore
-    let recipient = HumanAddr("ADDRESS_TO_TRANSFER_TO".to_string());
+    let recipient = "ADDRESS_TO_TRANSFER_TO".to_string();
     let token_id = "TOKEN_ID".to_string();
     let memo = Some("TRANSFER_MEMO".to_string());
     let padding = None;
     let block_size = 256;
     let callback_code_hash = "TOKEN_CONTRACT_CODE_HASH".to_string();
-    let contract_addr = HumanAddr("TOKEN_CONTRACT_ADDRESS".to_string());
+    let contract_addr = "TOKEN_CONTRACT_ADDRESS".to_string();
 
     let cosmos_msg = transfer_nft_msg(
         recipient,
@@ -30,19 +31,17 @@ Example:
         contract_addr,
     )?;
 
-    Ok(HandleResponse {
-        messages: vec![cosmos_msg],
-        log: vec![],
-        data: None,
-    })
+    Ok(Response::new().add_message(cosmos_msg))
 ```
+
 All you have to do to call a SNIP-721 Handle function is call the appropriate toolkit function, and place the resulting `CosmosMsg` in the `messages` Vec of the InitResponse or HandleResponse.  In this example, we are transferring an NFT named "TOKEN_ID" to the recipient address.  We are not using the `padding` field of the Transfer message, but instead, we are padding the entire message to blocks of 256 bytes.
 
 You probably have also noticed that CreateViewingKey is not supported.  This is because a contract can not see the viewing key that is returned because it has already finished executing by the time CreateViewingKey would be called.  If a contract needs to have a viewing key, it must create its own sufficiently complex viewing key, and pass it as a parameter to SetViewingKey. You can see an example of creating a complex viewing key in the [Snip20 Reference Implementation](http://github.com/enigmampc/snip20-reference-impl).  It is also highly recommended that you use the block_size padding option to mask the length of the viewing key your contract has generated.
 
 ## Queries
 
 These are the types that the SNIP-721 toolkit queries can return
+
 ```ignore
 pub struct ContractInfo {
     pub name: String,
@@ -58,12 +57,12 @@ pub struct TokenList {
 }
 
 pub struct Cw721Approval {
-    pub spender: HumanAddr,
+    pub spender: String,
     pub expires: Expiration,
 }
 
 pub struct OwnerOf {
-    pub owner: Option<HumanAddr>,
+    pub owner: Option<String>,
     pub approvals: Vec<Cw721Approval>,
 }
 
@@ -79,14 +78,14 @@ pub struct AllNftInfo {
 }
 
 pub struct Snip721Approval {
-    pub address: HumanAddr,
+    pub address: String,
     pub view_owner_expiration: Option<Expiration>,
     pub view_private_metadata_expiration: Option<Expiration>,
     pub transfer_expiration: Option<Expiration>,
 }
 
 pub struct NftDossier {
-    pub owner: Option<HumanAddr>,
+    pub owner: Option<String>,
     pub public_metadata: Option<Metadata>,
     pub private_metadata: Option<Metadata>,
     pub display_private_metadata_error: Option<String>,
@@ -120,17 +119,17 @@ pub struct InventoryApprovals {
 
 pub enum TxAction {
     Transfer {
-        from: HumanAddr,
-        sender: Option<HumanAddr>,
-        recipient: HumanAddr,
+        from: String,
+        sender: Option<String>,
+        recipient: String,
     },
     Mint {
-        minter: HumanAddr,
-        recipient: HumanAddr,
+        minter: String,
+        recipient: String,
     },
     Burn {
-        owner: HumanAddr,
-        burner: Option<HumanAddr>,
+        owner: String,
+        burner: Option<String>,
     },
 }
 
@@ -149,7 +148,7 @@ pub struct TransactionHistory {
 }
 
 pub struct Minters {
-    pub minters: Vec<HumanAddr>,
+    pub minters: Vec<String>,
 }
 
 pub struct IsUnwrapped {
@@ -161,23 +160,26 @@ pub struct VerifyTransferApproval {
     pub first_unapproved_token: Option<String>,
 }
 ```
+
 You can create a QueryMsg variant and call the `query` function to query a SNIP-721 token contract.
 
 Or you can call the individual function for each query.
 
 Example:
+
 ```ignore
     let token_id = "TOKEN_ID".to_string();
     let viewer = Some(ViewerInfo {
-        address: HumanAddr("VIEWER'S_ADDRESS".to_string()),
+        address: "VIEWER'S_ADDRESS".to_string(),
         viewing_key: "VIEWER'S_KEY".to_string(),
     });
     let include_expired = None;
     let block_size = 256;
     let callback_code_hash = "TOKEN_CONTRACT_CODE_HASH".to_string();
-    let contract_addr = HumanAddr("TOKEN_CONTRACT_ADDRESS".to_string());
+    let contract_addr = "TOKEN_CONTRACT_ADDRESS".to_string();
 
     let nft_dossier =
-        nft_dossier_query(&deps.querier, token_id, viewer, include_expired, block_size, callback_code_hash, contract_addr)?;
+        nft_dossier_query(deps.querier, token_id, viewer, include_expired, block_size, callback_code_hash, contract_addr)?;
 ```
+
 In this example, we are doing an NftDossier query on the token named "TOKEN_ID", supplying the address and viewing key of the querier, and storing the response in the nft_dossier variable, which is of the NftDossier type defined above.  Because no `include_expired` was specified, the response defaults to only displaying approvals that have not expired, but approvals will only be displayed if the viewer is the owner of the token.  The query message is padded to blocks of 256 bytes.

packages/snip721/src/handle.rs

@@ -1058,7 +1058,7 @@ mod tests {
         let test_msg = approve_msg(
             spender.clone(),
             token_id.clone(),
-            expires.clone(),
+            expires,
             padding.clone(),
             256usize,
             code_hash.clone(),
@@ -1123,7 +1123,7 @@ mod tests {
 
         let test_msg = approve_all_msg(
             operator.clone(),
-            expires.clone(),
+            expires,
             padding.clone(),
             256usize,
             code_hash.clone(),
@@ -1189,7 +1189,7 @@ mod tests {
             view_owner.clone(),
             view_private_metadata.clone(),
             transfer.clone(),
-            expires.clone(),
+            expires,
             padding.clone(),
             256usize,
             code_hash.clone(),
@@ -1225,7 +1225,7 @@ mod tests {
 
         let test_msg = register_receive_nft_msg(
             code_hash.clone(),
-            also_implements_batch_receive_nft.clone(),
+            also_implements_batch_receive_nft,
             padding.clone(),
             256usize,
             callback_code_hash.clone(),
@@ -1805,7 +1805,7 @@ mod tests {
             token_id.clone(),
             view_owner.clone(),
             view_private_metadata.clone(),
-            expires.clone(),
+            expires,
             padding.clone(),
             256usize,
             code_hash.clone(),