Track a transfer - BRDG

Before you start

The TypeScript project.
A transferId from buildTransfer.

Script

Save this as src/track-a-transfer.ts and run npx tsx src/track-a-transfer.ts <transferId>.

src/track-a-transfer.ts

import { createClient, isTerminalStatus } from '@kernlog/brdg-sdk';

const brdg = createClient();

async function main(transferId: string) {
  // Read the transfer once
  const transfer = await brdg.getTransfer(transferId);
  console.log(transfer.status, transfer.sourceTxHash, transfer.destinationTxHash);

  if (isTerminalStatus(transfer.status)) return;

  // Or poll until it finishes. By default the SDK polls every 3 seconds for up to 20 minutes.
  const done = await brdg.waitForTransfer(transferId, {
    intervalMs: 5_000,
    onUpdate: (t) => console.log(new Date().toISOString(), t.status, t.statusDetail ?? ''),
  });
  console.log(done.status, done.receivedAmountAtomic, done.receivedAsset);
}

main(process.argv[2]!).catch((e) => { console.error(e); process.exit(1); });

Statuses

The last five statuses in this table are final: the transfer will not change again.

`status`	Meaning
`PENDING_SIGNATURE`	Built, but no transaction has been submitted yet.
`SUBMITTED`	The source transaction was sent.
`PENDING`	The venue has seen the transaction and is processing it.
`NEEDS_ACTION`	The user has to do something, such as claim the funds. `statusDetail` explains what.
`UNKNOWN`	The venue’s response could not be interpreted yet. BRDG keeps checking.
`COMPLETED`	Delivered.
`PARTIAL`	Something arrived, but only part of the amount or in a different token. Check `receivedAsset` and `receivedAmountAtomic`, and do not send again.
`REFUNDED`	The funds were returned to the sender or refund address.
`FAILED`	The transfer did not go through. If `sourceTxHash` is `null`, nothing left the wallet. If it is set, check `sourceTxVerification` and contact the venue.
`ABANDONED`	The venue never gave a final answer and BRDG stopped checking. This says nothing about the funds; contact the venue using `venueSupport`.

Anyone with a transfer id can read the transfer. Ids are random UUIDs and cannot be guessed. BRDG never retries a transfer on its own. If the outcome is unclear, do not send the funds again until it is resolved, or one transfer can turn into two.

Endpoints used

SDK	Endpoint
`getTransfer`, `waitForTransfer`	`GET /bridge/transfers/{id}`