Class BridgeSDK

constructor

• new BridgeSDK(c?): BridgeSDK

• Parameters

  • Optional c: BridgeConfig

    Optional

  Returns BridgeSDK

config

deposit

• deposit(args, signer, options?): Promise<ContractTransaction>

• Parameters

  • args: BridgeDepositArguments

  • signer: Signer

  • options: Overrides = {}

  Returns Promise<ContractTransaction>

doesDepositMeetMinimumAmount

• doesDepositMeetMinimumAmount(tokenSymbol, amount, withdrawNetwork): Promise<boolean>

• Parameters

  • tokenSymbol: string

  • amount: BigNumber

  • withdrawNetwork: "ethereum" | "arbitrum" | "polygon"

  Returns Promise<boolean>

getBridgeContract

• getBridgeContract(network, signerOrProvider): Bridge

• Parameters

  • network: "ethereum" | "arbitrum" | "polygon"

  • signerOrProvider: Signer | Provider

  Returns Bridge

getDepositAllowance

• getDepositAllowance(account, token, network, signer): Promise<BigNumber>

• Parameters

  • account: string

  • token: string

  • network: "ethereum" | "arbitrum" | "polygon"

  • signer: Signer

  Returns Promise<BigNumber>

getPendingWithdrawals

• getPendingWithdrawals(account, signers): Promise<PendingWithdrawal[]>

• Parameters

  • account: string

  • signers: BridgeNetworkMap<Signer>

  Returns Promise<PendingWithdrawal[]>

getTokenFee

• getTokenFee(tokenSymbol, withdrawNetwork): Promise<BigNumber>

• Parameters

  • tokenSymbol: string

  • withdrawNetwork: "ethereum" | "arbitrum" | "polygon"

  Returns Promise<BigNumber>

getWithdrawNonce

• getWithdrawNonce(args, signer): Promise<BigNumber>

• Parameters

  • args: BridgeGetNonceArguments

  • signer: Signer

  Returns Promise<BigNumber>

getWithdrawSignature

• getWithdrawSignature(network, txHash): Promise<any>

• Parameters

  • network: "ethereum" | "arbitrum" | "polygon"

  • txHash: string

  Returns Promise<any>

requestAutomaticWithdraw

• requestAutomaticWithdraw(network, txHash): Promise<any>

• Parameters

  • network: "ethereum" | "arbitrum" | "polygon"

  • txHash: string

  Returns Promise<any>

setDepositAllowance

• setDepositAllowance(token, network, amount, signer, options?): Promise<ContractTransaction>

• Parameters

  • token: string

  • network: "ethereum" | "arbitrum" | "polygon"

  • amount: BigNumber

  • signer: Signer

  • options: Overrides = {}

  Returns Promise<ContractTransaction>

withdraw

• withdraw(args, signer, options?): Promise<ContractTransaction>

• Parameters

  • args: BridgeWithdrawArguments

  • signer: Signer

  • options: Overrides = {}

  Returns Promise<ContractTransaction>