Interface IVtxoManager

Example

const wallet = await Wallet.create({
  identity,
  arkProvider: new RestArkProvider(),
  settlementConfig: {
     // Seconds before virtual output expiry to trigger renewal
     vtxoThreshold: 259_200, // 3 days
     // Whether to sweep expired boarding inputs back to a fresh boarding address
     boardingUtxoSweep: true,
     // Polling interval in milliseconds for checking boarding inputs
     pollIntervalMs: 60_000 // 1 minute
 },
});
const manager = await wallet.getVtxoManager();

// Check recoverable balance
const balance = await manager.getRecoverableBalance();
if (balance.recoverable > 0n) {
  console.log(`Can recover ${balance.recoverable} sats`);
  const txid = await manager.recoverVtxos();
}

// Check for expiring virtual outputs
const expiring = await manager.getExpiringVtxos();
if (expiring.length > 0) {
  console.log(`${expiring.length} virtual outputs expiring soon`);
  const txid = await manager.renewVtxos();
}
Copy