cw-storey 0.6.0 (#272)

Author: uint

docs-test-gen/Cargo.lock

@@ -37,8 +37,14 @@ fn doctest() {
     }
     {
         use cw_storey::{containers::Item, CwStorage};
-        const CHANNEL: Item<ChannelInfo> = Item::new(0);
-        CHANNEL.access(&mut deps.storage).set(&channel_info).unwrap();
+        use storey::containers::router;
+        router! {
+            router Root {
+                0 -> channel: Item<ChannelInfo>,
+            }
+        }
+
+        Root::access(&mut deps.storage).channel_mut().set(&channel_info).unwrap();
     }
 
 

docs-test-gen/templates/ibc-packet.tpl

@@ -8,6 +8,7 @@ use sylvia::cw_schema::cw_serde;
 use cw_utils::MsgInstantiateContractResponse;
 use cw_storey::CwStorage;
 use cw_storey::containers::Item;
+use storey::containers::router;
 use std::marker::PhantomData;
 
 pub mod external_contract {
@@ -47,16 +48,18 @@ fn doctest() {
     pub mod main_contract {
         use super::*;
 
-        pub struct Contract {
-            remote: Item<Remote<'static, external_contract::ExternalContract>>
+        router! {
+            router Root {
+                0 -> remote: Item<Remote<'static, external_contract::ExternalContract>>,
+            }
         }
 
+        pub struct Contract;
+
         #[contract]
         impl Contract {
             pub fn new() -> Self {
-                Self {
-                    remote: Item::new(0)
-                }
+                Self
             }
 
             #[sv::msg(instantiate)]

docs-test-gen/templates/sylvia/storey_contract.tpl

@@ -118,6 +118,7 @@ const IBC_APP_VERSION: &str = "my-protocol-v1";
 
 ```rust filename="ibc.rs" template="core"
 use cw_storey::containers::Item;
+use storey::containers::router;
 
 /// enforces ordering and versioning constraints
 #[cfg_attr(not(feature = "library"), entry_point)]
@@ -131,7 +132,7 @@ pub fn ibc_channel_open(
     // in this example, we only allow a single channel per contract instance
     // you can do more complex checks here
     ensure!(
-        CHANNEL.access(&*deps.storage).get()?.is_none(),
+        Root::access(&*deps.storage).channel().get()?.is_none(),
         StdError::generic_err("channel already exists")
     );
 
@@ -152,7 +153,7 @@ pub fn ibc_channel_open(
 
     // now, we save the channel ID to storage, so we can use it later
     // this also prevents any further channel openings
-    CHANNEL.access(deps.storage).set(&ChannelInfo {
+    Root::access(deps.storage).channel_mut().set(&ChannelInfo {
         channel_id: channel.endpoint.channel_id.clone(),
         finalized: false,
     })?;
@@ -170,7 +171,12 @@ struct ChannelInfo {
     finalized: bool,
 }
 
-const CHANNEL: Item<ChannelInfo> = Item::new(0);
+router! {
+    router Root {
+        0 -> channel: Item<ChannelInfo>,
+    }
+}
+
 const IBC_APP_VERSION: &str = "my-protocol-v1";
 ```
 
@@ -361,6 +367,7 @@ const CHANNEL: Item<ChannelInfo> = Item::new("channel");
 
 ```rust filename="ibc.rs" template="core"
 use cw_storey::containers::Item;
+use storey::containers::router;
 
 #[cfg_attr(not(feature = "library"), entry_point)]
 pub fn ibc_channel_connect(
@@ -372,8 +379,8 @@ pub fn ibc_channel_connect(
 
     // in this example, we only allow a single channel per contract instance
     // you can do more complex checks here
-    let mut channel_info = CHANNEL
-        .access(&*deps.storage)
+    let mut channel_info = Root::access(&*deps.storage)
+        .channel()
         .get()?
         .ok_or_else(|| StdError::generic_err("channel not found"))?;
     ensure!(
@@ -387,7 +394,9 @@ pub fn ibc_channel_connect(
 
     // at this point, we are finished setting up the channel and can mark it as finalized
     channel_info.finalized = true;
-    CHANNEL.access(deps.storage).set(&channel_info)?;
+    Root::access(deps.storage)
+        .channel_mut()
+        .set(&channel_info)?;
 
     Ok(IbcBasicResponse::new())
 }
@@ -399,7 +408,11 @@ struct ChannelInfo {
     finalized: bool,
 }
 
-const CHANNEL: Item<ChannelInfo> = Item::new(0);
+router! {
+    router Root {
+        0 -> channel: Item<ChannelInfo>,
+    }
+}
 ```
 
   </Tabs.Tab>

src/pages/ibc/diy-protocol/channel-lifecycle.mdx

@@ -57,11 +57,16 @@ Ok(Response::new().add_message(msg))
 
 ```rust template="ibc-packet"
 use cw_storey::containers::Item;
+use storey::containers::router;
 
-const CHANNEL: Item<ChannelInfo> = Item::new(0);
+router! {
+    router Root {
+        0 -> channel: Item<ChannelInfo>,
+    }
+}
 
-let channel_id = CHANNEL
-    .access(deps.storage)
+let channel_id = Root::access(deps.storage)
+    .channel()
     .get()?
     .ok_or_else(|| StdError::generic_err("channel handshake hasn't started yet"))?
     .channel_id;
@@ -222,6 +227,13 @@ const ACK_LATER: Map<&(u64, String), String> = Map::new("ack_later");
 
 ```rust filename="ibc.rs" template="core"
 use cw_storey::containers::{Item, Map};
+use storey::containers::router;
+
+router! {
+    router Root {
+        0 -> ack_later: Map<u64, Map<String, Item<String>>>,
+    }
+}
 
 #[cfg_attr(not(feature = "library"), entry_point)]
 pub fn ibc_packet_receive(
@@ -232,7 +244,8 @@ pub fn ibc_packet_receive(
     // save the data we need for the async acknowledgement in contract state
     // note: we are just saving a String here, but you can save any information
     // you need for the acknowledgement later
-    ACK_LATER.access(deps.storage)
+    Root::access(deps.storage)
+        .ack_later_mut()
         .entry_mut(&msg.packet.sequence)
         .entry_mut(&msg.packet.dest.channel_id)
         .set(&"ack str".to_string())?;
@@ -250,7 +263,8 @@ pub fn async_ack(
     channel_id: String,
 ) -> StdResult<Response> {
     // load data from contract state
-    let ack_str = ACK_LATER.access(deps.storage)
+    let ack_str = Root::access(deps.storage)
+        .ack_later()
         .entry(&packet_sequence)
         .entry(&channel_id)
         .try_get()
@@ -263,9 +277,6 @@ pub fn async_ack(
         ack: IbcAcknowledgement::new(StdAck::success(ack_str.as_bytes())),
     }))
 }
-
-const ACK_LATER_IX: u8 = 0;
-const ACK_LATER: Map<u64, Map<String, Item<String>>> = Map::new(ACK_LATER_IX);
 ```
 
   </Tabs.Tab>

src/pages/ibc/diy-protocol/packet-lifecycle.mdx

@@ -21,14 +21,19 @@ For more advanced use cases, you can build your own containers as described in t
 
 ## Namespace
 
-To construct a container, you need to provide a single byte. This byte is used to distinguish
-between different "root" containers in the same storage space.
+To construct a container, you need to provide an ID in the 0-254 range. This byte is used to
+distinguish between different "root" containers in the same storage space.
 
 ```rust template="storage"
 use cw_storey::containers::{Item, Map};
-
-let item: Item<u32> = Item::new(0); // byte 0 is used as the namespace
-let map: Map<String, Item<u32>> = Map::new(1); // byte 1 is used as the namespace
+use storey::containers::router;
+
+router! {
+    router Root {
+        0 -> foo: Item<u32>,
+        1 -> bar: Map<String, Item<u32>>,
+    }
+}
 ```
 
 A container will assume it's free to save stuff under the given key (e.g. `A`), and any key that
@@ -53,15 +58,22 @@ reference to a storage backend.
 
 ```rust template="storage"
 use cw_storey::containers::Item;
+use storey::containers::router;
 
-let item: Item<u32> = Item::new(0);
+router! {
+    router Root {
+        0 -> item: Item<u32>,
+    }
+}
 
-item.access(&mut storage)
+Root::access(&mut storage)
+    .item_mut()
     .set(&42)
     .unwrap();
 
 assert_eq!(
-    item.access(&storage)
+    Root::access(&storage)
+        .item()
         .get()
         .unwrap(),
     Some(42)
@@ -99,17 +111,24 @@ assert_eq!(
 
 ```rust template="storage"
 use cw_storey::containers::{Map, Item};
+use storey::containers::router;
 
-let map: Map<String, Map<String, Item<u32>>> = Map::new(0);
+router! {
+    router Root {
+        0 -> map: Map<String, Map<String, Item<u32>>>,
+    }
+}
 
-map.access(&mut storage)
+Root::access(&mut storage)
+    .map_mut()
     .entry_mut("foo")
     .entry_mut("bar")
     .set(&42)
     .unwrap();
 
 assert_eq!(
-    map.access(&storage)
+    Root::access(&storage)
+        .map()
         .entry("foo")
         .entry("bar")
         .get()

src/pages/storey/containers.mdx

@@ -1,4 +1,5 @@
 export default {
+  routers: "Routers",
   item: "Item",
   map: "Map",
   column: "Column",