Function recallUnclaimedCrosschainTransfer

  • Does almost the same thing as revertCrosschainTransfer but while that function works on transfers that were not delivered to the target chain, this function is used if the assets were successfully delivered to the target chain but not claimed by an account. This will only happen when the target chain has create on transfer account registration strategy enabled and no one claims the target account in time.

    Parameters

    • connection: Connection

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

    • authenticator: Authenticator

      authenticator that will be used when recalling the transfer. Should likely be the same authenticator which was used to initiate the transfer

    • pendingTransfer: TransferRef

      the transfer to recall. Can be acquired using getPendingCrosschainTransfers

    Returns Web3PromiEvent<void, {
        hop: Buffer;
    }>

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

    Remarks

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