Class GlitterBridgeSDK

GlitterBridgeSDK Provides access to bridging on all supported chains

Hierarchy

GlitterBridgeSDK

Constructors

constructor

new GlitterBridgeSDK(): GlitterBridgeSDK
Returns GlitterBridgeSDK

Properties

`Private` _algorand

_algorand: undefined | AlgorandConnect

`Private` _bridgeConfig

_bridgeConfig: undefined | GlitterBridgeConfig

Bridge Configuration

`Private` _environment

_environment: undefined | GlitterEnvironment

`Private` _evm

_evm: Map<BridgeEvmNetworks, undefined | EvmConnect> = ...

Chain Specific SDKs

`Private` _pricing

_pricing: undefined | TokenPricing

`Private` _rpcList

_rpcList: undefined | ChainRPCConfigs

`Private` _rpcOverrides

_rpcOverrides: {
[key: string]: string;
} = {}

RPC URL Override

Type declaration

[key: string]: string

`Private` _rpcOverridesByChain

_rpcOverridesByChain: Map<BridgeNetworks, ChainRPCConfig> = ...

`Private` _solana

_solana: undefined | SolanaConnect

`Private` _tron

_tron: undefined | TronConnect

Accessors

algorand

get algorand(): undefined | AlgorandConnect
Retrieves the Algorand connection.

Returns
- The Algorand connection or undefined if not available.
Returns undefined | AlgorandConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:283

arbitrum

get arbitrum(): undefined | EvmConnect
Retrieves the Arbitrum connection.

Returns
- The Arbitrum connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:328

avalanche

get avalanche(): undefined | EvmConnect
Retrieves the Avalanche connection.

Returns
- The Avalanche connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:319

binance

get binance(): undefined | EvmConnect
Retrieves the Binance connection.

Returns
- The Binance connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:337

environment

get environment(): undefined | GlitterEnvironment
Retrieves the current Glitter environment.

Returns
- The current Glitter environment, or undefined if not set.
Returns undefined | GlitterEnvironment
- Defined in sdk-core/src/GlitterBridgeSDK.ts:274

ethereum

get ethereum(): undefined | EvmConnect
Retrieves the Ethereum connection.

Returns
- The Ethereum connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:301

optimism

get optimism(): undefined | EvmConnect
Retrieves the Optimism connection.

Returns
- The Optimism connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:355

polygon

get polygon(): undefined | EvmConnect
Retrieves the Polygon connection.

Returns
- The Polygon connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:310

rpcList

get rpcList(): undefined | ChainRPCConfigs
Retrieves the RPC list configuration.

Returns
- The RPC list configuration or undefined if not available.
Returns undefined | ChainRPCConfigs
- Defined in sdk-core/src/GlitterBridgeSDK.ts:373

solana

get solana(): undefined | SolanaConnect
Retrieves the Solana connection.

Returns
- The Solana connection or undefined if not available.
Returns undefined | SolanaConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:292

tron

get tron(): undefined | TronConnect
Retrieves the Tron connection.

Returns
- The Tron connection or undefined if not available.
Returns undefined | TronConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:364

zkevm

get zkevm(): undefined | EvmConnect
Retrieves the Zkevm connection.

Returns
- The Zkevm connection or undefined if not available.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:346

Methods

confirmationsRequired

confirmationsRequired(chainName: string): number
Retrieves the number of confirmations required for the specified chain or network.

Returns
- The number of confirmations required.
Parameters
- chainName: string
Returns number
- Defined in sdk-core/src/GlitterBridgeSDK.ts:383
confirmationsRequired(chain: string): number
Parameters
- chain: string
Returns number
- Defined in sdk-core/src/GlitterBridgeSDK.ts:384

connect

connect(networks: BridgeNetworks[], rpcListOverride?: ChainRPCConfigs): GlitterBridgeSDK
Connects the Glitter Bridge SDK to the specified networks using their default RPC configurations or custom RPC configurations if provided.

Returns
The connected GlitterBridgeSDK instance.
Parameters
- networks: BridgeNetworks[]
  
  An array of networks to connect to.
- Optional rpcListOverride: ChainRPCConfigs
  
  Optional custom RPC configurations to override the default RPC configurations for the networks.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:85

`Private` connectToAlgorand

connectToAlgorand(): GlitterBridgeSDK
Private
Connects to the Algorand network.

Returns
- The GlitterBridgeSDK instance.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:184

`Private` connectToEvmNetwork

connectToEvmNetwork(network: BridgeEvmNetworks): GlitterBridgeSDK
Private
Connects to the specified EVM network.

Returns
- The GlitterBridgeSDK instance.
Parameters
- network: BridgeEvmNetworks
  
  The EVM network to connect to.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:222

`Private` connectToSolana

connectToSolana(): GlitterBridgeSDK
Private
Connects to the Solana network.

Returns
- The GlitterBridgeSDK instance.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:202

`Private` connectToTron

connectToTron(): GlitterBridgeSDK
Private
Connects to the Tron network.

Returns
- The GlitterBridgeSDK instance.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:162

gasToken

gasToken(chainName: string): Token2Config
Retrieves the gas token configuration for the specified chain or network.

Returns
- The gas token configuration, or undefined if not found.
Parameters
- chainName: string
Returns Token2Config
- Defined in sdk-core/src/GlitterBridgeSDK.ts:406
gasToken(chain: string): Token2Config
Parameters
- chain: string
Returns Token2Config
- Defined in sdk-core/src/GlitterBridgeSDK.ts:407

getEvmNetwork

getEvmNetwork(evmNetwork: BridgeEvmNetworks): undefined | EvmConnect
Retrieves the EVM network configuration for the specified EVM network.

Returns
- The EVM network configuration, or undefined if not found.
Parameters
- evmNetwork: BridgeEvmNetworks
  
  The EVM network.
Returns undefined | EvmConnect
- Defined in sdk-core/src/GlitterBridgeSDK.ts:253

`Private` getV2EvmTokens

getV2EvmTokens(network: BridgeEvmNetworks): Token2ChainConfig[]
Parameters
- network: BridgeEvmNetworks
Returns Token2ChainConfig[]
- Defined in sdk-core/src/GlitterBridgeSDK.ts:236

`Private` preInitializeChecks

preInitializeChecks(network: BridgeNetworks): void
Private
Performs pre-initialization checks for the specified network.

Returns
Parameters
- network: BridgeNetworks
  
  The network to perform pre-initialization checks for.
Returns void
- Defined in sdk-core/src/GlitterBridgeSDK.ts:137

setEnvironment

setEnvironment(environment: GlitterEnvironment): GlitterBridgeSDK
Sets the environment for the Glitter Bridge SDK.

Returns
The updated GlitterBridgeSDK instance.
Parameters
- environment: GlitterEnvironment
  
  The environment to set for the SDK.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:46

setRPC

setRPC(network: BridgeNetworks, rpcUrl: string): GlitterBridgeSDK
Sets the RPC URL for a specific network in the Glitter Bridge SDK.

Returns
The updated GlitterBridgeSDK instance.
Parameters
- network: BridgeNetworks
  
  The network for which to set the RPC URL.
- rpcUrl: string
  
  The RPC URL to set for the specified network.
Returns GlitterBridgeSDK
- Defined in sdk-core/src/GlitterBridgeSDK.ts:73

Class GlitterBridgeSDK

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GlitterBridgeSDK

Properties

Private _algorand

Private _bridgeConfig

Private _environment

Private _evm

Private _pricing

Private _rpcList

Private _rpcOverrides

Type declaration

[key: string]: string

Private _rpcOverridesByChain

Private _solana

Private _tron

Accessors

algorand

Returns

Returns undefined | AlgorandConnect

arbitrum

Returns

Returns undefined | EvmConnect

avalanche

Returns

Returns undefined | EvmConnect

binance

Returns

Returns undefined | EvmConnect

environment

Returns

Returns undefined | GlitterEnvironment

ethereum

Returns

Returns undefined | EvmConnect

optimism

Returns

Returns undefined | EvmConnect

polygon

Returns

Returns undefined | EvmConnect

rpcList

Returns

Returns undefined | ChainRPCConfigs

solana

Returns

Returns undefined | SolanaConnect

tron

Returns

Returns undefined | TronConnect

zkevm

Returns

Returns undefined | EvmConnect

Methods

confirmationsRequired

Returns

Parameters

chainName: string

Returns number

Parameters

chain: string

Returns number

connect

Returns

Parameters

networks: BridgeNetworks[]

Optional rpcListOverride: ChainRPCConfigs

Returns GlitterBridgeSDK

Private connectToAlgorand

Returns

Returns GlitterBridgeSDK

Private connectToEvmNetwork

Returns

`Private` _algorand

`Private` _bridgeConfig

`Private` _environment

`Private` _evm

`Private` _pricing

`Private` _rpcList

`Private` _rpcOverrides

`Private` _rpcOverridesByChain

`Private` _solana

`Private` _tron

`Optional` rpcListOverride: ChainRPCConfigs

`Private` connectToAlgorand

`Private` connectToEvmNetwork

`Private` connectToSolana

`Private` connectToTron

`Private` getV2EvmTokens

`Private` preInitializeChecks