Class AlgorandConnect

Hierarchy

AlgorandConnect

Index

Constructors

Properties

accountsStore assetsRepo client clientIndexer config

Methods

bridgeTransactions getAddress getAlgodClient getAlgodIndexer getAsset getBalance optinAsset optinAssetTransaction waitForBalance waitForBalanceChange waitForMinBalance

Constructors

constructor

new AlgorandConnect(config: AlgorandConfig): AlgorandConnect
Parameters
- config: AlgorandConfig
Returns AlgorandConnect
- Defined in lib/chains/algorand/AlgorandConnect.ts:26

Properties

`Readonly` accountsStore

accountsStore: AlgorandAccountsStore

`Readonly` assetsRepo

assetsRepo: AssetsRepository

`Readonly` client

client: default

`Readonly` clientIndexer

clientIndexer: default

`Readonly` config

config: AlgorandConfig

Methods

bridgeTransactions

bridgeTransactions(sourceAddress: string, destinationAdress: string, destinationNetwork: BridgeNetworks, tokenSymbol: string, amount: bigint): Promise<Transaction[]>
Returns
Parameters
- sourceAddress: string
- destinationAdress: string
- destinationNetwork: BridgeNetworks
- tokenSymbol: string
- amount: bigint
Returns Promise<Transaction[]>
- Defined in lib/chains/algorand/AlgorandConnect.ts:51

getAddress

getAddress(key: "bridge" | "asaOwner" | "algoOwner" | "bridgeOwner" | "feeReceiver" | "multiSig1" | "multiSig2" | "asaVault" | "algoVault" | "usdcReceiver" | "usdcDeposit" | "tokenBridgeV2Address"): string
Returns
Parameters
- key: "bridge" | "asaOwner" | "algoOwner" | "bridgeOwner" | "feeReceiver" | "multiSig1" | "multiSig2" | "asaVault" | "algoVault" | "usdcReceiver" | "usdcDeposit" | "tokenBridgeV2Address"
Returns string
- Defined in lib/chains/algorand/AlgorandConnect.ts:134

getAlgodClient

getAlgodClient(): default
Returns

Returns default
- Defined in lib/chains/algorand/AlgorandConnect.ts:120

getAlgodIndexer

getAlgodIndexer(): default
Returns

Returns default
- Defined in lib/chains/algorand/AlgorandConnect.ts:107

getAsset

getAsset(tokenSymbol: string): undefined | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Returns
Parameters
- tokenSymbol: string
Returns undefined | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in lib/chains/algorand/AlgorandConnect.ts:142

getBalance

getBalance(address: string, tokenSymbol: string): Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
Returns
Parameters
- address: string
- tokenSymbol: string
Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
- Defined in lib/chains/algorand/AlgorandConnect.ts:151

optinAsset

optinAsset(signerAddress: string, tokenSymbol: string): Promise<string>
Parameters
- signerAddress: string
- tokenSymbol: string
Returns Promise<string>
- Defined in lib/chains/algorand/AlgorandConnect.ts:280

optinAssetTransaction

optinAssetTransaction(signerAddress: string, tokenSymbol: string): Promise<Transaction>
Returns
Parameters
- signerAddress: string
- tokenSymbol: string
Returns Promise<Transaction>
- Defined in lib/chains/algorand/AlgorandConnect.ts:267

waitForBalance

waitForBalance(address: string, expectedAmount: number, tokenSymbol: string, timeoutSeconds?: number, threshold?: number, anybalance?: boolean, noBalance?: boolean): Promise<number>
Returns
Parameters
- address: string
- expectedAmount: number
- tokenSymbol: string
- timeoutSeconds: number = 60
- threshold: number = 0.001
- anybalance: boolean = false
- noBalance: boolean = false
Returns Promise<number>
- Defined in lib/chains/algorand/AlgorandConnect.ts:231

waitForBalanceChange

waitForBalanceChange(address: string, tokenSymbol: string, startingAmount: number, timeoutSeconds?: number): Promise<number>
Returns
Parameters
- address: string
- tokenSymbol: string
- startingAmount: number
- timeoutSeconds: number = 60
Returns Promise<number>
- Defined in lib/chains/algorand/AlgorandConnect.ts:174

waitForMinBalance

waitForMinBalance(address: string, minAmount: number, tokenSymbol: string, timeoutSeconds?: number): Promise<number>
Returns
Parameters
- address: string
- minAmount: number
- tokenSymbol: string
- timeoutSeconds: number = 60
Returns Promise<number>
- Defined in lib/chains/algorand/AlgorandConnect.ts:201

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

destinationAdress: string

destinationNetwork: BridgeNetworks

tokenSymbol: string

amount: bigint

Returns Promise<Transaction[]>

getAddress

Returns

Parameters

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

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; }>

optinAsset

Parameters

signerAddress: string

tokenSymbol: string

Returns Promise<string>

optinAssetTransaction

Returns

Parameters

signerAddress: string

tokenSymbol: string

Returns Promise<Transaction>

waitForBalance

Returns

Parameters

address: string

expectedAmount: number

tokenSymbol: string

timeoutSeconds: number = 60

threshold: number = 0.001

anybalance: boolean = false

noBalance: boolean = false

Returns Promise<number>

waitForBalanceChange

Returns

Parameters

address: string

tokenSymbol: string

startingAmount: number

timeoutSeconds: number = 60

Returns Promise<number>

waitForMinBalance

`Readonly` accountsStore

`Readonly` assetsRepo

`Readonly` client

`Readonly` clientIndexer

`Readonly` config

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