teleport-sdk.signandcreaterelaytask

Home > teleport-sdk > signAndCreateRelayTask

signAndCreateRelayTask() function

Relay a Teleport transaction and wait for the relayer to confirm its execution

Signature:

export declare function signAndCreateRelayTask(relay: Relay, receiver: Signer, teleportGUID: TeleportGUID, signatures: string, relayFee: BigNumberish, maxFeePercentage?: BigNumberish, expiry?: BigNumberish, to?: string, data?: string, onPayloadSigned?: (payload: string, r: string, s: string, v: number) => void): Promise<string>;

Parameters

Parameter	Type	Description
relay	Relay	Relay to use
receiver	Signer	address that will receive tokens on the target domain
teleportGUID	TeleportGUID	identifier for the teleport action.
signatures	string	deposit attestations obtained from the oracle network
relayFee	BigNumberish	fee to be paid to the relayer
maxFeePercentage	BigNumberish	(Optional) maximum fee approved by the user
expiry	BigNumberish	(Optional) expiration date of the operation
to	string	(Optional) address to call after tokens are minted
data	string	(Optional) data to call to with
onPayloadSigned	(payload: string, r: string, s: string, v: number) => void	(Optional) callback

Returns:

Promise<string>

Promise containing the relayed transaction's hash