Class AlgorandAccountsStore

Class representing an Algorand accounts store.

Hierarchy

AlgorandAccountsStore

Index

Constructors

constructor

new AlgorandAccountsStore(algoClient: default): AlgorandAccountsStore
Create an instance of AlgorandAccountsStore.
Parameters
- algoClient: default
  
  The Algorand client instance.
Returns AlgorandAccountsStore
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:25

Properties

`Private` ALGO_DECIMALS

ALGO_DECIMALS: number = 6

`Private` __accounts

__accounts: Map<string, AlgorandAccount>

`Private` __client

__client: default

`Private` __multisigs

__multisigs: Map<string, AlgorandMultiSigAccount>

Methods

add

add(...args: [sk: Uint8Array] | [mnemonic: string]): Promise<AlgorandAccount>
Adds a new Algorand account to the store.

Returns
- A promise that resolves with the added Algorand account.
Parameters
- Rest ...args: [sk: Uint8Array] | [mnemonic: string]
  
  Either the secret key (as a Uint8Array) or the mnemonic (as a string) for the account.
Returns Promise<AlgorandAccount>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:37

addMultiSignatureAccount

addMultiSignatureAccount(addresses: string[], threshold: number, version??: number): Promise<AlgorandMultiSigAccount>
Adds a new multi-signature Algorand account to the store.

Returns
- A promise that resolves with the added multi-signature account.
Parameters
- addresses: string[]
  
  The addresses of the participants in the multi-signature account.
- threshold: number
  
  The minimum number of signatures required to authorize a transaction.
- Optional version: number = 1
  
  The version of the multi-signature account.
Returns Promise<AlgorandMultiSigAccount>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:82

createNew

createNew(): Promise<AlgorandAccount>
Creates a new Algorand account.

Returns
- A promise that resolves with the newly created Algorand account.
Returns Promise<AlgorandAccount>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:158

createNewWithPrefix

createNewWithPrefix(prefix: string, tries??: number): Promise<AlgorandAccount>
Creates a new Algorand account with a specified prefix for the address.

Returns
- A promise that resolves with the newly created Algorand account.
Parameters
- prefix: string
  
  The prefix for the address.
- Optional tries: number = 10000
  
  The maximum number of attempts to find an available address.
Returns Promise<AlgorandAccount>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:176

getAccountInfo

getAccountInfo(params: string | AlgorandAccount): Promise<AlgorandAccountInformation>
Retrieves the account information for a specified account.

Returns
- A promise that resolves with the account information.
Parameters
- params: string | AlgorandAccount
  
  Either the account address (as a string) or the AlgorandAccount object.
Returns Promise<AlgorandAccountInformation>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:124

getAlgoBalance

getAlgoBalance(address: string): Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
Retrieves the Algo balance of a specified address.

Returns
- A promise that resolves with the Algo balance in both human-readable and BigNumber format.
Parameters
- address: string
  
  The address for which to retrieve the Algo balance.
Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:202

getStandardAssetBalance

getStandardAssetBalance(address: string, token: AlgorandStandardAssetConfig): Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
Retrieves the balance of a specific standard asset for a specified address.

Returns
- A promise that resolves with the asset balance in both human-readable and BigNumber format.
Parameters
- address: string
  
  The address for which to retrieve the asset balance.
- token: AlgorandStandardAssetConfig
  
  The token configuration object for the standard asset.
Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:221

signAndSendMultisigTransactions

signAndSendMultisigTransactions(groupedTxns: Transaction[], mParams: MultisigMetadata, signers: default[]): Promise<default>
Signs and sends an array of multisig transactions using the specified signers and multisig metadata.

Returns
- A promise that resolves with the result of sending the multisig transactions.
Parameters
- groupedTxns: Transaction[]
  
  The grouped transactions to sign and send.
- mParams: MultisigMetadata
  
  The multisig metadata object.
- signers: default[]
  
  The signers for the multisig account.
Returns Promise<default>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:297

signAndSendTransactions

signAndSendTransactions(transactions: Transaction[], signerAddress: string): Promise<string[]>
Signs and sends an array of transactions using the specified signer address.

Returns
- A promise that resolves with an array of transaction IDs.
Parameters
- transactions: Transaction[]
  
  The transactions to sign and send.
- signerAddress: string
  
  The address of the signer.
Returns Promise<string[]>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:256

updateAccountDetails

updateAccountDetails(account: AlgorandAccount): Promise<AlgorandAccount>
Updates the account details for a specified Algorand account.

Returns
- A promise that resolves with the updated Algorand account.
Parameters
- account: AlgorandAccount
  
  The Algorand account to update.
Returns Promise<AlgorandAccount>
- Defined in sdk-core/src/lib/chains/algorand/AccountsStore.ts:144

Class AlgorandAccountsStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

algoClient: default

Returns AlgorandAccountsStore

Properties

Private ALGO_DECIMALS

Private __accounts

Private __client

Private __multisigs

Methods

add

Returns

Parameters

Rest ...args: [sk: Uint8Array] | [mnemonic: string]

Returns Promise<AlgorandAccount>

addMultiSignatureAccount

Returns

Parameters

addresses: string[]

threshold: number

Optional version: number = 1

Returns Promise<AlgorandMultiSigAccount>

createNew

Returns

Returns Promise<AlgorandAccount>

createNewWithPrefix

Returns

Parameters

prefix: string

Optional tries: number = 10000

Returns Promise<AlgorandAccount>

getAccountInfo

Returns

Parameters

params: string | AlgorandAccount

Returns Promise<AlgorandAccountInformation>

getAlgoBalance

Returns

Parameters

address: string

Returns Promise<{ balanceBn: BigNumber; balanceHuman: BigNumber; }>

getStandardAssetBalance

Returns

Parameters

address: string

token: AlgorandStandardAssetConfig

Returns Promise<{ balanceBn: BigNumber; balanceHuman: BigNumber; }>

signAndSendMultisigTransactions

Returns

Parameters

groupedTxns: Transaction[]

mParams: MultisigMetadata

signers: default[]

Returns Promise<default>

signAndSendTransactions

Returns

Parameters

transactions: Transaction[]

signerAddress: string

Returns Promise<string[]>

updateAccountDetails

Returns

Parameters

account: AlgorandAccount

Returns Promise<AlgorandAccount>

Settings

Member Visibility

Theme

`Private` ALGO_DECIMALS

`Private` __accounts

`Private` __client

`Private` __multisigs

`Rest` ...args: [sk: Uint8Array] | [mnemonic: string]

`Optional` version: number = 1

`Optional` tries: number = 10000

Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>

Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>