Class EvmConnect

Hierarchy

EvmConnect

Index

Constructors

constructor

new EvmConnect(network: BridgeEvmNetworks, config: {
    bridge: string;
    chainId: number;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokens: BridgeTokenConfig[];
}): EvmConnect
Parameters
- network: BridgeEvmNetworks
- config: {
      bridge: string;
      chainId: number;
      depositWallet: string;
      releaseWallet: string;
      rpcUrl: string;
      tokens: BridgeTokenConfig[];
  }
  - bridge: string
  - chainId: number
  - depositWallet: string
  - releaseWallet: string
  - rpcUrl: string
  - tokens: BridgeTokenConfig[]
Returns EvmConnect
- Defined in lib/chains/evm/connect.ts:62

Properties

`Protected` `Readonly` __config

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

Type declaration

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

`Protected` `Readonly` __network

__network: BridgeEvmNetworks

`Protected` `Readonly` __providers

__providers: Connection

Accessors

config

get config(): {
    bridge: string;
    chainId: number;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokens: BridgeTokenConfig[];
}
Returns {
    bridge: string;
    chainId: number;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokens: BridgeTokenConfig[];
}
- bridge: string
- chainId: number
- depositWallet: string
- releaseWallet: string
- rpcUrl: string
- tokens: BridgeTokenConfig[]
- Defined in lib/chains/evm/connect.ts:73

generateWallet

get generateWallet(): Wallet
Returns Wallet
- Defined in lib/chains/evm/connect.ts:456

network

get network(): BridgeEvmNetworks
Returns BridgeEvmNetworks
- Defined in lib/chains/evm/connect.ts:77

provider

get provider(): BaseProvider
Returns BaseProvider
- Defined in lib/chains/evm/connect.ts:69

Methods

approveTokensForBridge

approveTokensForBridge(tokenSymbol: string, amount: string | BigNumber, signer: Signer): Promise<ContractTransaction>
Before bridging tokens we need to check if tokens are approved for bridge to use if not, we can use this method to sign and approve transaction

Returns
Parameters
- tokenSymbol: string
  
  only USDC for now
- amount: string | BigNumber
  
  in BigNumber units e.g 1_000_000 for 1USDC
- signer: Signer
  
  to sign the transaction
Returns Promise<ContractTransaction>
- Defined in lib/chains/evm/connect.ts:144

bridge

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

Returns
Parameters
- destinationWallet: string | PublicKey | default
  
  provide USDC reciever address on destination chain
- destination: BridgeNetworks
- tokenSymbol: string
  
  only USDC for now
- amount: string | BigNumber
  
  in BigNumber units e.g 1_000_000 for 1USDC
- signer: Signer
Returns Promise<ContractTransaction>
- Defined in lib/chains/evm/connect.ts:298

bridgeAllowance

bridgeAllowance(tokenSymbol: string, signer: Signer): Promise<BigNumber>
Get the amount of tokens approved to be used by the bridge

Returns
Parameters
- tokenSymbol: string
  
  only USDC for now
- signer: Signer
  
  to sign the transaction
Returns Promise<BigNumber>
- Defined in lib/chains/evm/connect.ts:165

`Private` createConnections

createConnections(rpcUrl: string, config: {
    bridge: string;
    chainId: number;
    depositWallet: string;
    releaseWallet: string;
    rpcUrl: string;
    tokens: BridgeTokenConfig[];
}): Connection
Parameters
- rpcUrl: string
- config: {
      bridge: string;
      chainId: number;
      depositWallet: string;
      releaseWallet: string;
      rpcUrl: string;
      tokens: BridgeTokenConfig[];
  }
  - bridge: string
  - chainId: number
  - depositWallet: string
  - releaseWallet: string
  - rpcUrl: string
  - tokens: BridgeTokenConfig[]
Returns Connection
- Defined in lib/chains/evm/connect.ts:38

getAddress

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

Returns
Parameters
- entity: "tokens" | "bridge" | "depositWallet" | "releaseWallet"
- Optional tokenSymbol: string
  
  only USDC for now
Returns string
- Defined in lib/chains/evm/connect.ts:87

getBlockNumber

getBlockNumber(txHash: string): Promise<number>
Parameters
- txHash: string
Returns Promise<number>
- Defined in lib/chains/evm/connect.ts:218

getChainFromID

getChainFromID(chainId: number): undefined | BridgeNetworks
Parameters
- chainId: number
Returns undefined | BridgeNetworks
- Defined in lib/chains/evm/connect.ts:267

getTimeStamp

getTimeStamp(txHash: string): Promise<number>
Parameters
- txHash: string
Returns Promise<number>
- Defined in lib/chains/evm/connect.ts:237

getTimeStampFromBlockNumber

getTimeStampFromBlockNumber(blockNumber: number): Promise<number>
Parameters
- blockNumber: number
Returns Promise<number>
- Defined in lib/chains/evm/connect.ts:228

getToken

getToken(tokenSymbol: string): undefined | BridgeTokenConfig
Parameters
- tokenSymbol: string
Returns undefined | BridgeTokenConfig
- Defined in lib/chains/evm/connect.ts:460

getTokenBalanceOnNetwork

getTokenBalanceOnNetwork(tokenSymbol: string, address: string): Promise<BigNumber>
Provide token balance of an address on the connected evm network

Returns
Parameters
- tokenSymbol: string
  
  only USDC for now
- address: string
Returns Promise<BigNumber>
- Defined in lib/chains/evm/connect.ts:122

getTxnHashed

getTxnHashed(txnID: string): string
Parameters
- txnID: string
Returns string
- Defined in lib/chains/evm/connect.ts:349

getTxnStatus

getTxnStatus(txHash: string): Promise<ChainStatus>
Parameters
- txHash: string
Returns Promise<ChainStatus>
- Defined in lib/chains/evm/connect.ts:249

`Private` isCorrectChain

isCorrectChain(wallet: Signer): Promise<boolean>
Check if provided wallet is connected to same chain as EvmConnect to execute a transaction

Returns
Parameters
- wallet: Signer
Returns Promise<boolean>
- Defined in lib/chains/evm/connect.ts:285

`Private` isValidToken

isValidToken(tokenSymbol: string): boolean
Parameters
- tokenSymbol: string
Returns boolean
- Defined in lib/chains/evm/connect.ts:112

parseLogs

parseLogs(txHash: string): Promise<(BridgeDepositEvent | BridgeReleaseEvent | TransferEvent)[]>
Parse transaction receipts to retrieve bridge transfer data

Returns
Parameters
- txHash: string
  
  transaction hash of deposit or release event on evm chain
Returns Promise<(BridgeDepositEvent | BridgeReleaseEvent | TransferEvent)[]>
- Defined in lib/chains/evm/connect.ts:188

Class EvmConnect

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

network: BridgeEvmNetworks

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

bridge: string

chainId: number

depositWallet: string

releaseWallet: string

rpcUrl: string

tokens: BridgeTokenConfig[]

Returns EvmConnect

Properties

Protected Readonly __config

Type declaration

bridge: string

chainId: number

depositWallet: string

releaseWallet: string

rpcUrl: string

tokens: BridgeTokenConfig[]

Protected Readonly __network

Protected Readonly __providers

Accessors

config

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

bridge: string

chainId: number

depositWallet: string

releaseWallet: string

rpcUrl: string

tokens: BridgeTokenConfig[]

generateWallet

Returns Wallet

network

Returns BridgeEvmNetworks

provider

Returns BaseProvider

Methods

approveTokensForBridge

Returns

Parameters

tokenSymbol: string

amount: string | BigNumber

signer: Signer

Returns Promise<ContractTransaction>

bridge

Returns

Parameters

destinationWallet: string | PublicKey | default

destination: BridgeNetworks

tokenSymbol: string

amount: string | BigNumber

signer: Signer

Returns Promise<ContractTransaction>

bridgeAllowance

Returns

Parameters

tokenSymbol: string

signer: Signer

Returns Promise<BigNumber>

Private createConnections

Parameters

rpcUrl: string

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

bridge: string

chainId: number

depositWallet: string

releaseWallet: string

rpcUrl: string

tokens: BridgeTokenConfig[]

Returns Connection

getAddress

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

`Protected` `Readonly` __config

`Protected` `Readonly` __network

`Protected` `Readonly` __providers

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

`Private` createConnections

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

`Optional` tokenSymbol: string

`Private` isCorrectChain

`Private` isValidToken