Class BridgeTokens

Represents a class that manages bridge tokens. (V1 + Circle Bridge)

Hierarchy

BridgeTokens

Index

Constructors

constructor

new BridgeTokens(): BridgeTokens
Returns BridgeTokens

Properties

`Static` `Private` tokenConfig

tokenConfig: Map<BridgeNetworks, (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]> = ...

Methods

`Static` add

add(network: algorand, config: (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]): void
Adds tokens to the bridge token configuration for the specified network.

Static

Function
add

Returns

Returns

Returns
Parameters
- network: algorand
  
  The Algorand network for which to add the tokens.
- config: (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
  
  The Algorand token configuration array.
Returns void
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:158
add(network: solana | Ethereum | Polygon | Avalanche | TRON, config: BridgeTokenConfig[]): void
Parameters
- network: solana | Ethereum | Polygon | Avalanche | TRON
- config: BridgeTokenConfig[]
Returns void
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:163

`Static` `Private` addUpdateTokens

addUpdateTokens(network: BridgeNetworks, config: (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]): void
Private
Adds or updates tokens in the bridge token configuration for the specified network.

Static

Function
addUpdateTokens

Returns
Parameters
- network: BridgeNetworks
  
  The network for which to add or update the tokens.
- config: (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
  
  The token configuration array.
Returns void
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:199

`Static` getFromAddress

getFromAddress(network: algorand, address: string): AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Retrieves the token associated with the specified address for the specified network.

Static

Function
getFromAddress

Returns
- The token associated with the specified address for the Algorand network, or undefined if not found.
Returns
- The token associated with the specified address for the specified network, or undefined if not found.
Returns
- The token associated with the specified address for the specified network, or undefined if not found.
Parameters
- network: algorand
  
  The Algorand network for which to retrieve the token.
- address: string
  
  The address associated with the token to retrieve.
Returns AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:113
getFromAddress(network: solana | Ethereum | Polygon | Avalanche | TRON, address: string): BridgeTokenConfig
Parameters
- network: solana | Ethereum | Polygon | Avalanche | TRON
- address: string
Returns BridgeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:114
getFromAddress(network: BridgeNetworks, address: string): undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Parameters
- network: BridgeNetworks
- address: string
Returns undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:115

`Static` getToken

getToken(network: algorand, symbol: string): AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Retrieves the token with the specified symbol for the specified network.

Static

Function
getToken

Returns
- The token with the specified symbol for the Algorand network, or undefined if not found.
Returns
- The token with the specified symbol for the specified network, or undefined if not found.
Returns
- The token with the specified symbol for the specified network, or undefined if not found.
Parameters
- network: algorand
  
  The Algorand network for which to retrieve the token.
- symbol: string
  
  The symbol of the token to retrieve.
Returns AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:77
getToken(network: solana | Ethereum | Polygon | Avalanche | TRON, symbol: string): BridgeTokenConfig
Parameters
- network: solana | Ethereum | Polygon | Avalanche | TRON
- symbol: string
Returns BridgeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:78
getToken(network: BridgeNetworks, symbol: string): undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
Parameters
- network: BridgeNetworks
- symbol: string
Returns undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:79

`Static` getTokens

getTokens(network: algorand): (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
Retrieves the tokens for the specified network.

Static

Function
getTokens

Returns
- The array of tokens for the Algorand network.
Returns
- The array of tokens for the specified network.
Returns
- The array of tokens for the specified network.
Parameters
- network: algorand
  
  The Algorand network for which to retrieve the tokens.
Returns (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:55
getTokens(network: solana | Ethereum | Polygon | Avalanche | TRON): BridgeTokenConfig[]
Parameters
- network: solana | Ethereum | Polygon | Avalanche | TRON
Returns BridgeTokenConfig[]
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:56
getTokens(network: BridgeNetworks): (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
Parameters
- network: BridgeNetworks
Returns (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:57

`Static` loadConfig

loadConfig(network: BridgeNetworks, config: (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]): void
Loads the bridge token configuration for the specified network.

Static

Function
loadConfig

Returns
Parameters
- network: BridgeNetworks
  
  The network for which to load the bridge token configuration.
- config: (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]
  
  The bridge token configuration array.
Returns void
- Defined in sdk-core/src/lib/common/tokens/BridgeTokens.ts:32

Class BridgeTokens

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BridgeTokens

Properties

Static Private tokenConfig

Methods

Static add

Static

Function

Returns

Returns

Returns

Parameters

network: algorand

config: (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]

Returns void

Parameters

network: solana | Ethereum | Polygon | Avalanche | TRON

config: BridgeTokenConfig[]

Returns void

Static Private addUpdateTokens

Static

Function

Returns

Parameters

network: BridgeNetworks

config: (BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]

Returns void

Static getFromAddress

Static

Function

Returns

Returns

Returns

Parameters

network: algorand

address: string

Returns AlgorandStandardAssetConfig | AlgorandNativeTokenConfig

Parameters

network: solana | Ethereum | Polygon | Avalanche | TRON

address: string

Returns BridgeTokenConfig

Parameters

network: BridgeNetworks

address: string

Returns undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig

Static getToken

Static

Function

Returns

Returns

Returns

Parameters

network: algorand

symbol: string

Returns AlgorandStandardAssetConfig | AlgorandNativeTokenConfig

Parameters

network: solana | Ethereum | Polygon | Avalanche | TRON

symbol: string

Returns BridgeTokenConfig

Parameters

network: BridgeNetworks

symbol: string

Returns undefined | BridgeTokenConfig | AlgorandStandardAssetConfig | AlgorandNativeTokenConfig

Static getTokens

Static

Function

Returns

Returns

Returns

Parameters

network: algorand

Returns (AlgorandStandardAssetConfig | AlgorandNativeTokenConfig)[]

Parameters

`Static` `Private` tokenConfig

`Static` add

`Static` `Private` addUpdateTokens

`Static` getFromAddress

`Static` getToken

`Static` getTokens

`Static` loadConfig