Struct StorageDeposit

pub struct StorageDeposit(AccountId);

A wrapper struct that simplifies interactions with the Storage Management standard

Contracts on NEAR Protocol often implement a NEP-145 for managing storage deposits, which are required for storing data on the blockchain. This struct provides convenient methods to interact with these storage-related functions on the contract.

Example

use near_api::*;

let storage = StorageDeposit::on_contract("contract.testnet".parse()?);

// Check storage balance
let balance = storage.view_account_storage("alice.testnet".parse()?)?.fetch_from_testnet().await?;
println!("Storage balance: {:?}", balance);

// Bob pays for Alice's storage on the contract contract.testnet
let deposit_tx = storage.deposit("alice.testnet".parse()?, NearToken::from_near(1))?
    .with_signer("bob.testnet".parse()?, Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await
    .unwrap();

Tuple Fields

0: AccountId

Implementations

impl StorageDeposit

pub const fn on_contract(contract_id: AccountId) -> Self

pub fn view_account_storage( &self, account_id: AccountId, ) -> Result<QueryBuilder<PostprocessHandler<Data<Option<StorageBalance>>, CallResultHandler<Option<StorageBalanceInternal>>>>, BuilderError>

Prepares a new contract query (storage_balance_of) for fetching the storage balance (Option<StorageBalance>) of the account on the contract.

Example

use near_api::*;

let balance = StorageDeposit::on_contract("contract.testnet".parse()?)
    .view_account_storage("alice.testnet".parse()?)?
    .fetch_from_testnet()
    .await?;
println!("Storage balance: {:?}", balance);

pub fn deposit( &self, receiver_account_id: AccountId, amount: NearToken, ) -> Result<ContractTransactBuilder, BuilderError>

Prepares a new transaction contract call (storage_deposit) for depositing storage on the contract.

Example

use near_api::*;

let tx: near_primitives::views::FinalExecutionOutcomeView = StorageDeposit::on_contract("contract.testnet".parse()?)
    .deposit("alice.testnet".parse()?, NearToken::from_near(1))?
    .with_signer("bob.testnet".parse()?, Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

pub fn withdraw( &self, account_id: AccountId, amount: NearToken, ) -> Result<ConstructTransaction, BuilderError>

Prepares a new transaction contract call (storage_withdraw) for withdrawing storage from the contract.

Example

use near_api::*;

let tx: near_primitives::views::FinalExecutionOutcomeView = StorageDeposit::on_contract("contract.testnet".parse()?)
    .withdraw("alice.testnet".parse()?, NearToken::from_near(1))?
    .with_signer(Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

Trait Implementations

impl Clone for StorageDeposit

fn clone(&self) -> StorageDeposit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageDeposit

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

Formats the value using the given formatter.