Skip to main content

teleport-sdk.teleportbridge.initrelayedteleport

Home > teleport-sdk > TeleportBridge > initRelayedTeleport

TeleportBridge.initRelayedTeleport() method

Helper for initiating a relayed teleportation.

Signature:
initRelayedTeleport(receiverAddress: string, amount: BigNumberish, sender?: Signer, relayAddress?: string, overrides?: Overrides): Promise<Call>;

Parameters

ParameterTypeDescription
receiverAddressstringaddress that will receive tokens on the target domain
amountBigNumberishamount of tokens to teleport
senderSigner(Optional) address from which the tokens will be teleported
relayAddressstring(Optional) address of the relayer
overridesOverrides(Optional) ethers.js transaction overrides
Returns:

Promise<Call>

Remarks

Functionally identical to initTeleport(), but filling out the operatorAddress with a relayer's known address.