teleport-sdk.teleportbridge.initteleport
Home > teleport-sdk > TeleportBridge > initTeleport
TeleportBridge.initTeleport() method
Initiate manual token teleportation
Signature:initTeleport(receiverAddress: string, amount: BigNumberish, operatorAddress?: string, sender?: Signer, overrides?: Overrides): Promise<Call>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| receiverAddress | string | address that will receive tokens on the target domain |
| amount | BigNumberish | amount of tokens to teleport |
| operatorAddress | string | (Optional) address that can relay the mint request on the target domain |
| sender | Signer | (Optional) address from which the tokens will be taken on the source domain |
| overrides | Overrides | (Optional) ethers.js transaction overrides |
Promise<Call>
Promise containing the call to the Teleport contracts
Remarks
This call assumes that the token allowance for the gateway has already been set to the appropriate value before initiating a token teleportation.