Class AlgorandConnect

Class representing the Algorand connection.

Hierarchy

AlgorandConnect

Index

Constructors

constructor

new AlgorandConnect(config: AlgorandConfig): AlgorandConnect
Create an instance of AlgorandConnect.
Parameters
- config: AlgorandConfig
  
  The Algorand configuration object.
Returns AlgorandConnect
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:54

Properties

`Readonly` accountsStore

accountsStore: AlgorandAccountsStore

The Algorand accounts store.

`Readonly` assetsRepo

assetsRepo: AssetsRepository

The Assets repository.

`Readonly` client

client: default

The Algorand client instance.

`Readonly` clientIndexer

clientIndexer: default

The Algorand Indexer client.

`Readonly` config

config: AlgorandConfig

The Algorand configuration object.

Methods

bridgeTransactions

bridgeTransactions(sourceAddress: string, destinationAddress: string, destinationNetwork: BridgeNetworks, tokenSymbol: string, amount: bigint): Promise<Transaction[]>
Initiates bridge transactions to transfer tokens from the source network to the destination network.

Returns
- A promise that resolves with an array of bridge transactions.
Parameters
- sourceAddress: string
  
  The source address on the source network.
- destinationAddress: string
  
  The destination address on the destination network.
- destinationNetwork: BridgeNetworks
  
  The destination network type.
- tokenSymbol: string
  
  The symbol of the token being transferred.
- amount: bigint
  
  The amount of tokens to be transferred (as a BigInt).
Returns Promise<Transaction[]>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:81

getAddress

getAddress(key: "asaOwner" | "algoOwner" | "bridgeOwner" | "feeReceiver" | "multiSig1" | "multiSig2" | "bridge" | "asaVault" | "algoVault" | "usdcReceiver" | "usdcDeposit" | "tokenBridgeProgramID" | "tokenBridgeV2ProgramID"): string
Retrieves the address corresponding to a specified key from the bridge accounts configuration.

Returns
- The address corresponding to the specified key.
Parameters
- key: "asaOwner" | "algoOwner" | "bridgeOwner" | "feeReceiver" | "multiSig1" | "multiSig2" | "bridge" | "asaVault" | "algoVault" | "usdcReceiver" | "usdcDeposit" | "tokenBridgeProgramID" | "tokenBridgeV2ProgramID"
  
  The key for the bridge account address.
Returns string
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:170

getAlgodClient

getAlgodClient(): default
Retrieves the Algod client instance.

Returns
- The Algod client instance.
Returns default
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:154

getAlgodIndexer

getAlgodIndexer(): default
Retrieves the Algod Indexer instance.

Returns
- The Algod Indexer instance.
Returns default
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:139

getAsset

getAsset(tokenSymbol: string): undefined | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Retrieves the asset configuration for a specified token symbol.

Returns
- The asset configuration for the specified token symbol, or undefined if not found.
Parameters
- tokenSymbol: string
  
  The symbol of the token.
Returns undefined | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:180

getBalance

getBalance(address: string, tokenSymbol: string): Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
Retrieves the balance of a specified token for a given address.

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

isOptedIn

isOptedIn(assetId: number, address: string): Promise<boolean>
Checks if a specified address is opted-in to a given asset.

Returns
- A promise that resolves with a boolean indicating if the address is opted-in to the asset.
Parameters
- assetId: number
  
  The ID of the asset.
- address: string
  
  The address to check.
Returns Promise<boolean>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:359

optin

optin(signerAddress: string, tokenSymbol: string): Promise<string>
Performs an opt-in operation for a specified token symbol.

Returns
- A promise that resolves with the result of the opt-in operation.
Parameters
- signerAddress: string
  
  The address of the account performing the opt-in.
- tokenSymbol: string
  
  The symbol of the token to opt-in.
Returns Promise<string>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:338

optinTransaction

optinTransaction(signerAddress: string, tokenSymbol: string): Promise<Transaction>
Generates an opt-in transaction for a specified token symbol.

Returns
- A promise that resolves with the opt-in transaction.
Parameters
- signerAddress: string
  
  The address of the account performing the opt-in.
- tokenSymbol: string
  
  The symbol of the token to opt-in.
Returns Promise<Transaction>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:318

waitForBalance

waitForBalance(address: string, expectedAmount: number, tokenSymbol: string, timeoutSeconds??: number, threshold??: number, anybalance??: boolean, noBalance??: boolean): Promise<number>
Waits for the balance of a specified token for a given address to match the expected amount within a timeout period.

Returns
- A promise that resolves with the updated balance amount that matches the expected amount.
Parameters
- address: string
  
  The address for which to wait for the balance.
- expectedAmount: number
  
  The expected balance amount to wait for.
- tokenSymbol: string
  
  The symbol of the token.
- Optional timeoutSeconds: number = 60
  
  The timeout duration in seconds.
- Optional threshold: number = 0.001
  
  The threshold to consider the balance amount as a match.
- Optional anybalance: boolean = false
  
  If true, waits for any balance change (greater or smaller) to match the expected amount.
- Optional noBalance: boolean = false
  
  If true, waits for no balance (zero) to match the expected amount.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:280

waitForBalanceChange

waitForBalanceChange(address: string, tokenSymbol: string, startingAmount: number, timeoutSeconds??: number): Promise<number>
Waits for the balance of a specified token for a given address to change from the starting amount.

Returns
- A promise that resolves with the updated balance amount after the change.
Parameters
- address: string
  
  The address for which to wait for the balance change.
- tokenSymbol: string
  
  The symbol of the token.
- startingAmount: number
  
  The starting balance amount to compare against.
- Optional timeoutSeconds: number = 60
  
  The timeout duration in seconds.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:219

waitForMinBalance

waitForMinBalance(address: string, minAmount: number, tokenSymbol: string, timeoutSeconds??: number): Promise<number>
Waits for the balance of a specified token for a given address to reach or exceed the minimum amount.

Returns
- A promise that resolves with the updated balance amount after reaching or exceeding the minimum.
Parameters
- address: string
  
  The address for which to wait for the minimum balance.
- minAmount: number
  
  The minimum balance amount to wait for.
- tokenSymbol: string
  
  The symbol of the token.
- Optional timeoutSeconds: number = 60
  
  The timeout duration in seconds.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/algorand/AlgorandConnect.ts:248

Class AlgorandConnect

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: AlgorandConfig

Returns AlgorandConnect

Properties

Readonly accountsStore

Readonly assetsRepo

Readonly client

Readonly clientIndexer

Readonly config

Methods

bridgeTransactions

Returns

Parameters

sourceAddress: string

destinationAddress: string

destinationNetwork: BridgeNetworks

tokenSymbol: string

amount: bigint

Returns Promise<Transaction[]>

getAddress

Returns

Parameters

key: "asaOwner" | "algoOwner" | "bridgeOwner" | "feeReceiver" | "multiSig1" | "multiSig2" | "bridge" | "asaVault" | "algoVault" | "usdcReceiver" | "usdcDeposit" | "tokenBridgeProgramID" | "tokenBridgeV2ProgramID"

Returns string

getAlgodClient

Returns

Returns default

getAlgodIndexer

Returns

Returns default

getAsset

Returns

Parameters

tokenSymbol: string

Returns undefined | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig

getBalance

Returns

Parameters

address: string

tokenSymbol: string

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

isOptedIn

Returns

Parameters

assetId: number

address: string

Returns Promise<boolean>

optin

Returns

Parameters

signerAddress: string

tokenSymbol: string

Returns Promise<string>

optinTransaction

Returns

Parameters

signerAddress: string

tokenSymbol: string

Returns Promise<Transaction>

waitForBalance

Returns

Parameters

address: string

expectedAmount: number

tokenSymbol: string

Optional timeoutSeconds: number = 60

Optional threshold: number = 0.001

Optional anybalance: boolean = false

Optional noBalance: boolean = false

Returns Promise<number>

waitForBalanceChange

Returns

`Readonly` accountsStore

`Readonly` assetsRepo

`Readonly` client

`Readonly` clientIndexer

`Readonly` config

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

`Optional` timeoutSeconds: number = 60

`Optional` threshold: number = 0.001

`Optional` anybalance: boolean = false

`Optional` noBalance: boolean = false

`Optional` timeoutSeconds: number = 60

`Optional` timeoutSeconds: number = 60