revertCrosschainTransfer

revertCrosschainTransfer(
    connection: Connection,
    pendingTransfer: TransferRef,
): Web3PromiEvent<void, { hop: HopData }>

Reverts a cross chain transfer that has timed out. I.e., returns the asset back to the sender account after the transfer failed to be completed before the timeout. If the transfer has reached its final destination but you want to recall it, use recallUnclaimedCrosschainTransfer

Parameters

• connection: Connection

  connection to the source chain. I.e., the chain where the account that originally sent the assets are registered.

• pendingTransfer: TransferRef

  the transfer to revert. Can be acquired using getPendingCrosschainTransfers

Returns Web3PromiEvent<void, { hop: HopData }>

a promi-event that will emit once for each hop during the revert. It will resolve once the transfer is completely reverted.

Remarks

If this function is called before the transfer has timed out, the promise will be rejected