Write metadata for your contract.
The contractmeta!
macro provided in the Rust SDK allows users to write two strings - a key
and a val
- within a serialized SCMetaEntry::SCMetaV0
XDR object to the custom section of Wasm contracts. The section name for this metadata is contractmetav0
. Developers can utilize this macro to write metadata, and tools can then read and display this information to users.
The liquidity pool example provides a clear demonstration of how to use the contractmeta!
macro:
// Metadata that is added on to the Wasm custom section
contractmeta!(
key = "Description",
val = "Constant product AMM with a .3% swap fee"
);
pub trait LiquidityPoolTrait {...
Guides in this category:
📄️ Organize contract errors with an error enum type
A convenient way to manage and meaningfully communicate contract errors is to collect them into an enum struct. These errors are a special type of enum integer type that are stored on ledger as Status values containing a u32 code. First, create the Error struct in your smart contract.
📄️ Upgrade the Wasm bytecode of a deployed contract
Upgrade the Wasm bytecode of a deployed contract
📄️ Write metadata for your contract.
Write structured metadata.