Struct Contract

pub struct Contract {
    pub state: VersionedState<V1>,
}

Fields

state: VersionedState<V1>

Implementations

impl Contract

pub fn ext(account_id: AccountId) -> ContractExt

API for calling this contract’s functions in a subsequent execution.

pub fn ext_on(promise: Promise) -> ContractExt

pub fn ext_self() -> ContractExt

Convenience method for creating a cross-contract call to the current contract.

Equivalent to Self::ext(near_sdk::env::current_account_id()).

impl Contract

pub fn contract_source_metadata()

impl Contract

pub const GAS_FOR_MIGRATE: Gas

Gas reserved for the batched migrate in Self::upgrade.

Enough for any migration this method can be asked to run. The expensive one — rewriting every stored version blob out of a pre-1.1.0 layout, several MB on the live registries — is not among them: those releases have no upgrade, so they are migrated by a batch their key holder signs, where the gas is on the transaction rather than reserved here.

pub const MAX_CODE_CHUNK_LEN: u32 = 131_072u32

Most a single Self::get_version_code_chunk will return.

A view’s return value reaches the caller as a JSON array of one integer per byte, so the response body runs several times the payload; this keeps it inside what RPC providers serve.

pub fn new() -> Contract

pub fn upgrade( &mut self, code: UpgradeSource, migrate_args: Base64VecU8, ) -> Promise

Atomically deploy new code and run its migrate in one receipt, so a failed migration reverts the deploy with it. migrate_args selects the state::Migration matching the layout this registry actually holds.

The only way to replace the code of a registry whose full-access keys have been removed.

pub fn list_versions( &self, count: Option<u32>, offset: Option<u32>, ) -> Vec<&String>

pub fn get_version_code_hash( &self, version_key: String, ) -> Option<Base58CryptoHash>

pub fn get_version(&self, version_key: String) -> Option<VersionInfo>

A registered version’s hash and whether Self::deploy can still use it.

list_versions keeps listing a version whose code remove_version cleared, and get_version_code_hash keeps answering for it, so membership alone cannot tell a deployable version from one that will panic partway through a deploy.

pub fn get_registry_entry( &self, account_id: AccountId, ) -> Option<RegistryEntryView>

Whether a name is taken, and by what.

Self::deploy refuses any name already present, so a Reserved name is as unusable as a deployed one — a state Self::get_deployment reports as absent.

pub fn get_version_code_chunk( &self, version_key: String, offset: u32, len: u32, ) -> Option<Vec<u8>>

Bytes [offset, offset + len) of a version’s stored code, or None if it has none.

Borsh-serialized and chunked: the JSON encoding would base64 the blob and the RPC would then re-expand it to one integer per byte. Reading a whole contract back is the last resort anyway — Self::get_version reports the hash, which usually resolves against a released artifact without touching this at all.

An offset past the end reads empty, so a caller can loop until it stops making progress.

pub fn list_deployments( &self, count: Option<u32>, offset: Option<u32>, ) -> Vec<&AccountId>

pub fn get_deployment(&self, account_id: AccountId) -> Option<&Deployment>

pub fn add_version( &mut self, version_key: String, source: VersionSource, ) -> PromiseOrValue<()>

pub fn add_version_01_finalize( &mut self, version_key: String, ) -> PromiseOrValue<()>

pub fn remove_version(&mut self, version_key: String)

pub fn deploy( &mut self, name: String, version_key: String, init_args: Base64VecU8, full_access_keys: Option<Vec<PublicKey>>, ) -> Promise

pub fn deploy_01_finalize( &mut self, market_id: AccountId, deployment: Deployment, ) -> PromiseOrValue<AccountId>

pub fn fail(&self, message: String)

Trait Implementations

impl BorshDeserialize for Contract

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for Contract

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for Contract

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl ContractState for Contract

fn state_key() -> &'static [u8]

fn state_exists() -> bool

fn state_read() -> Option<Self>

where Self: BorshDeserialize,

fn state_write(&self) -> bool

where Self: BorshSerialize,

impl Default for Contract

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Contract

type Target = V1

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Contract

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl MigrateExternalInterface for Contract

fn get_stored_state_version() -> u32

fn get_target_state_version() -> u32

fn needs_migration() -> bool

impl OwnerExternal for Contract

fn own_get_owner(&self) -> Option<AccountId>

Returns the account ID of the current owner.

fn own_get_proposed_owner(&self) -> Option<AccountId>

Returns the account ID that the current owner has proposed take over ownership.

fn own_renounce_owner(&mut self)

Current owner may call this function to renounce ownership, setting current owner to None.

fn own_propose_owner(&mut self, account_id: Option<AccountId>)

Propose a new owner. Can only be called by the current owner.

fn own_accept_owner(&mut self)

The proposed owner may call this function to accept ownership from the previous owner.

impl OwnerInternal for Contract

fn root() -> Slot<()>

Storage root

fn slot_is_initialized() -> Slot<bool>

Storage slot for initialization state

fn slot_owner() -> Slot<AccountId>

Storage slot for owner account ID

fn slot_proposed_owner() -> Slot<AccountId>

Storage slot for proposed owner account ID