Crate noble_contracts[−][src]
Contract Module
The Contract module provides functionality for the runtime to deploy and execute WebAssembly smart-contracts.
Overview
This module extends accounts based on the Currency
trait to have smart-contract functionality. It can
be used with other modules that implement accounts based on Currency
. These “smart-contract accounts”
have the ability to instantiate smart-contracts and make calls to other contract and non-contract accounts.
The smart-contract code is stored once in a code_cache
, and later retrievable via its code_hash
.
This means that multiple smart-contracts can be instantiated from the same code_cache
, without replicating
the code each time.
When a smart-contract is called, its associated code is retrieved via the code hash and gets executed. This call can alter the storage entries of the smart-contract account, instantiate new smart-contracts, or call other smart-contracts.
Finally, when an account is reaped, its associated code and storage of the smart-contract account will also be deleted.
Gas
Senders must specify a gas limit with every call, as all instructions invoked by the smart-contract require gas. Unused gas is refunded after the call, regardless of the execution outcome.
If the gas limit is reached, then all calls and state changes (including balance transfers) are only reverted at the current call’s contract level. For example, if contract A calls B and B runs out of gas mid-call, then all of B’s calls are reverted. Assuming correct error handling by contract A, A’s other calls and state changes still persist.
Notable Scenarios
Contract call failures are not always cascading. When failures occur in a sub-call, they do not “bubble up”, and the call will only revert at the specific contract level. For example, if contract A calls contract B, and B fails, A can decide how to handle that failure, either proceeding or reverting A’s changes.
Interface
Dispatchable functions
put_code
- Stores the given binary Wasm code into the chain’s storage and returns itscode_hash
.instantiate
- Deploys a new contract from the givencode_hash
, optionally transferring some balance. This instantiates a new smart contract account and calls its contract deploy handler to initialize the contract.call
- Makes a call to an account, optionally transferring some balance.
Usage
The Contract module is a work in progress. The following examples show how this Contract module can be used to instantiate and call contracts.
pro
is aneDSL
that enables writing WebAssembly based smart contracts in the Rust programming language. This is a work in progress.
Related Modules
Re-exports
pub use crate::weights::WeightInfo; |
pub use $crate::traits::GetNobleVersion as _; |
Modules
chain_extension | A mechanism for runtime authors to augment the functionality of contracts. |
weights | Autogenerated weights for noble_contracts |
Macros
convert_args | |
define_func | |
gen_signature | |
gen_signature_dispatch | |
match_tokens | A simple utility macro that helps to match against a list of tokens. |
register_func | |
unmarshall_then_body_then_marshall |
Structs
AccountCounter | The subtrie counter. |
CodeStorage | A mapping between an original code hash and instrumented wasm code, ready for execution. |
ConfigCache | In-memory cache of configuration values. |
ContractInfoOf | The code associated with a given account. |
DeletionQueue | Evicted contracts that await child trie deletion. |
GasMeter | |
GenesisConfig | Genesis config for the module, allow to build genesis storage. |
HostFnWeights | Describes the weight for each imported function that a contract is allowed to call. |
InstructionWeights | Describes the weight for all categories of supported wasm instructions. |
Limits | Describes the upper limits on various metrics. |
Module | Contracts module. |
PristineCode | A mapping from an original code hash to the original code, untouched by instrumentation. |
RawAliveContractInfo | Information for managing an account and its sub trie abstraction. This is the required info to cache for an account. |
RawTombstoneContractInfo | |
Schedule | Definition of the cost schedule and other parameterizations for wasm vm. |
Enums
Call | Dispatchable calls. |
ContractInfo | Information for managing an account and its sub trie abstraction. This is the required info to cache for an account |
Error | Error for the contracts module. |
RawEvent | Events for this module. |
RuntimeReturnCode | Every error that can be returned to a contract when it calls any of the host functions. |
Traits
Config |
Type Definitions
AliveContractInfo | |
BalanceOf | |
CodeHash | |
Event | |
Gas | |
NegativeImbalanceOf | |
TombstoneContractInfo | |
TrieId |