Class RouterArguments

constructor

• new RouterArguments(options?): RouterArguments

• Parameters

  • options: {
        WGAS?: string;
    } = {}

    • Optional WGAS?: string

  Returns RouterArguments

WGAS

gasCost

params

routerContains

Static ADDRESS_THIS

Static BALANCE_THIS

Static MSG_SENDER

Static ROUTER

combineRouteParams

• combineRouteParams(firstParams, lastParams, order?): RouteParams

• Parameters

  • firstParams: RouteParams
  • lastParams: RouteParams
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns RouteParams

deposit

• deposit(vault, tokens, tokenAmounts, minOut): void

• Parameters

  • vault: string
  • tokens: string[]
  • tokenAmounts: bigint[]
  • minOut: bigint

  Returns void

ensureRouterEmpty

• ensureRouterEmpty(): void

• Returns void

getCalldata

• getCalldata(): string

• Returns string

getGasCostEstimate

• getGasCostEstimate(options?): bigint

• Parameters

  • options: {
        additionalMargin?: number;
        remote?: boolean;
    } = {}

    • Optional additionalMargin?: number

    • Optional remote?: boolean

  Returns bigint

getParams

• getParams(checkRouterIsEmpty?): RouterCallArguments

• Parameters

  • checkRouterIsEmpty: boolean = true

  Returns RouterCallArguments

liquiditySwap

• liquiditySwap(fromVault, toVault, channelId, minOuts, transferTo, gasTokensToSend, routingIncentive, amount?, deadline?, target_data?, revert_to?): void

• Parameters

  • fromVault: string
  • toVault: string
  • channelId: string
  • minOuts: [bigint, bigint]
  • transferTo: string
  • gasTokensToSend: bigint
  • routingIncentive: RoutingIncentive
  • amount: bigint = RouterArguments.BALANCE_THIS
  • deadline: bigint = ...
  • target_data: string = ''
  • revert_to: string = RouterArguments.MSG_SENDER

  Returns void

localroute

• localroute(fromAsset, route, minOut): void

• Parameters

  • fromAsset: string
  • route: RouteDetails
  • minOut: bigint

  Returns void

modifyRouterContains

• modifyRouterContains(asset, amount): void

• Parameters

  • asset: string
  • amount: bigint

  Returns void

permit2Permit

• permit2Permit(permitSingle, signature, order?): void

• Parameters

  • permitSingle: PermitSingle
  • signature: string
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

permit2PermitBatch

• permit2PermitBatch(permitBatch, signature, order?): void

• Parameters

  • permitBatch: PermitBatch
  • signature: string
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

permit2TransferFrom

• permit2TransferFrom(token, amount, order?): void

• Parameters

  • token: string
  • amount: bigint
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

permit2TransferFromBatch

• permit2TransferFromBatch(assets, owner, order?): void

• Parameters

  • assets: {
        amount: bigint;
        token: string;
    }[]
  • owner: string
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

sendAsset

• sendAsset(fromAsset, toAssetIndex, fromVault, toVault, channelId, minOut, transferTo, gasTokensToSend, routingIncentive, deadline?, underwritingIncentive?, target_data?, revert_to?): void

• Encodes a sendAsset into the routers calldata.

  Parameters

  • fromAsset: string
  • toAssetIndex: number
  • fromVault: string
  • toVault: string
  • channelId: string
  • minOut: bigint
  • transferTo: string
  • gasTokensToSend: bigint

    How many gas tokens are sent to the incentive contract? Should be getIncentiveCost(...) of the incentives

    • the estimated cost of verifying the message from the source chain.
  • routingIncentive: RoutingIncentive

    The routing incentives provided to the relayer routingIncentive.maxGasDelivery should be the estimated cost on the destination chain. routingIncentive.maxGasAck should be the estimated cost on the source chain. routingIncentive.refundGasTo Should be the sender of the transaction. Cannot be set to RouterArguments.MSG_SENDER. routingIncentive.priceOfDeliveryGas How much to pay for execution on the destination chain in native gas? routingIncentive.priceOfAckGas Should be greater than the base gas when the transaction is executed. routingIncentive.targetDelta Set it to more than the confirmation time for the bridge.
  • deadline: bigint = ...
  • underwritingIncentive: bigint = ...
  • target_data: string = ''
  • revert_to: string = RouterArguments.MSG_SENDER

  Returns void

sweep

• sweep(token, target, minOut?): void

• Parameters

  • token: string
  • target: string
  • minOut: bigint = ...

  Returns void

transferFrom

• transferFrom(token, amount): void

• Parameters

  • token: string
  • amount: bigint

  Returns void

transferWithOptionalPermit

• transferWithOptionalPermit(asset, permitData?, order?): void

• Transfers single asset after enacting a permit if necessary. If a permit (single) and a signature are provided, it enacts the permit before transferring the asset. If no permit information is provided, it directly transfers the specified asset.

  Parameters

  • asset: {
        amount: bigint;
        token: string;
    }

    An object containing the token address and amount to be transferred.

    • amount: bigint

    • token: string

  • Optional permitData: PermitData

    Optional. An object containing the permit information for a single permit.
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

transferWithOptionalPermitBatch

• transferWithOptionalPermitBatch(assets, owner, permitBatchData?, order?): void

• Transfers multiple assets after enacting a permit if necessary. If a permit (batch) and a signature are provided, it enacts the permit before transferring the assets. If no permit information is provided, it directly transfers the specified assets.

  Parameters

  • assets: {
        amount: bigint;
        token: string;
    }[]

    An array of objects containing the token address and amount to be transferred.
  • owner: string

    The address of the owner of the assets.
  • Optional permitBatchData: PermitBatchData

    Optional. An object containing the permit information for a batched permit.
  • order: CombineRouteParamsOrder = CombineRouteParamsOrder.Last

  Returns void

transferWithPermitForDepositWithLiquiditySwaps

• transferWithPermitForDepositWithLiquiditySwaps(assets, owner, gasUsage, permitBatchData?): {
      executionInstructions: {
          commands: string;
          gas: {
              estimatedGasUsedOnLocal: bigint;
              estimatedGasUsedOnLocalAck: bigint;
              estimatedGasUsedOnRemote: bigint;
              estimatedRefundOnAck: bigint;
              estimatedRoutingPayment: bigint;
          };
          inputs: string[];
      };
  }

• Parameters

  • assets: {
        amount: bigint;
        token: string;
    }[]

    The assets to be transferred, with their token addresses and amounts.
  • owner: string

    The owner of the assets to be transferred.
  • gasUsage: {
        estimatedGasUsedOnLocalAck: bigint;
        estimatedGasUsedOnRemote: bigint;
        estimatedRoutingPayment: bigint;
    }

    The estimated gas usage for the remote and local operations.

    • estimatedGasUsedOnLocalAck: bigint

    • estimatedGasUsedOnRemote: bigint

    • estimatedRoutingPayment: bigint

  • Optional permitBatchData: PermitBatchData

    The data required for the permit batch, if using a permit.

  Returns {
      executionInstructions: {
          commands: string;
          gas: {
              estimatedGasUsedOnLocal: bigint;
              estimatedGasUsedOnLocalAck: bigint;
              estimatedGasUsedOnRemote: bigint;
              estimatedRefundOnAck: bigint;
              estimatedRoutingPayment: bigint;
          };
          inputs: string[];
      };
  }

  An object containing the execution instructions, including the commands, inputs, and estimated gas usage.

  • executionInstructions: {
        commands: string;
        gas: {
            estimatedGasUsedOnLocal: bigint;
            estimatedGasUsedOnLocalAck: bigint;
            estimatedGasUsedOnRemote: bigint;
            estimatedRefundOnAck: bigint;
            estimatedRoutingPayment: bigint;
        };
        inputs: string[];
    }

    • commands: string

    • gas: {
          estimatedGasUsedOnLocal: bigint;
          estimatedGasUsedOnLocalAck: bigint;
          estimatedGasUsedOnRemote: bigint;
          estimatedRefundOnAck: bigint;
          estimatedRoutingPayment: bigint;
      }

      • estimatedGasUsedOnLocal: bigint

      • estimatedGasUsedOnLocalAck: bigint

      • estimatedGasUsedOnRemote: bigint

      • estimatedRefundOnAck: bigint

      • estimatedRoutingPayment: bigint

    • inputs: string[]

  Notice

  Adds the transfer with optional permit instructions to the router for a deposit with liquidity swaps. This function should be called after prepareDepositWithLiquiditySwapsViaPermits to complete the deposit with liquidity swap flow. If gas is provided as an asset prepareDepositWithLiquiditySwaps, it is not needed to set the asset here. (Unless you want to combine both newly wrapped gas & pre-wrapped gas)

transferWithPermitForWithdrawWithLiquiditySwap

• transferWithPermitForWithdrawWithLiquiditySwap(asset, gasUsage, permitData?): {
      executionInstructions: {
          commands: string;
          gas: {
              estimatedGasUsedOnLocal: bigint;
              estimatedGasUsedOnLocalAck: bigint;
              estimatedGasUsedOnRemote: bigint;
              estimatedRefundOnAck: bigint;
              estimatedRoutingPayment: bigint;
          };
          inputs: string[];
      };
  }

• Parameters

  • asset: {
        amount: bigint;
        token: string;
    }

    The asset to be transferred, with its token address and amount.

    • amount: bigint

    • token: string

  • gasUsage: {
        estimatedGasUsedOnLocalAck: bigint;
        estimatedGasUsedOnRemote: bigint;
        estimatedRoutingPayment: bigint;
    }

    The estimated gas usage for the remote and local operations.

    • estimatedGasUsedOnLocalAck: bigint

    • estimatedGasUsedOnRemote: bigint

    • estimatedRoutingPayment: bigint

  • Optional permitData: PermitData

    The data required for the permit, if using a permit.

  Returns {
      executionInstructions: {
          commands: string;
          gas: {
              estimatedGasUsedOnLocal: bigint;
              estimatedGasUsedOnLocalAck: bigint;
              estimatedGasUsedOnRemote: bigint;
              estimatedRefundOnAck: bigint;
              estimatedRoutingPayment: bigint;
          };
          inputs: string[];
      };
  }

  An object containing the execution instructions, including the commands, inputs, and estimated gas usage.

  • executionInstructions: {
        commands: string;
        gas: {
            estimatedGasUsedOnLocal: bigint;
            estimatedGasUsedOnLocalAck: bigint;
            estimatedGasUsedOnRemote: bigint;
            estimatedRefundOnAck: bigint;
            estimatedRoutingPayment: bigint;
        };
        inputs: string[];
    }

    • commands: string

    • gas: {
          estimatedGasUsedOnLocal: bigint;
          estimatedGasUsedOnLocalAck: bigint;
          estimatedGasUsedOnRemote: bigint;
          estimatedRefundOnAck: bigint;
          estimatedRoutingPayment: bigint;
      }

      • estimatedGasUsedOnLocal: bigint

      • estimatedGasUsedOnLocalAck: bigint

      • estimatedGasUsedOnRemote: bigint

      • estimatedRefundOnAck: bigint

      • estimatedRoutingPayment: bigint

    • inputs: string[]

  Notice

  Adds the transfer with optional permit instructions to the router for a withdraw with liquidity swap. This function should be called after prepareWithdrawWithLiquiditySwapsViaPermits to complete the withdraw with liquidity swap flow.

unwrapGas

• unwrapGas(to, minOut?): void

• Parameters

  • to: string
  • minOut: bigint = ...

  Returns void

withdrawEqual

• withdrawEqual(vault, amountVaultTokens, minOuts): void

• Parameters

  • vault: string
  • amountVaultTokens: bigint
  • minOuts: bigint[]

  Returns void

withdrawMixed

• withdrawMixed(vault, amountVaultTokens, withdrawRatios, minOuts): void

• Parameters

  • vault: string
  • amountVaultTokens: bigint
  • withdrawRatios: bigint[]
  • minOuts: bigint[]

  Returns void

wrapGas

• wrapGas(to?, amount?): void

• Parameters

  • to: string = RouterArguments.ADDRESS_THIS
  • amount: bigint = RouterArguments.BALANCE_THIS

  Returns void

Static addressEncodeHelper

• addressEncodeHelper(address): string

• Parameters

  • address: string

  Returns string

Static getIncentiveCost

• getIncentiveCost(routingIncentive, baseVerificationCost?): bigint

• Returns the base cost given exactly by the routing incentives. There may be additional costs associated with verification which has to be paid on the sending side. Call estimateAdditionalCost() on the CCI to find out.

  Parameters

  • routingIncentive: RoutingIncentive
  • baseVerificationCost: bigint = ...

  Returns bigint

Static splitRoute

• splitRoute(fromAsset, route): [{
      fromAsset: string;
      routeDetails: RouteDetails;
  }, {
      fromAsset: string;
      routeDetails: RouteDetails;
  }, {
      fromAsset: string;
      routeDetails: RouteDetails;
  }]

• Parameters

  • fromAsset: string
  • route: RouteDetails

  Returns [{
      fromAsset: string;
      routeDetails: RouteDetails;
  }, {
      fromAsset: string;
      routeDetails: RouteDetails;
  }, {
      fromAsset: string;
      routeDetails: RouteDetails;
  }]