Struct Account

pub struct Account(pub AccountId);

Account management related interactions with the NEAR Protocol

The Account struct provides methods to interact with NEAR accounts, including querying account information, managing access keys, and creating new accounts.

Examples

use near_api::*;

let account_info = Account("alice.testnet".parse()?).view().fetch_from_testnet().await?;
println!("Account: {:?}", account_info);

Tuple Fields

0: AccountId

Implementations

impl Account

pub fn view(&self) -> QueryBuilder<AccountViewHandler>

Prepares a query to fetch the Data<AccountView> with the account information for the given account ID.

Example

use near_api::*;

let account_info = Account("alice.testnet".parse()?).view().fetch_from_testnet().await?;
println!("Account: {:?}", account_info);

pub fn access_key( &self, signer_public_key: PublicKey, ) -> QueryBuilder<AccessKeyHandler>

Prepares a query to fetch the Data<AccessKeyView> with the access key information for the given account public key.

Example

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

let access_key = Account("alice.testnet".parse()?)
    .access_key(PublicKey::from_str("ed25519:H4sIAAAAAAAAA+2X0Q6CMBAAtVlJQgYAAAA=")?)
    .fetch_from_testnet()
    .await?;
println!("Access key: {:?}", access_key);

pub fn list_keys(&self) -> QueryBuilder<AccessKeyListHandler>

Prepares a query to fetch the AccessKeyList list of access keys for the given account ID.

Example

use near_api::*;

let access_keys = Account("alice.testnet".parse()?).list_keys().fetch_from_testnet().await?;
println!("Access keys: {:?}", access_keys);

pub fn add_key( &self, permission: AccessKeyPermission, public_key: PublicKey, ) -> ConstructTransaction

Adds a new access key to the given account ID.

Example

use near_api::*;
use near_primitives::account::AccessKeyPermission;
use near_crypto::PublicKey;
use std::str::FromStr;

let pk = PublicKey::from_str("ed25519:H4sIAAAAAAAAA+2X0Q6CMBAAtVlJQgYAAAA=")?;
let result: near_primitives::views::FinalExecutionOutcomeView = Account("alice.testnet".parse()?)
    .add_key(AccessKeyPermission::FullAccess, pk)
    .with_signer(Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

pub fn delete_key(&self, public_key: PublicKey) -> ConstructTransaction

Deletes an access key from the given account ID.

Example

use near_api::*;
use near_crypto::PublicKey;
use std::str::FromStr;
let result: near_primitives::views::FinalExecutionOutcomeView = Account("alice.testnet".parse()?)
    .delete_key(PublicKey::from_str("ed25519:H4sIAAAAAAAAA+2X0Q6CMBAAtVlJQgYAAAA=")?)
    .with_signer(Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

pub fn delete_keys(&self, public_keys: Vec<PublicKey>) -> ConstructTransaction

Deletes multiple access keys from the given account ID.

Example

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

let result: near_primitives::views::FinalExecutionOutcomeView = Account("alice.testnet".parse()?)
    .delete_keys(vec![PublicKey::from_str("ed25519:H4sIAAAAAAAAA+2X0Q6CMBAAtVlJQgYAAAA=")?])
    .with_signer(Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

pub fn delete_account_with_beneficiary( &self, beneficiary_id: AccountId, ) -> ConstructTransaction

Deletes the account with the given beneficiary ID. The account balance will be transferred to the beneficiary.

Please note that this action is irreversible. Also, you have to understand that another person could potentially re-create the account with the same name and pretend to be you on other websites that use your account ID as a unique identifier. (near.social, devhub proposal, etc)

Do not use it unless you understand the consequences.

Example

use near_api::*;

let result: near_primitives::views::FinalExecutionOutcomeView = Account("alice.testnet".parse()?)
    .delete_account_with_beneficiary("bob.testnet".parse()?)
    .with_signer(Signer::new(Signer::from_ledger())?)
    .send_to_testnet()
    .await?;

pub const fn create_account(account_id: AccountId) -> CreateAccountBuilder

Creates a new account builder for the given account ID.

Creating account sponsored by faucet service

This is a way to create an account without having to fund it. It works only on testnet. The account should be created as a sub-account of the testnet account

use near_api::*;

let secret = near_api::signer::generate_secret_key()?;
let result: reqwest::Response = Account::create_account("alice.testnet".parse()?)
    .sponsor_by_faucet_service()
    .public_key(secret.public_key())?
    .send_to_testnet_faucet()
    .await?;
// You have to save the secret key somewhere safe
std::fs::write("secret.key", secret.to_string())?;

Creating sub-account of the linkdrop root account funded by your own NEAR and signed by your account

There is a few linkdrop root accounts that you can use to create sub-accounts.

• For mainnet, you can use the near account.
• For testnet, you can use the testnet account.

use near_api::*;

let secret = near_api::signer::generate_secret_key()?;
let bob_signer = Signer::new(Signer::from_seed_phrase("lucky barrel fall come bottom can rib join rough around subway cloth ", None)?)?;
let result: near_primitives::views::FinalExecutionOutcomeView = Account::create_account("alice.testnet".parse()?)
    .fund_myself("bob.testnet".parse()?, NearToken::from_near(1))
    .public_key(secret.public_key())?
    .with_signer(bob_signer)
    .send_to_testnet()
    .await?;

Creating sub-account of your own account funded by your NEAR

You can create only one level deep of sub-accounts.

E.g you are alice.testnet, you can’t create sub.sub.alice.testnet, but you can create sub.alice.testnet. Though, ‘sub.alice.testnet’ can create sub-accounts of its own.

use near_api::*;

let secret = near_api::signer::generate_secret_key()?;
let bob_signer = Signer::new(Signer::from_seed_phrase("lucky barrel fall come bottom can rib join rough around subway cloth ", None)?)?;
let result: near_primitives::views::FinalExecutionOutcomeView = Account::create_account("sub.bob.testnet".parse()?)
    .fund_myself("bob.testnet".parse()?, NearToken::from_near(1))
    .public_key(secret.public_key())?
    .with_signer(bob_signer)
    .send_to_testnet()
    .await?;

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Account

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

Formats the value using the given formatter.