Struct Contract

Source
pub struct Contract(pub AccountId);
Expand description

Contract-related interactions with the NEAR Protocol

The Contract struct provides methods to interact with NEAR contracts, including calling functions, querying storage, and deploying contracts.

§Examples

use near_api::*;

let abi = Contract("some_contract.testnet".parse()?).abi().fetch_from_testnet().await?;
println!("ABI: {:?}", abi);

Tuple Fields§

§0: AccountId

Implementations§

Source§

impl Contract

Source

pub fn call_function<Args>( &self, method_name: &str, args: Args, ) -> Result<CallFunctionBuilder, BuilderError>
where Args: Serialize,

Prepares a call to a contract function.

This will return a builder that can be used to prepare a query or a transaction.

§Calling view function get_number
use near_api::*;

let number: Data<u64> = Contract("some_contract.testnet".parse()?)
    .call_function("get_number", ())?
    .read_only()
    .fetch_from_testnet()
    .await?;
println!("Number: {:?}", number);
§Calling a state changing function set_number
use near_api::*;
use serde_json::json;

let signer = Signer::new(Signer::from_ledger())?;
let result: near_primitives::views::FinalExecutionOutcomeView = Contract("some_contract.testnet".parse()?)
    .call_function("set_number", json!({ "number": 100 }))?
    .transaction()
     // Optional
    .gas(NearGas::from_tgas(200))
    .with_signer("alice.testnet".parse()?, signer)
    .send_to_testnet()
    .await?;
Source

pub const fn deploy(contract: AccountId) -> DeployBuilder

Prepares a transaction to deploy a contract to the provided account.

The code is the wasm bytecode of the contract. For more information on how to compile your contract, please refer to the NEAR documentation.

§Deploying the contract
use near_api::*;

let code = std::fs::read("path/to/your/contract.wasm")?;
let signer = Signer::new(Signer::from_ledger())?;
let result: near_primitives::views::FinalExecutionOutcomeView = Contract::deploy("contract.testnet".parse()?)
    .use_code(code)
    .without_init_call()
    .with_signer(signer)
    .send_to_testnet()
    .await?;
§Deploying the contract with an init call
use near_api::*;
use serde_json::json;

let code = std::fs::read("path/to/your/contract.wasm")?;
let signer = Signer::new(Signer::from_ledger())?;
let result: near_primitives::views::FinalExecutionOutcomeView = Contract::deploy("contract.testnet".parse()?)
    .use_code(code)
    .with_init_call("init", json!({ "number": 100 }))?
    // Optional
    .gas(NearGas::from_tgas(200))
    .with_signer(signer)
    .send_to_testnet()
    .await?;
Source

pub const fn deploy_global_contract_code(code: Vec<u8>) -> GlobalDeployBuilder

Prepares a transaction to deploy a code to the global contract code storage.

This will allow other users to reference given code as hash or account-id and reduce the gas cost for deployment.

Please be aware that the deploy costs 10x more compared to the regular costs and the tokens are burnt with no way to get it back.

§Example deploying a contract to the global contract code storage as hash
use near_api::*;

let code = std::fs::read("path/to/your/contract.wasm")?;
let signer = Signer::new(Signer::from_ledger())?;
let result: near_primitives::views::FinalExecutionOutcomeView = Contract::deploy_global_contract_code(code)
    .as_hash()
    .with_signer("some-account.testnet".parse()?, signer)
    .send_to_testnet()
    .await?;
§Example deploying a contract to the global contract code storage as account-id

The difference between the hash and account-id version is that the account-id version upgradable and can be changed.

use near_api::*;

let code = std::fs::read("path/to/your/contract.wasm")?;
let signer = Signer::new(Signer::from_ledger())?;
let result: near_primitives::views::FinalExecutionOutcomeView = Contract::deploy_global_contract_code(code)
    .as_account_id("nft-contract.testnet".parse()?)
    .with_signer(signer)
    .send_to_testnet()
    .await?;
Source

pub fn abi( &self, ) -> QueryBuilder<PostprocessHandler<Option<AbiRoot>, CallResultHandler<Vec<u8>>>>

Prepares a query to fetch the ABI of the contract using the following standard.

Please be aware that not all the contracts provide the ABI.

§Example
use near_api::*;

let abi = Contract("some_contract.testnet".parse()?).abi().fetch_from_testnet().await?;
println!("ABI: {:?}", abi);
Source

pub fn wasm(&self) -> QueryBuilder<ViewCodeHandler>

Prepares a query to fetch the wasm code (Data<ContractCodeView>) of the contract.

§Example
use near_api::*;

let wasm = Contract("some_contract.testnet".parse()?).wasm().fetch_from_testnet().await?;
println!("WASM: {:?}", wasm.data.code.len());
Source

pub fn view_storage_with_prefix( &self, prefix: Vec<u8>, ) -> QueryBuilder<ViewStateHandler>

Prepares a query to fetch the storage of the contract (Data<ViewStateResult>) using the given prefix as a filter.

It helpful if you are aware of the storage that you are looking for.

§Example
use near_api::*;

let storage = Contract("some_contract.testnet".parse()?)
    .view_storage_with_prefix(b"se".to_vec())
    .fetch_from_testnet()
    .await?;
println!("Storage: {:?}", storage);
Source

pub fn view_storage(&self) -> QueryBuilder<ViewStateHandler>

Prepares a query to fetch the storage of the contract (Data<ViewStateResult>).

Please be aware that large storage queries might fail.

§Example
use near_api::*;

let storage = Contract("some_contract.testnet".parse()?)
    .view_storage()
    .fetch_from_testnet()
    .await?;
println!("Storage: {:?}", storage);
Source

pub fn contract_source_metadata( &self, ) -> QueryBuilder<CallResultHandler<ContractSourceMetadata>>

Prepares a query to fetch the contract source metadata(Data<ContractSourceMetadata>) using NEP-330 standard.

The contract source metadata is a standard interface that allows auditing and viewing source code for a deployed smart contract. Implementation of this standard is purely optional but is recommended for developers whose contracts are open source.

§Examples
use near_api::*;

let source_metadata = Contract("some_contract.testnet".parse()?)
    .contract_source_metadata()
    .fetch_from_testnet()
    .await?;
println!("Source metadata: {:?}", source_metadata);

A more verbose runnable example is present in examples/contract_source_metadata.rs:

use near_api::*;
use std::str::FromStr;

#[tokio::main]
async fn main() {
    for (account_name, expected_json_metadata) in [
        ("desolate-toad.testnet", FIRST_METADATA),
        ("fat-fabulous-toad.testnet", SECOND_METADATA),
    ] {
        let source_metadata = Contract(AccountId::from_str(account_name).expect("no err"))
            .contract_source_metadata()
            .fetch_from_testnet()
            .await
            .expect("no network or rpc err");

        assert_eq!(
            expected_json_metadata,
            serde_json::to_string_pretty(&source_metadata.data).expect("no ser err")
        );
    }
}

const FIRST_METADATA: &str = r#"{
  "version": "0.1.0",
  "link": "https://github.com/dj8yfo/quiet_glen",
  "standards": [
    {
      "standard": "nep330",
      "version": "1.2.0"
    }
  ],
  "build_info": null
}"#;

const SECOND_METADATA: &str = r#"{
  "version": "0.1.0",
  "link": "https://github.com/dj8yfo/quiet_glen/tree/8d8a8a0fe86a1d8eb3bce45f04ab1a65fecf5a1b",
  "standards": [
    {
      "standard": "nep330",
      "version": "1.2.0"
    }
  ],
  "build_info": {
    "build_environment": "sourcescan/cargo-near:0.13.3-rust-1.84.0@sha256:722198ddb92d1b82cbfcd3a4a9f7fba6fd8715f4d0b5fb236d8725c4883f97de",
    "build_command": [
      "cargo",
      "near",
      "build",
      "non-reproducible-wasm",
      "--locked"
    ],
    "contract_path": "",
    "source_code_snapshot": "git+https://github.com/dj8yfo/quiet_glen?rev=8d8a8a0fe86a1d8eb3bce45f04ab1a65fecf5a1b",
    "output_wasm_path": null
  }
}"#;

Trait Implementations§

Source§

impl Clone for Contract

Source§

fn clone(&self) -> Contract

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Contract

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,