Receiving Payments

import { MnemonicIdentity, Wallet, waitForIncomingFunds } from '@arkade-os/sdk'
import { generateMnemonic } from '@scure/bip39'
import { wordlist } from '@scure/bip39/wordlists/english.js'

const mnemonic = generateMnemonic(wordlist)
const identity = MnemonicIdentity.fromMnemonic(mnemonic)

const wallet = await Wallet.create({
  identity,
  arkProvider: new RestArkProvider()
})

const arkadeAddress = await wallet.getAddress()

console.log('Arkade address:', arkadeAddress) // ark1qqellv77udfmr20tun8dvju5vgudpf9vxe8jwhthrkn26fz96pawqfdy8nk05rsmrf8h94j26905e7n6sng8y059z8ykn2j5xcuw4xt8ngt9rw

const incomingFunds = await waitForIncomingFunds(wallet)

if (incomingFunds.type === 'vtxo') {
  console.log('Received VTXOs:', incomingFunds.newVtxos)
}

if (incomingFunds.type === 'utxo') {
  console.log('Received boarding UTXOs:', incomingFunds.coins)
}

type IncomingFunds =
{
  type: "utxo";
  coins: Array<{
    txid: string;
    vout: number;
    value: number;
    status: {
      confirmed: boolean;
      // optional block hash, height, etc...
    };
  }>;
} |
{
  type: "vtxo";
  newVtxos: Array<{
    // same as utxo, but also includes:
    virtualStatus: {
      state: "preconfirmed" | "settled" | "swept" | "spent";
      // commitment tx ids, expiry, etc...
    };
    createdAt: Date;
    assets?: Array<{
      assetId: string;
      amount: number;
    }>;
    // misc taproot fields, extra witness, etc...
  }>;
  spentVtxos: Array<{
    // same as newVtxos[x]
  }>
}

// Example function to process incoming funds
async function processIncomingFunds(notification: IncomingFunds) {
  // Update your application state
  switch (notification.type) {
    case 'vtxo':
      for (const vtxo of notification.newVtxos) {
        console.log(`Received payment of ${vtxo.value} sats`);

        // You might want to store the VTXO in your database
        await storeVtxoInDatabase(vtxo);

        // Notify the user
        showNotification(`Received ${vtxo.value} sats!`);

        // Update the UI
        await refreshBalanceDisplay();
      }
      break;
    case 'utxo':
      // Coins received on boarding addresses (see Ramps documentation)
      for (const coin of notification.coins) {
        await storeBoardingUtxoInDatabase(coin)
        showNotification(`Received ${coin.value} sats on boarding address!`);
        await refreshBalanceDisplay();
      }
      break;
  }
}

// Start the subscription
const stop = await wallet.notifyIncomingFunds(processIncomingFunds)

// Stop the subscription when needed
stop()