Class SolanaConnect

Represents a connection to the Solana network.

Hierarchy

SolanaConnect

Index

Constructors

constructor

new SolanaConnect(config: GlitterBridgeConfig): SolanaConnect
Represents a connection to the Solana network.
Parameters
- config: GlitterBridgeConfig
  
  The configuration object for the Solana connection.
Returns SolanaConnect
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:29

Properties

`Readonly` accountStore

accountStore: SolanaAccountsStore

`Readonly` connections

connections: Record<"testnet" | "devnet" | "mainnet", Connection>

`Readonly` defaultConnection

defaultConnection: "testnet" | "devnet" | "mainnet"

`Readonly` solanaConfig

solanaConfig: SolanaConfig

Methods

bridge

bridge(sourceAddress: string, destinationAddress: string, destinationNetwork: BridgeNetworks, tokenSymbol: string, amount: bigint): Promise<string>
Initiates a bridge operation to transfer tokens from the source network to the destination network.

Method
bridge

Async

Returns
- A Promise that resolves to a string representing the transaction hash or identifier for the bridge operation.
Parameters
- sourceAddress: string
  
  The source address from which to transfer the tokens.
- destinationAddress: string
  
  The destination address to receive the transferred tokens.
- destinationNetwork: BridgeNetworks
  
  The destination network to bridge the tokens to.
- tokenSymbol: string
  
  The symbol of the token to be bridged.
- amount: bigint
  
  The amount of tokens to be bridged, represented as a bigint.
Returns Promise<string>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:161

bridgeTransaction

bridgeTransaction(sourceAddress: string, destinationAddress: string, destinationNetwork: BridgeNetworks, tokenSymbol: string, amount: bigint): Promise<Transaction>
Initiates a bridge transaction to transfer tokens from the source network to the destination network.

Method
bridgeTransaction

Async

Returns
- A Promise that resolves to the transaction for the bridge operation.
Parameters
- sourceAddress: string
  
  The source address from which to transfer the tokens.
- destinationAddress: string
  
  The destination address to receive the transferred tokens.
- destinationNetwork: BridgeNetworks
  
  The destination network to bridge the tokens to.
- tokenSymbol: string
  
  The symbol of the token to be bridged.
- amount: bigint
  
  The amount of tokens to be bridged, represented as a bigint.
Returns Promise<Transaction>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:82

getAddress

getAddress(key: keyof SolanaAccountsConfig): string
Retrieves the address associated with a specific key from the SolanaConfig accounts.

Method
getAddress

Returns
- The address associated with the specified key.
Parameters
- key: keyof SolanaAccountsConfig
  
  The key for which to retrieve the address.
Returns string
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:377

getBalance

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

Method
getBalance

Async

Returns
- A Promise that resolves to an object containing the balance information for the specified token.
Parameters
- account: string
  
  The account for which to retrieve the balance.
- tokenSymbol: string
  
  The symbol of the token for which to retrieve the balance.
Returns Promise<{
balanceBn: BigNumber;
balanceHuman: BigNumber;
}>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:227

`Private` getConnection

getConnection(tokenSymbol: string): Connection
Retrieves the connection for a specific token based on its symbol.

Method
getConnection

Returns
- The connection object for the specified token.
Parameters
- tokenSymbol: string
  
  The symbol of the token for which to retrieve the connection.
Returns Connection
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:298

getToken

getToken(tokenSymbol: string): undefined | BridgeTokenConfig
Retrieves the configuration for a token based on its symbol.

Method
getToken

Returns
- The configuration for the token if found, or undefined if the token is not found.
Parameters
- tokenSymbol: string
  
  The symbol of the token for which to retrieve the configuration.
Returns undefined | BridgeTokenConfig
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:66

isOptedIn

isOptedIn(tokenSymbol: string, address: string): Promise<boolean>
Checks if a specific address has opted in to a token.

Method
isOptedIn

Async

Returns
- A Promise that resolves to a boolean indicating whether the address has opted in to the token.
Parameters
- tokenSymbol: string
  
  The symbol of the token to check.
- address: string
  
  The address to check for opt-in status.
Returns Promise<boolean>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:358

optin

optin(signerAddress: string, tokenSymbol: string): Promise<string>
Initiates the opt-in process for a specific token by creating and sending an opt-in transaction.

Method
optin

Async

Returns
- A Promise that resolves to a string representing the transaction hash or identifier for the opt-in transaction.
Parameters
- signerAddress: string
  
  The address of the account that will opt in to the token.
- tokenSymbol: string
  
  The symbol of the token for which to initiate the opt-in process.
Returns Promise<string>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:336

optinTransaction

optinTransaction(signerAddress: string, tokenSymbol: string): Promise<Transaction>
Creates a transaction for opting in to a specific token.

Method
optinTransaction

Async

Returns
- A Promise that resolves to the transaction for opting in to the token.
Parameters
- signerAddress: string
  
  The address of the account that will opt in to the token.
- tokenSymbol: string
  
  The symbol of the token for which to create the opt-in transaction.
Returns Promise<Transaction>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:313

reconnect

reconnect(): void
Reconnects the Solana connection.

Method
reconnect

Returns

Returns void
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:387

`Private` sendTransaction

sendTransaction(connection: Connection, transaction: Transaction, account: SolanaAccount): Promise<string>
Sends a transaction to the Solana network using the provided connection and account.

Method
sendTransaction

Async

Returns
- A Promise that resolves to a string representing the transaction hash or identifier.
Parameters
- connection: Connection
  
  The Solana connection object to use for sending the transaction.
- transaction: Transaction
  
  The transaction to be sent.
- account: SolanaAccount
  
  The Solana account to use for signing the transaction.
Returns Promise<string>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:202

waitForBalanceChange

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

Method
waitForBalanceChange

Async

Returns
- A Promise that resolves to the final balance after the change.
Parameters
- address: string
  
  The address for which to wait for the balance change.
- tokenSymbol: string
  
  The symbol of the token for which to wait for the balance change.
- expectedAmount: number
  
  The expected amount to which the balance should change.
- Optional timeoutSeconds: number = 60
  
  The timeout duration in seconds (optional, defaults to 60 seconds).
- Optional threshold: number = 0.001
  
  The threshold for considering the balance change significant (optional, defaults to 0.001).
- Optional anybalance: boolean = false
  
  Set to true to consider any balance change as valid (optional, defaults to false).
- Optional noBalance: boolean = false
  
  Set to true to wait for the balance to reach zero (optional, defaults to false).
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/solana/SolanaConnect.ts:257

Class SolanaConnect

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: GlitterBridgeConfig

Returns SolanaConnect

Properties

Readonly accountStore

Readonly connections

Readonly defaultConnection

Readonly solanaConfig

Methods

bridge

Method

Async

Returns

Parameters

sourceAddress: string

destinationAddress: string

destinationNetwork: BridgeNetworks

tokenSymbol: string

amount: bigint

Returns Promise<string>

bridgeTransaction

Method

Async

Returns

Parameters

sourceAddress: string

destinationAddress: string

destinationNetwork: BridgeNetworks

tokenSymbol: string

amount: bigint

Returns Promise<Transaction>

getAddress

Method

Returns

Parameters

key: keyof SolanaAccountsConfig

Returns string

getBalance

Method

Async

Returns

Parameters

account: string

tokenSymbol: string

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

Private getConnection

Method

Returns

Parameters

tokenSymbol: string

Returns Connection

getToken

Method

Returns

Parameters

tokenSymbol: string

Returns undefined | BridgeTokenConfig

isOptedIn

Method

Async

Returns

Parameters

tokenSymbol: string

address: string

Returns Promise<boolean>

optin

Method

Async

Returns

Parameters

signerAddress: string

tokenSymbol: string

`Readonly` accountStore

`Readonly` connections

`Readonly` defaultConnection

`Readonly` solanaConfig

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

`Private` getConnection

`Private` sendTransaction

`Optional` timeoutSeconds: number = 60

`Optional` threshold: number = 0.001

`Optional` anybalance: boolean = false

`Optional` noBalance: boolean = false