teleport-sdk.teleportbridge.requestrelay

Home > teleport-sdk > TeleportBridge > requestRelay

TeleportBridge.requestRelay() method

Request a transaction relay from a relayer

Signature:

requestRelay(receiver: Signer, teleportGUID: TeleportGUID, signatures: string, relayFee: BigNumberish, maxFeePercentage?: BigNumberish, expiry?: BigNumberish, to?: string, data?: string, relayAddress?: string, onPayloadSigned?: (payload: string, r: string, s: string, v: number) => void): Promise<string>;

Parameters

Parameter	Type	Description
receiver	Signer	receiver of the finds
teleportGUID	TeleportGUID
signatures	string	set of oracle attestations
relayFee	BigNumberish	fee to be paid to the relayer
maxFeePercentage	BigNumberish	(Optional) maximum fee specified by the user
expiry	BigNumberish	(Optional) expiration date of the teleportation action
to	string	(Optional) extra call receiver
data	string	(Optional) extra call data
relayAddress	string	(Optional) address of the relayer
onPayloadSigned	(payload: string, r: string, s: string, v: number) => void	(Optional) callback

Returns:

Promise<string>

promise containing relay task ID