reference-docs: Start state and mention well known keys (paritytech…

…#7037) Closes: paritytech#7033
acatangiu · Jan 13, 2025 · 7d8e3a4 · 7d8e3a4
1 parent 738282a
commit 7d8e3a4
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/sdk/Cargo.toml b/docs/sdk/Cargo.toml
@@ -110,6 +110,7 @@ sp-offchain = { workspace = true, default-features = true }
 sp-runtime = { workspace = true, default-features = true }
 sp-runtime-interface = { workspace = true, default-features = true }
 sp-std = { workspace = true, default-features = true }
+sp-storage = { workspace = true, default-features = true }
 sp-tracing = { workspace = true, default-features = true }
 sp-version = { workspace = true, default-features = true }
 sp-weights = { workspace = true, default-features = true }

diff --git a/docs/sdk/src/reference_docs/mod.rs b/docs/sdk/src/reference_docs/mod.rs
@@ -111,3 +111,6 @@ pub mod custom_runtime_api_rpc;
 
 /// The [`polkadot-omni-node`](https://crates.io/crates/polkadot-omni-node) and its related binaries.
 pub mod omni_node;
+
+/// Learn about the state in Substrate.
+pub mod state;
diff --git a/docs/sdk/src/reference_docs/state.rs b/docs/sdk/src/reference_docs/state.rs
@@ -0,0 +1,12 @@
+//! # State
+//!
+//! The state is abstracted as a key-value like database. Every item that
+//! needs to be persisted by the [State Transition
+//! Function](crate::reference_docs::blockchain_state_machines) is written to the state.
+//!
+//! ## Special keys
+//!
+//! The key-value pairs in the state are represented as byte sequences. The node
+//! doesn't know how to interpret most the key-value pairs. However, there exist some
+//! special keys and its values that are known to the node, the so-called
+//! [`well-known-keys`](sp_storage::well_known_keys).
diff --git a/substrate/primitives/storage/src/lib.rs b/substrate/primitives/storage/src/lib.rs
@@ -191,11 +191,15 @@ pub mod well_known_keys {
 	/// Wasm code of the runtime.
 	///
 	/// Stored as a raw byte vector. Required by substrate.
+	///
+	/// Encodes to `0x3A636F6465`.
 	pub const CODE: &[u8] = b":code";
 
 	/// Number of wasm linear memory pages required for execution of the runtime.
 	///
 	/// The type of this value is encoded `u64`.
+	///
+	/// Encodes to `0x307833413633364636343635`
 	pub const HEAP_PAGES: &[u8] = b":heappages";
 
 	/// Current extrinsic index (u32) is stored under this key.