Struct Signer

pub struct Signer {
    pool: RwLock<HashMap<PublicKey, Box<dyn SignerTrait + Send + Sync + 'static>>>,
    nonce_cache: RwLock<HashMap<(AccountId, PublicKey), AtomicU64>>,
    current_public_key: AtomicUsize,
}

A Signer is a wrapper around a single or multiple signer implementations of SignerTrait.

It provides an access key pooling and a nonce caching mechanism to improve transaction throughput.

Fields

pool: RwLock<HashMap<PublicKey, Box<dyn SignerTrait + Send + Sync + 'static>>>

nonce_cache: RwLock<HashMap<(AccountId, PublicKey), AtomicU64>>

current_public_key: AtomicUsize

Implementations

impl Signer

pub fn new<T: SignerTrait + Send + Sync + 'static>( signer: T, ) -> Result<Arc<Self>, SignerError>

Creates a new signer and instantiates nonce cache.

pub async fn add_signer_to_pool<T: SignerTrait + Send + Sync + 'static>( &self, signer: T, ) -> Result<(), SignerError>

Adds a signer to the pool of signers. The Signer will rotate the provided implementation of SignerTrait on each call to get_public_key.

pub async fn fetch_tx_nonce( &self, account_id: AccountId, public_key: PublicKey, network: &NetworkConfig, ) -> Result<(Nonce, CryptoHash, BlockHeight), SignerError>

Fetches the transaction nonce and block hash associated to the access key. Internally caches the nonce as to not need to query for it every time, and ending up having to run into contention with others.

pub fn from_seed_phrase( seed_phrase: &str, password: Option<&str>, ) -> Result<SecretKeySigner, SecretError>

Creates a SecretKeySigner using seed phrase with default HD path.

pub fn from_secret_key(secret_key: SecretKey) -> SecretKeySigner

Creates a SecretKeySigner using a secret key.

pub fn from_seed_phrase_with_hd_path( seed_phrase: &str, hd_path: BIP32Path, password: Option<&str>, ) -> Result<SecretKeySigner, SecretError>

Creates a SecretKeySigner using seed phrase with a custom HD path.

pub fn from_access_keyfile( path: PathBuf, ) -> Result<SecretKeySigner, AccessKeyFileError>

Creates a SecretKeySigner using a path to the access key file.

pub fn from_ledger() -> LedgerSigner

Creates a LedgerSigner using default HD path.

pub const fn from_ledger_with_hd_path(hd_path: BIP32Path) -> LedgerSigner

Creates a LedgerSigner using a custom HD path.

pub fn from_keystore(pub_key: PublicKey) -> KeystoreSigner

Creates a KeystoreSigner with predefined public key.

pub async fn from_keystore_with_search_for_keys( account_id: AccountId, network: &NetworkConfig, ) -> Result<KeystoreSigner, KeyStoreError>

Creates a KeystoreSigner. The provided function will query provided account for public keys and search in the system keychain for the corresponding secret keys.

pub fn from_workspace(account: &Account) -> SecretKeySigner

Creates a SecretKeySigner from a near_workspaces::Account for testing purposes.

pub async fn get_public_key(&self) -> Result<PublicKey, SignerError>

Retrieves the public key from the pool of signers. The public key is rotated on each call.

pub async fn sign_meta( &self, tr: PrepopulateTransaction, public_key: PublicKey, nonce: Nonce, block_hash: CryptoHash, max_block_height: BlockHeight, ) -> Result<SignedDelegateAction, MetaSignError>

pub async fn sign( &self, tr: PrepopulateTransaction, public_key: PublicKey, nonce: Nonce, block_hash: CryptoHash, ) -> Result<SignedTransaction, SignerError>