Re-exports§
pub use near_sys as sys;
pub use base64;
pub use borsh;
pub use bs58;
pub use serde;
pub use serde_json;
pub use crate::utils::*;
Modules§
- Collections that offer an alternative to standard containers from
std::collections::*
by utilizing the underlying blockchain trie storage more efficiently. - Blockchain-specific methods available to the smart contract. This is a wrapper around a low-level
BlockchainInterface
. Unless you know what you are doing prefer usingenv::*
whenever possible. In case of cross-contract calls prefer using even higher-level API available throughcallback_args
,callback_args_vec
,ext_contract
,Promise
, andPromiseOrValue
. - Helper types for JSON serialization.
- Mock blockchain utilities. These can only be used inside tests and are not available for a wasm32 target.
#[near]
and#[near_bindgen]
documentation module- Collections and types used when interacting with storage.
- Testing blockchain utilities. These can only be used inside tests and are not available for a wasm32 target.
- Helper methods that often used in smart contracts.
Macros§
- Helper macro to log a message through
env::log_str
. This macro can be used similar to thestd::format
macro. - Helper macro to create assertions that will panic through the runtime host functions.
- setup_
alloc Deprecated Deprecated helper function which used to generate code to initialize theGlobalAllocator
. This is now initialized by default. Disablewee_alloc
feature to configure manually. - Initializes a testing environment to mock interactions which would otherwise go through a validator node. This macro will initialize or overwrite the
MockedBlockchain
instance for interactions from a smart contract.
Structs§
- A simple type used in conjunction with FunctionError representing that the function should abort without a custom message.
- NEAR Account Identifier.
- Account identifier. This is the human readable UTF-8 string which is used internally to index accounts on the network and their respective state.
- Weight of unused gas to use with
promise_batch_action_function_call_weight
. - Mocked blockchain that can be used in the tests for the smart contracts. It implements
BlockchainInterface
by redirecting calls toVMLogic
. It unwraps errors ofVMLogic
to cause panic during the unit tests similarly to how errors ofVMLogic
would cause the termination of guest program execution. Unit tests can even assert the expected error message. - A structure representing a result of the scheduled execution on another contract.
- Promise index that is computed only once.
- Public key in a binary format with base58 string serialization with human-readable curve. The key types currently supported are
secp256k1
anded25519
. - Context for the contract execution.
Enums§
- Allow an access key to spend either an unlimited or limited amount of gas
- PublicKey curve
- All error variants which can occur with promise results.
- When the method can return either a promise or a value, it can be called with
PromiseOrValue::Promise
orPromiseOrValue::Value
to specify which one should be returned. - When there is a callback attached to one or more contract calls the execution results of these calls are available to the contract invoked through the callback.
- When there is a callback attached to one or more contract calls the execution results of these calls are available to the contract invoked through the callback.
Traits§
- Enables contract runtime to panic with the given type. Any error type used in conjunction with
#[handle_result]
has to implement this trait. - Converts Self into a
Vec<u8>
that is used for a storage key throughinto_storage_key
.
Functions§
Type Aliases§
- Height of the block.
- Block
Height Delta Deprecated Block height delta that measures the difference betweenBlockHeight
s. - Raw type for 32 bytes of the hash.
- Raw type for duration in nanoseconds
- Height of the epoch.
- GCCount
Deprecated - Iterator
Index Deprecated - Merkle
Hash Deprecated Hash used by a struct implementing the Merkle tree. - Nonce
Deprecated Nonce for transactions. - NumBlocks
Deprecated Number of blocks in current group. - NumSeats
Deprecated Number of seats of validators (block producer or hidden ones) in current group (settlement). - NumShards
Deprecated Number of shards in current group. - Promise
Id Deprecated - Protocol
Version Deprecated - Receipt
Index Deprecated An index of Receipt to append an action - ShardId
Deprecated Shard index, from 0 to NUM_SHARDS - 1. - StorageUsage is used to count the amount of storage used by a contract.
- Storage
Usage Change Deprecated StorageUsageChange is used to count the storage usage within a single contract call. - Raw type for timestamp in nanoseconds
- Validator
Id Deprecated Validator identifier in current group. - Validator
Mask Deprecated Mask which validators participated in multi sign.
Attribute Macros§
ext_contract
takes a Rust Trait and converts it to a module with static methods. Each of these static methods takes positional arguments defined by the Trait, then the receiver_id, the attached deposit and the amount of gas and returns a new Promise.- This attribute macro is used to enhance the near_bindgen macro. It is used to add Borsh and Serde derives for serialization and deserialization. It also adds
BorshSchema
andJsonSchema
if needed - This attribute macro is used on a struct and its implementations to generate the necessary code to expose
pub
methods from the contract as well as generating the glue code to be a valid NEAR contract.
Derive Macros§
BorshStorageKey
generates implementation forBorshIntoStorageKey
trait. It allows the type to be passed as a unique prefix for persistent collections. The type should also implement or deriveBorshSerialize
trait.- NOTE: This is an internal implementation for
#[near_bindgen(events(standard = ...))]
attribute. FunctionError
generates implementation fornear_sdk::FunctionError
trait. It allows contract runtime to panic with the type using itsToString
implementation as the message.PanicOnDefault
generates implementation forDefault
trait that panics with the following messageThe contract is not initialized
whendefault()
is called. This is a helpful macro in case the contract is required to be initialized with eitherinit
orinit(ignore_state)
.