two-token-receiver-pays-fees.js

/*
  E2E test for sweeping a two token classes and paying for tx fees with the
  receiver wallet. e.g. the paper wallet has two token classes but no BCH.

  Before running the test, this test will check that each wallet is set up correctly.
  If they are not set up correctly, the test will exit and indicate what is wrong
  with the set-up for the test.
*/

// These are the WIF (private keys) used to operate the test.
const paperWif = 'L3oM4q4tNUZkT3gHZJkw4Rt6nYWveUNeZZudG82zLJVmaauRAgkj'
const receiverWif = 'KzSwx57BYjZEekjGPH9sWpivShkqgGxV41zmkNYbCEgxdwPzhKJo'

const BCHJS = require('@psf/bch-js')
const bchjs = new BCHJS()

// Unit under test
const SweeperLib = require('../../index')

async function runTest () {
  try {
    // Instancing the library
    const sweeperLib = new SweeperLib(paperWif, receiverWif, bchjs)
    await sweeperLib.populateObjectFromNetwork()

    await checkSetup(sweeperLib)

    const hex = await sweeperLib.sweepTo(sweeperLib.receiver.slpAddr)
    // console.log(`hex: ${hex}`)

    const txid = await sweeperLib.blockchain.broadcast(hex)

    console.log('Transaction ID', txid)
    console.log(`https://explorer.bitcoin.com/bch/tx/${txid}`)
  } catch (error) {
    console.error('Error in test: ', error)
  }
}
runTest()

// Check to ensure the test is set up correctly.
async function checkSetup (sweeperLib) {
  // console.log(
  //   `receiving wallet BCH UTXOs: ${JSON.stringify(
  //     sweeperLib.UTXOsFromPaperWallet.bchUTXOs,
  //     null,
  //     2
  //   )}`
  // )
  // Ensure the Receiver has a UTXO.
  if (sweeperLib.UTXOsFromReceiver.bchUTXOs.length === 0) {
    throw new Error(
      `Receiver wallet does not have BCH. Send 0.00005 BCH to ${
        sweeperLib.receiver.bchAddr
      }`
    )
  }

  // Ensure the Receiver has enough BCH to pay transaction fees.
  console.log(`Receiver wallet balance: ${sweeperLib.BCHBalanceFromReceiver}`)
  if (sweeperLib.BCHBalanceFromReceiver < 5000) {
    throw new Error(
      `Paper wallet has less than 0.00005 BCH. Send that much to pay for transaction fees to ${
        sweeperLib.receiver.bchAddr
      }`
    )
  }

  // console.log(
  //   `paper wallet SLP UTXOs: ${JSON.stringify(
  //     sweeperLib.UTXOsFromPaperWallet.tokenUTXOs,
  //     null,
  //     2
  //   )}`
  // )
  if (sweeperLib.UTXOsFromPaperWallet.tokenUTXOs.length === 0) {
    throw new Error(
      `Paper wallet does not have any tokens! Send some SLP tokens to ${
        sweeperLib.paper.slpAddr
      }`
    )
  }

  // Get a list of token IDs contained in the paper wallet.
  const tokenIds = sweeperLib.getTokenIds(
    sweeperLib.UTXOsFromPaperWallet.tokenUTXOs
  )
  if (tokenIds.length < 2) {
    throw new Error(
      `Paper wallet has less than two token classes. Send more tokens to ${
        sweeperLib.paper.slpAddr
      }`
    )
  }

  console.log('Tokens found on paper wallet. Test is good to go!')
  console.log(' ')
}