Hierarchy

  • BaseContract
    • CircleRelayer

Properties

VERSION: TypedContractMethod<[], [string], "view">
bytes32ToAddress: TypedContractMethod<[address_: BytesLike], [string], "view">
calculateMaxSwapAmountIn: TypedContractMethod<[token: AddressLike], [bigint], "view">
calculateNativeSwapAmountOut: TypedContractMethod<[token: AddressLike, toNativeAmount: BigNumberish], [bigint], "view">
cancelOwnershipTransferRequest: TypedContractMethod<[chainId_: BigNumberish], [void], "nonpayable">
chainId: TypedContractMethod<[], [bigint], "view">
circleIntegration: TypedContractMethod<[], [string], "view">
confirmOwnershipTransferRequest: TypedContractMethod<[], [void], "nonpayable">
decodeTransferTokensWithRelay: TypedContractMethod<[encoded: BytesLike], [TransferTokensWithRelayStructOutput], "view">
encodeTransferTokensWithRelay: TypedContractMethod<[transfer: TransferTokensWithRelayStruct], [string], "view">
feeRecipient: TypedContractMethod<[], [string], "view">
filters: {
    AdminChanged: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    AdminChanged(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BeaconUpgraded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    BeaconUpgraded(address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FeeRecipientUpdated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    FeeRecipientUpdated(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    OwnershipTransfered: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    OwnershipTransfered(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SwapExecuted: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SwapExecuted(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SwapRateUpdated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    SwapRateUpdated(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Upgraded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
    Upgraded(address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

  • AdminChanged: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • AdminChanged(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • BeaconUpgraded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • BeaconUpgraded(address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FeeRecipientUpdated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • FeeRecipientUpdated(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • OwnershipTransfered: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • OwnershipTransfered(address,address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SwapExecuted: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SwapExecuted(address,address,address,uint256,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SwapRateUpdated: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • SwapRateUpdated(address,uint256): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Upgraded: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
  • Upgraded(address): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
getPaused: TypedContractMethod<[], [boolean], "view">
getRegisteredContract: TypedContractMethod<[emitterChainId: BigNumberish], [string], "view">
interface: CircleRelayerInterface
maxNativeSwapAmount: TypedContractMethod<[token: AddressLike], [bigint], "view">
nativeSwapRate: TypedContractMethod<[token: AddressLike], [bigint], "view">
nativeSwapRatePrecision: TypedContractMethod<[], [bigint], "view">
nativeTokenDecimals: TypedContractMethod<[], [bigint], "view">
owner: TypedContractMethod<[], [string], "view">
ownerAssistant: TypedContractMethod<[], [string], "view">
pendingOwner: TypedContractMethod<[], [string], "view">
redeemTokens: TypedContractMethod<[redeemParams: RedeemParametersStruct], [void], "payable">
registerContract: TypedContractMethod<[chainId_: BigNumberish, contractAddress: BytesLike], [void], "nonpayable">
relayerFee: TypedContractMethod<[chainId_: BigNumberish, token: AddressLike], [bigint], "view">
setPauseForTransfers: TypedContractMethod<[chainId_: BigNumberish, paused: boolean], [void], "nonpayable">
submitOwnershipTransferRequest: TypedContractMethod<[chainId_: BigNumberish, newOwner: AddressLike], [void], "nonpayable">
transferTokensWithRelay: TypedContractMethod<[token: AddressLike, amount: BigNumberish, toNativeTokenAmount: BigNumberish, targetChain: BigNumberish, targetRecipientWallet: BytesLike], [bigint], "payable">
updateFeeRecipient: TypedContractMethod<[chainId_: BigNumberish, newFeeRecipient: AddressLike], [void], "nonpayable">
updateMaxNativeSwapAmount: TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, maxAmount: BigNumberish], [void], "nonpayable">
updateNativeSwapRate: TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, swapRate: BigNumberish], [void], "nonpayable">
updateNativeSwapRatePrecision: TypedContractMethod<[chainId_: BigNumberish, nativeSwapRatePrecision_: BigNumberish], [void], "nonpayable">
updateOwnerAssistant: TypedContractMethod<[chainId_: BigNumberish, newAssistant: AddressLike], [void], "nonpayable">
updateRelayerFee: TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, amount: BigNumberish], [void], "nonpayable">
wormhole: TypedContractMethod<[], [string], "view">

Methods

  • Parameters

    • key: "AdminChanged"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "BeaconUpgraded"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "FeeRecipientUpdated"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "OwnershipTransfered"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SwapExecuted"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "SwapRateUpdated"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Parameters

    • key: "Upgraded"

    Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

  • Type Parameters

    • T extends ContractMethod<any[], any, any> = ContractMethod<any[], any, any>

    Parameters

    • key: string | FunctionFragment

    Returns T

  • Parameters

    • nameOrSignature: "VERSION"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "bytes32ToAddress"

    Returns TypedContractMethod<[address_: BytesLike], [string], "view">

  • Parameters

    • nameOrSignature: "calculateMaxSwapAmountIn"

    Returns TypedContractMethod<[token: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "calculateNativeSwapAmountOut"

    Returns TypedContractMethod<[token: AddressLike, toNativeAmount: BigNumberish], [bigint], "view">

  • Parameters

    • nameOrSignature: "cancelOwnershipTransferRequest"

    Returns TypedContractMethod<[chainId_: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "chainId"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "circleIntegration"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "confirmOwnershipTransferRequest"

    Returns TypedContractMethod<[], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "decodeTransferTokensWithRelay"

    Returns TypedContractMethod<[encoded: BytesLike], [TransferTokensWithRelayStructOutput], "view">

  • Parameters

    • nameOrSignature: "encodeTransferTokensWithRelay"

    Returns TypedContractMethod<[transfer: TransferTokensWithRelayStruct], [string], "view">

  • Parameters

    • nameOrSignature: "feeRecipient"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "getPaused"

    Returns TypedContractMethod<[], [boolean], "view">

  • Parameters

    • nameOrSignature: "getRegisteredContract"

    Returns TypedContractMethod<[emitterChainId: BigNumberish], [string], "view">

  • Parameters

    • nameOrSignature: "maxNativeSwapAmount"

    Returns TypedContractMethod<[token: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "nativeSwapRate"

    Returns TypedContractMethod<[token: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "nativeSwapRatePrecision"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "nativeTokenDecimals"

    Returns TypedContractMethod<[], [bigint], "view">

  • Parameters

    • nameOrSignature: "owner"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "ownerAssistant"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "pendingOwner"

    Returns TypedContractMethod<[], [string], "view">

  • Parameters

    • nameOrSignature: "redeemTokens"

    Returns TypedContractMethod<[redeemParams: RedeemParametersStruct], [void], "payable">

  • Parameters

    • nameOrSignature: "registerContract"

    Returns TypedContractMethod<[chainId_: BigNumberish, contractAddress: BytesLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "relayerFee"

    Returns TypedContractMethod<[chainId_: BigNumberish, token: AddressLike], [bigint], "view">

  • Parameters

    • nameOrSignature: "setPauseForTransfers"

    Returns TypedContractMethod<[chainId_: BigNumberish, paused: boolean], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "submitOwnershipTransferRequest"

    Returns TypedContractMethod<[chainId_: BigNumberish, newOwner: AddressLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "transferTokensWithRelay"

    Returns TypedContractMethod<[token: AddressLike, amount: BigNumberish, toNativeTokenAmount: BigNumberish, targetChain: BigNumberish, targetRecipientWallet: BytesLike], [bigint], "payable">

  • Parameters

    • nameOrSignature: "updateFeeRecipient"

    Returns TypedContractMethod<[chainId_: BigNumberish, newFeeRecipient: AddressLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateMaxNativeSwapAmount"

    Returns TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, maxAmount: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateNativeSwapRate"

    Returns TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, swapRate: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateNativeSwapRatePrecision"

    Returns TypedContractMethod<[chainId_: BigNumberish, nativeSwapRatePrecision_: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateOwnerAssistant"

    Returns TypedContractMethod<[chainId_: BigNumberish, newAssistant: AddressLike], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "updateRelayerFee"

    Returns TypedContractMethod<[chainId_: BigNumberish, token: AddressLike, amount: BigNumberish], [void], "nonpayable">

  • Parameters

    • nameOrSignature: "wormhole"

    Returns TypedContractMethod<[], [string], "view">

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • event: TCEvent

    Returns Promise<TypedListener<TCEvent>[]>

  • Parameters

    • Optional eventName: string

    Returns Promise<Listener[]>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • event: TCEvent
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

  • Type Parameters

    • TCEvent extends TypedContractEvent<any, any, any>

    Parameters

    • filter: TypedDeferredTopicFilter<TCEvent>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEventLog<TCEvent>[]>

Generated using TypeDoc