Class EvmConnect

Class representing the Evm connection.

Hierarchy

EvmConnect

Constructors

constructor

new EvmConnect(network: BridgeEvmNetworks, config: {
    bridge: string;
    chainId: number;
    circleTreasury: string;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokenBridge: string;
    tokens: BridgeTokenConfig[];
}, bridgeV2Tokens?: Token2ChainConfig[]): EvmConnect
Create an instance of the class.
Parameters
- network: BridgeEvmNetworks
  
  The network for the instance.
- config: {
      bridge: string;
      chainId: number;
      circleTreasury: string;
      depositWallet: string;
      releaseWallet: string;
      rpcUrl: string;
      tokenBridge: string;
      tokens: BridgeTokenConfig[];
  }
  
  The configuration object for the EVM network.
  - bridge: string
  - chainId: number
  - circleTreasury: string
  - depositWallet: string
  - releaseWallet: string
  - rpcUrl: string
  - tokenBridge: string
  - tokens: BridgeTokenConfig[]
- Optional bridgeV2Tokens: Token2ChainConfig[]
  
  The list of bridge V2 tokens (optional).
Returns EvmConnect
- Defined in sdk-core/src/lib/chains/evm/connect.ts:116

Properties

`Protected` `Readonly` __config

__config: {
    bridge: string;
    chainId: number;
    circleTreasury: string;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokenBridge: string;
    tokens: BridgeTokenConfig[];
}

Type declaration

bridge: string
chainId: number
circleTreasury: string
depositWallet: string
releaseWallet: string
rpcUrl: string
tokenBridge: string
tokens: BridgeTokenConfig[]

`Protected` `Readonly` __network

__network: BridgeEvmNetworks

`Protected` `Readonly` __providers

__providers: Connection

Accessors

config

get config(): {
    bridge: string;
    chainId: number;
    circleTreasury: string;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokenBridge: string;
    tokens: BridgeTokenConfig[];
}
Retrieves the EVM network configuration for the instance.

Returns
- The EVM network configuration for the instance.
Returns {
    bridge: string;
    chainId: number;
    circleTreasury: string;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokenBridge: string;
    tokens: BridgeTokenConfig[];
}
- bridge: string
- chainId: number
- circleTreasury: string
- depositWallet: string
- releaseWallet: string
- rpcUrl: string
- tokenBridge: string
- tokens: BridgeTokenConfig[]
- Defined in sdk-core/src/lib/chains/evm/connect.ts:145

generateWallet

get generateWallet(): Wallet
Generates a new Ethereum wallet.

Returns
- The generated Ethereum wallet.
Returns Wallet
- Defined in sdk-core/src/lib/chains/evm/connect.ts:734

network

get network(): BridgeEvmNetworks
Retrieves the EVM network for the instance.

Returns
- The EVM network for the instance.
Returns BridgeEvmNetworks
- Defined in sdk-core/src/lib/chains/evm/connect.ts:154

provider

get provider(): BaseProvider
Retrieves the base provider for the instance.

Returns
- The base provider for the instance.
Returns BaseProvider
- Defined in sdk-core/src/lib/chains/evm/connect.ts:136

Methods

approveTokensForBridge

approveTokensForBridge(tokenSymbol: string, amount: string | BigNumber, signer: Signer): Promise<ContractTransaction>
Approves tokens to be used by the bridge.

Returns
- A promise that resolves with the approval transaction.
Parameters
- tokenSymbol: string
  
  The symbol of the token to approve.
- amount: string | BigNumber
  
  The amount of tokens to approve.
- signer: Signer
  
  The signer to use for the approval transaction.
Returns Promise<ContractTransaction>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:262

bridge

bridge(destinationWallet: string | default | PublicKey, destination: BridgeNetworks, tokenSymbol: string, amount: string | BigNumber, signer: Signer, v2?: boolean, protocolId?: number): Promise<ContractTransaction>
Bridge tokens to another supported chain

Returns
returns the transaction response
Parameters
- destinationWallet: string | default | PublicKey
  
  receiver address on destination chain
- destination: BridgeNetworks
  
  destination chain
- tokenSymbol: string
  
  only USDC for now
- amount: string | BigNumber
  
  in base units e.g 1_000_000 for 1USDC
- signer: Signer
  
  to sign transaction
- Optional v2: boolean
  
  is this a bridge v2 deposit?
- Optional protocolId: number
  
  for deposit processed by partners, protocolId allows the process of fee sharing
Returns Promise<ContractTransaction>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:538

bridgeAllowance

bridgeAllowance(tokenSymbol: string, signer: Signer): Promise<BigNumber>
Retrieves the current allowance of tokens for the bridge.

Returns
- A promise that resolves with the current token allowance for the bridge.
Parameters
- tokenSymbol: string
  
  The symbol of the token.
- signer: Signer
  
  The signer to use for the operation.
Returns Promise<BigNumber>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:335

`Private` createConnections

createConnections(rpcUrl: string, config: {
    bridge: string;
    chainId: number;
    circleTreasury: string;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokenBridge: string;
    tokens: BridgeTokenConfig[];
}, bridgeV2Tokens?: Token2ChainConfig[]): Connection
Private
Creates connection objects based on the provided RPC URL and configuration.

Returns
- The created connection object.
Parameters
- rpcUrl: string
  
  The RPC URL for the connection.
- config: {
      bridge: string;
      chainId: number;
      circleTreasury: string;
      depositWallet: string;
      releaseWallet: string;
      rpcUrl: string;
      tokenBridge: string;
      tokens: BridgeTokenConfig[];
  }
  
  The configuration object for the EVM network.
  - bridge: string
  - chainId: number
  - circleTreasury: string
  - depositWallet: string
  - releaseWallet: string
  - rpcUrl: string
  - tokenBridge: string
  - tokens: BridgeTokenConfig[]
- Optional bridgeV2Tokens: Token2ChainConfig[]
  
  Tokens for bridgeV2 configuration.
Returns Connection
- Defined in sdk-core/src/lib/chains/evm/connect.ts:64

`Private` deposit_bridgeV2

deposit_bridgeV2(options: {
    amount: string | BigNumber;
    destination: BridgeEvmNetworks;
    protocolId?: number;
    signer: Signer;
    targetWallet: Buffer;
    tokenSymbol: string;
}): Promise<ContractTransaction>
Private
Deposits tokens using the bridge V2.

Returns
- A promise that resolves with the deposit transaction.
Parameters
- options: {
      amount: string | BigNumber;
      destination: BridgeEvmNetworks;
      protocolId?: number;
      signer: Signer;
      targetWallet: Buffer;
      tokenSymbol: string;
  }
  
  The options for the deposit.
  - amount: string | BigNumber
    
    The amount of tokens to deposit.
  - destination: BridgeEvmNetworks
    
    The destination EVM network.
  - Optional protocolId?: number
    
    The protocol ID for the deposit (optional).
  - signer: Signer
    
    The signer to use for the deposit transaction.
  - targetWallet: Buffer
    
    The target wallet address.
  - tokenSymbol: string
    
    The symbol of the token to deposit.
Returns Promise<ContractTransaction>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:645

getAddress

getAddress(entity: "tokens" | "bridge" | "depositWallet" | "releaseWallet" | "tokenBridge" | "circleTreasury", tokenSymbol?: string): string
Provide address of bridge component

Returns
returns the address for the given entity
Parameters
- entity: "tokens" | "bridge" | "depositWallet" | "releaseWallet" | "tokenBridge" | "circleTreasury"
  
  The type of address to provide
- Optional tokenSymbol: string
  
  only USDC for now
Returns string
- Defined in sdk-core/src/lib/chains/evm/connect.ts:165

getBlockNumber

getBlockNumber(txHash: string): Promise<number>
Retrieves the block number of a transaction.

Returns
- A promise that resolves with the block number of the transaction.
Parameters
- txHash: string
  
  The transaction hash.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:420

getChainFromID

getChainFromID(chainId: number): undefined | BridgeNetworks
Retrieves the chain network from a chain ID.

Returns
- The bridge network corresponding to the chain ID, or undefined if not found.
Parameters
- chainId: number
  
  The chain ID.
Returns undefined | BridgeNetworks
- Defined in sdk-core/src/lib/chains/evm/connect.ts:496

getTimeStamp

getTimeStamp(txHash: string): Promise<number>
Retrieves the timestamp of a transaction.

Returns
- A promise that resolves with the timestamp of the transaction.
Parameters
- txHash: string
  
  The transaction hash.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:453

getTimeStampFromBlockNumber

getTimeStampFromBlockNumber(blockNumber: number): Promise<number>
Retrieves the timestamp from a block number.

Returns
- A promise that resolves with the timestamp of the block.
Parameters
- blockNumber: number
  
  The block number.
Returns Promise<number>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:437

getToken

getToken(tokenSymbol: string): undefined | BridgeTokenConfig | {
    address?: string;
    asset_id?: number;
    chain?: string;
    decimals?: number;
    isNative?: boolean;
    min_transfer?: number;
    name?: string;
    supportedDestination: BridgeNetworks[];
    symbol?: string;
    vault_address?: string;
    vault_id?: number;
    vault_type?: string;
}
Retrieves the token configuration (V1)for a given token symbol.
Parameters
- tokenSymbol: string
  
  The symbol of the token.
Returns undefined | BridgeTokenConfig | {
    address?: string;
    asset_id?: number;
    chain?: string;
    decimals?: number;
    isNative?: boolean;
    min_transfer?: number;
    name?: string;
    supportedDestination: BridgeNetworks[];
    symbol?: string;
    vault_address?: string;
    vault_id?: number;
    vault_type?: string;
}
- Defined in sdk-core/src/lib/chains/evm/connect.ts:743

getTokenBalanceOnNetwork

getTokenBalanceOnNetwork(tokenSymbol: string, address: string): Promise<BigNumber>
Parameters
- tokenSymbol: string
- address: string
Returns Promise<BigNumber>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:235

getTxnHashed

getTxnHashed(txnID: string): string
Retrieves the hashed transaction ID.

Returns
- The hashed transaction ID.
Parameters
- txnID: string
  
  The transaction ID.
Returns string
- Defined in sdk-core/src/lib/chains/evm/connect.ts:725

getTxnStatus

getTxnStatus(txHash: string): Promise<ChainStatus>
Retrieves the status of a transaction.

Returns
- A promise that resolves with the status of the transaction.
Parameters
- txHash: string
  
  The transaction hash.
Returns Promise<ChainStatus>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:472

`Private` getV1Token

getV1Token(tokenSymbol: string): undefined | BridgeTokenConfig
Parameters
- tokenSymbol: string
Returns undefined | BridgeTokenConfig
- Defined in sdk-core/src/lib/chains/evm/connect.ts:747

getV2Allowance

getV2Allowance(tokenSymbol: string, signer: Signer): Promise<BigNumber>
Parameters
- tokenSymbol: string
- signer: Signer
Returns Promise<BigNumber>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:357

getV2Balance

getV2Balance(address: string, tokenSymbol: string): Promise<BigNumber>
Retrieves the token balance of a specified token symbol for a given address on the network.

Returns
- A promise that resolves with the token balance as an ethers.BigNumber.
Parameters
- address: string
  
  The address for which to retrieve the token balance.
- tokenSymbol: string
  
  The symbol of the token.
Returns Promise<BigNumber>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:214

`Private` getV2Token

getV2Token(tokenSymbol: string): {
    address?: string;
    asset_id?: number;
    chain?: string;
    decimals?: number;
    isNative?: boolean;
    min_transfer?: number;
    name?: string;
    supportedDestination: BridgeNetworks[];
    symbol?: string;
    vault_address?: string;
    vault_id?: number;
    vault_type?: string;
}
Parameters
- tokenSymbol: string
Returns {
    address?: string;
    asset_id?: number;
    chain?: string;
    decimals?: number;
    isNative?: boolean;
    min_transfer?: number;
    name?: string;
    supportedDestination: BridgeNetworks[];
    symbol?: string;
    vault_address?: string;
    vault_id?: number;
    vault_type?: string;
}
- Optional address?: string
- Optional asset_id?: number
- Optional chain?: string
- Optional decimals?: number
- Optional isNative?: boolean
- Optional min_transfer?: number
- Optional name?: string
- supportedDestination: BridgeNetworks[]
- Optional symbol?: string
- Optional vault_address?: string
- Optional vault_id?: number
- Optional vault_type?: string
- Defined in sdk-core/src/lib/chains/evm/connect.ts:753

`Private` isCorrectChain

isCorrectChain(signer: Signer): Promise<boolean>
Private
Checks if the signer is connected to the correct chain.

Returns
- A promise that resolves with a boolean indicating if the signer is connected to the correct chain.
Parameters
- signer: Signer
  
  The signer to check.
Returns Promise<boolean>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:514

`Private` isValidToken

isValidToken(tokenSymbol: string): boolean
Private
Checks if a token symbol is valid.

Returns
- Returns true if the token symbol is valid, otherwise false.
Parameters
- tokenSymbol: string
  
  The symbol of the token.
Returns boolean
- Defined in sdk-core/src/lib/chains/evm/connect.ts:199

`Private` isValidV2Token

isValidV2Token(tokenSymbol: string): boolean
Parameters
- tokenSymbol: string
Returns boolean
- Defined in sdk-core/src/lib/chains/evm/connect.ts:203

parseLogs

parseLogs(txHash: string): Promise<(BridgeDepositEvent | BridgeReleaseEvent | TransferEvent)[]>
Parses logs from a transaction and returns an array of events.

Returns
- A promise that resolves with an array of parsed events.
Parameters
- txHash: string
  
  The transaction hash.
Returns Promise<(BridgeDepositEvent | BridgeReleaseEvent | TransferEvent)[]>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:383

v2Approve

v2Approve(__namedParameters: {
    amount: string | BigNumber;
    signer: Signer;
    tokenSymbol: string;
}): Promise<ContractTransaction>
Parameters
- __namedParameters: {
      amount: string | BigNumber;
      signer: Signer;
      tokenSymbol: string;
  }
  - amount: string | BigNumber
  - signer: Signer
  - tokenSymbol: string
Returns Promise<ContractTransaction>
- Defined in sdk-core/src/lib/chains/evm/connect.ts:282

Class EvmConnect

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

network: BridgeEvmNetworks

config: { bridge: string; chainId: number; circleTreasury: string; depositWallet: string; releaseWallet: string; rpcUrl: string; tokenBridge: string; tokens: BridgeTokenConfig[]; }

bridge: string

chainId: number

circleTreasury: string

depositWallet: string

releaseWallet: string

rpcUrl: string

tokenBridge: string

tokens: BridgeTokenConfig[]

Optional bridgeV2Tokens: Token2ChainConfig[]

Returns EvmConnect

Properties

Protected Readonly __config

Type declaration

bridge: string

chainId: number

circleTreasury: string

depositWallet: string

releaseWallet: string

rpcUrl: string

tokenBridge: string

tokens: BridgeTokenConfig[]

Protected Readonly __network

Protected Readonly __providers

Accessors

config

Returns

Returns { bridge: string; chainId: number; circleTreasury: string; depositWallet: string; releaseWallet: string; rpcUrl: string; tokenBridge: string; tokens: BridgeTokenConfig[]; }

bridge: string

chainId: number

circleTreasury: string

depositWallet: string

releaseWallet: string

rpcUrl: string

tokenBridge: string

tokens: BridgeTokenConfig[]

generateWallet

Returns

Returns Wallet

network

Returns

Returns BridgeEvmNetworks

provider

Returns

Returns BaseProvider

Methods

approveTokensForBridge

Returns

Parameters

tokenSymbol: string

amount: string | BigNumber

signer: Signer

Returns Promise<ContractTransaction>

bridge

Returns

Parameters

destinationWallet: string | default | PublicKey

destination: BridgeNetworks

tokenSymbol: string

amount: string | BigNumber

signer: Signer

Optional v2: boolean

Optional protocolId: number

Returns Promise<ContractTransaction>

bridgeAllowance

Returns

Parameters

tokenSymbol: string

signer: Signer

config: {
bridge: string;
chainId: number;
circleTreasury: string;
depositWallet: string;
releaseWallet: string;
rpcUrl: string;
tokenBridge: string;
tokens: BridgeTokenConfig[];
}

`Optional` bridgeV2Tokens: Token2ChainConfig[]

`Protected` `Readonly` __config

`Protected` `Readonly` __network

`Protected` `Readonly` __providers

Returns {
bridge: string;
chainId: number;
circleTreasury: string;
depositWallet: string;
releaseWallet: string;
rpcUrl: string;
tokenBridge: string;
tokens: BridgeTokenConfig[];
}

`Optional` v2: boolean

`Optional` protocolId: number

`Private` createConnections

config: {
bridge: string;
chainId: number;
circleTreasury: string;
depositWallet: string;
releaseWallet: string;
rpcUrl: string;
tokenBridge: string;
tokens: BridgeTokenConfig[];
}

`Optional` bridgeV2Tokens: Token2ChainConfig[]

`Private` deposit_bridgeV2

options: {
amount: string | BigNumber;
destination: BridgeEvmNetworks;
protocolId?: number;
signer: Signer;
targetWallet: Buffer;
tokenSymbol: string;
}

`Optional` protocolId?: number

`Optional` tokenSymbol: string

Returns undefined | BridgeTokenConfig | {
address?: string;
asset_id?: number;
chain?: string;
decimals?: number;
isNative?: boolean;
min_transfer?: number;
name?: string;
supportedDestination: BridgeNetworks[];
symbol?: string;
vault_address?: string;
vault_id?: number;
vault_type?: string;
}