Enum Account

pub enum Account {
    KeyPair(SingleAccount),
    Multisig(MultisigAccount),
}

Represents either a single-signature or multisig account.

This is the main account type used for interacting with the Stellar network. It provides methods for signing transactions, configuring account settings, and managing sequence numbers.

Variants

KeyPair(SingleAccount)

Single-signature account with one key pair

Multisig(MultisigAccount)

Multi-signature account

Implementations

impl Account

pub fn single(signer: Signer) -> Self

Creates a new single-signature Account instance with the provided signer.

Parameters

• signer - The signer for this account

Returns

A new Account instance with the KeyPair variant

pub fn multisig(account_id: AccountId, signers: Vec<Signer>) -> Self

Creates a new multisig Account instance with the provided account ID and signers.

Parameters

• account_id - The identifier for this account
• signers - A vector of signers for this multi-signature account

Returns

A new Account instance with the Multisig variant

pub fn account_id(&self) -> AccountId

Returns the account’s identifier.

pub fn signers(&self) -> &[Signer]

Returns a reference to the account’s signers.

pub async fn load(&self, env: &Env) -> Result<AccountEntry, SorobanHelperError>

Loads the account information from the network.

Parameters

• env - The environment to use for loading the account

Returns

• AccountEntry - The account information

pub async fn get_sequence( &self, env: &Env, ) -> Result<AccountSequence, SorobanHelperError>

Gets the current sequence number for the account.

Parameters

• env - The environment to use for fetching the sequence number

Returns

The current sequence number wrapped in AccountSequence

pub async fn next_sequence( &self, env: &Env, ) -> Result<AccountSequence, SorobanHelperError>

Retrieves the next available sequence number.

This is useful when preparing a new transaction.

Parameters

• env - The environment to use for fetching the sequence number

Returns

The next sequence number (current + 1) wrapped in AccountSequence

pub fn add_guard(&mut self, guard: Guard)

Adds a guard to the account.

Guards are used to control and limit operations that can be performed with this account. Multiple guards can be added to an account, and all guards must pass for operations to proceed.

Parameters

• guard - The guard to add to the account

pub fn check_guards(&self, tx: &Transaction) -> Result<bool, SorobanHelperError>

Checks if all guards associated with this account are satisfied.

This method evaluates all guards attached to the account and returns true only if all of them pass their respective checks.

Returns

• false - If any guard fails its check

pub fn update_guards( &mut self, tx: &Transaction, ) -> Result<(), SorobanHelperError>

Updates the state of all guards after an operation has been performed.

This method should be called after a successful operation to update the internal state of all guards (e.g., decrement remaining allowed calls).

pub fn sign_transaction( &mut self, tx: &Transaction, network_id: &Hash, ) -> Result<TransactionEnvelope, SorobanHelperError>

Signs a transaction, ensuring the account still has authorized calls.

Decrements the authorized call counter when successful.

Parameters

• tx - The transaction to sign
• network_id - The network ID hash

Returns

A signed transaction envelope

pub fn sign_transaction_envelope( &mut self, tx_envelope: &TransactionEnvelope, network_id: &Hash, ) -> Result<TransactionEnvelope, SorobanHelperError>

Signs a transaction envelope by appending new signatures.

Parameters

• tx_envelope - The transaction envelope to sign
• network_id - The network ID hash

Returns

A transaction envelope with the new signatures appended

pub async fn configure( self, env: &Env, config: AccountConfig, ) -> Result<TransactionEnvelope, SorobanHelperError>

Configures the account by building and signing a transaction that sets options.

This can be used to add signers, set thresholds, and modify other account settings.

Parameters

• env - The environment to use for transaction building
• config - The account configuration to apply

Returns

A signed transaction envelope containing the set options operations

pub fn sign_transaction_unsafe( &self, tx: &Transaction, network_id: &Hash, ) -> Result<TransactionEnvelope, SorobanHelperError>

Signs a transaction without checking or decrementing the authorized_calls counter.

This method bypasses authorization checks and should be used with caution.

Parameters

• tx - The transaction to sign
• network_id - The network ID hash

Returns

A signed transaction envelope

pub fn sign_with_signers( tx: &Transaction, network_id: &Hash, signers: &[Signer], ) -> Result<VecM<DecoratedSignature, 20>, SorobanHelperError>

Sign a transaction using the account’s signers.

Parameters

• tx - The transaction to sign
• network_id - The network ID hash
• signers - The signers to use

Returns

A vector of decorated signatures

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for Account

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

Formats the value using the given formatter.

impl From<MultisigAccount> for Account

fn from(account: MultisigAccount) -> Self

Converts to this type from the input type.

impl From<Signer> for Account

fn from(signer: Signer) -> Self

Converts to this type from the input type.

impl From<SingleAccount> for Account

fn from(account: SingleAccount) -> Self

Converts to this type from the input type.