Type Alias DepositTransactionDetails

DepositTransactionDetails: {
    amount: Numbers;
    approveBaseERC20?: boolean;
    approveBaseOverrides?: TransactionOverrides;
    approveERC20?: boolean;
    approveOverrides?: TransactionOverrides;
    bridgeAddress?: Address;
    customBridgeData?: Bytes;
    gasPerPubdataByte?: Numbers;
    l2GasLimit?: Numbers;
    operatorTip?: Numbers;
    overrides?: TransactionOverrides;
    refundRecipient?: Address;
    to?: Address;
    token: Address;
}

Type declaration

  • amount: Numbers

    The amount of the token to deposit.

  • OptionalapproveBaseERC20?: boolean

    Whether or not base token approval should be performed under the hood. Set this flag to true if you bridge a base token and didn't call the approveERC20 function beforehand.

  • OptionalapproveBaseOverrides?: TransactionOverrides

    Transaction's overrides for approval of a base token which may be used to pass L1 gasLimit, gasPrice, value, etc.

  • OptionalapproveERC20?: boolean

    Whether or not token approval should be performed under the hood. Set this flag to true if you bridge an ERC20 token and didn't call the approveERC20 function beforehand.

  • OptionalapproveOverrides?: TransactionOverrides

    Transaction's overrides for approval of an ERC20 token which may be used to pass L1 gasLimit, gasPrice, value, etc.

  • OptionalbridgeAddress?: Address

    The address of the bridge contract to be used. Defaults to the default ZKsync Era bridge (either L1EthBridge or L1Erc20Bridge).

  • OptionalcustomBridgeData?: Bytes

    Additional data that can be sent to a bridge.

  • OptionalgasPerPubdataByte?: Numbers

    The L2 gas price for each published L1 calldata byte.

  • Optionall2GasLimit?: Numbers

    Maximum amount of L2 gas that the transaction can consume during execution on L2.

  • OptionaloperatorTip?: Numbers

    If the ETH value passed with the transaction is not explicitly stated in the overrides, this field will be equal to the tip the operator will receive on top of the base cost of the transaction.

  • Optionaloverrides?: TransactionOverrides

    Transaction's overrides for deposit which may be used to pass L1 gasLimit, gasPrice, value, etc.

  • OptionalrefundRecipient?: Address

    The address on L2 that will receive the refund for the transaction. If the transaction fails, it will also be the address to receive l2Value.

  • Optionalto?: Address

    The address that will receive the deposited tokens on L2.

  • token: Address

    The address of the token to deposit.

Settings

Member Visibility