bitcoinjs-lib/test/integration/csv.js

/* global describe, it, before */

const assert = require('assert')
const bitcoin = require('../../')
const regtestUtils = require('./_regtest')
const regtest = regtestUtils.network
const bip68 = require('bip68')

const alice = bitcoin.ECPair.fromWIF('cScfkGjbzzoeewVWmU2hYPUHeVGJRDdFt7WhmrVVGkxpmPP8BHWe', regtest)
const bob = bitcoin.ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsLwjHXA9x', regtest)
const charles = bitcoin.ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMSb4Ubnf', regtest)
const dave = bitcoin.ECPair.fromWIF('cMkopUXKWsEzAjfa1zApksGRwjVpJRB3831qM9W4gKZsMwS4pqnx', regtest)

describe('bitcoinjs-lib (transactions w/ CSV)', function () {
  // force update MTP
  before(function (done) {
    regtestUtils.mine(11, done)
  })

  const hashType = bitcoin.Transaction.SIGHASH_ALL

  // IF MTP (from when confirmed) > seconds, aQ can redeem
  function csvCheckSigOutput (aQ, bQ, sequence) {
    return bitcoin.script.compile([
      /* eslint-disable indent */
      bitcoin.opcodes.OP_IF,
          bitcoin.script.number.encode(sequence),
          bitcoin.opcodes.OP_CHECKSEQUENCEVERIFY,
          bitcoin.opcodes.OP_DROP,
      bitcoin.opcodes.OP_ELSE,
          bQ.publicKey,
          bitcoin.opcodes.OP_CHECKSIGVERIFY,
      bitcoin.opcodes.OP_ENDIF,
      aQ.publicKey,
      bitcoin.opcodes.OP_CHECKSIG
      /* eslint-enable indent */
    ])
  }

  // 2 of 3 multisig of bQ, cQ, dQ,
  // but after sequence1 time, aQ can allow the multisig to become 1 of 3.
  // but after sequence2 time, aQ can sign for the output all by themself.
  // Ref: https://github.com/bitcoinbook/bitcoinbook/blob/f8b883dcd4e3d1b9adf40fed59b7e898fbd9241f/ch07.asciidoc#complex-script-example
  // Note: bitcoinjs-lib will not offer specific support for problems with
  //       advanced script usages such as below. Use at your own risk.
  function complexCsvOutput (aQ, bQ, cQ, dQ, sequence1, sequence2) {
    return bitcoin.script.compile([
      /* eslint-disable indent */
      bitcoin.opcodes.OP_IF,
          bitcoin.opcodes.OP_IF,
              bitcoin.opcodes.OP_2,
          bitcoin.opcodes.OP_ELSE,
              bitcoin.script.number.encode(sequence1),
              bitcoin.opcodes.OP_CHECKSEQUENCEVERIFY,
              bitcoin.opcodes.OP_DROP,
              aQ.publicKey,
              bitcoin.opcodes.OP_CHECKSIGVERIFY,
              bitcoin.opcodes.OP_1,
          bitcoin.opcodes.OP_ENDIF,
          bQ.publicKey,
          cQ.publicKey,
          dQ.publicKey,
          bitcoin.opcodes.OP_3,
          bitcoin.opcodes.OP_CHECKMULTISIG,
      bitcoin.opcodes.OP_ELSE,
          bitcoin.script.number.encode(sequence2),
          bitcoin.opcodes.OP_CHECKSEQUENCEVERIFY,
          bitcoin.opcodes.OP_DROP,
          aQ.publicKey,
          bitcoin.opcodes.OP_CHECKSIG,
      bitcoin.opcodes.OP_ENDIF
      /* eslint-enable indent */
    ])
  }

  // expiry will pass, {Alice's signature} OP_TRUE
  it('can create (and broadcast via 3PBP) a Transaction where Alice can redeem the output after the expiry (in the future) (simple CHECKSEQUENCEVERIFY)', function (done) {
    regtestUtils.height(function (err, height) {
      if (err) return done(err)

      // 5 blocks from now
      const sequence = bip68.encode({ blocks: 5 })
      const p2sh = bitcoin.payments.p2sh({
        redeem: {
          output: csvCheckSigOutput(alice, bob, sequence)
        },
        network: regtest
      })

      // fund the P2SH(CSV) address
      regtestUtils.faucet(p2sh.address, 1e5, function (err, unspent) {
        if (err) return done(err)

        const txb = new bitcoin.TransactionBuilder(regtest)
        txb.addInput(unspent.txId, unspent.vout, sequence)
        txb.addOutput(regtestUtils.RANDOM_ADDRESS, 7e4)

        // {Alice's signature} OP_TRUE
        const tx = txb.buildIncomplete()
        const signatureHash = tx.hashForSignature(0, p2sh.redeem.output, hashType)
        const redeemScriptSig = bitcoin.payments.p2sh({
          network: regtest,
          redeem: {
            network: regtest,
            output: p2sh.redeem.output,
            input: bitcoin.script.compile([
              bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
              bitcoin.opcodes.OP_TRUE
            ])
          }
        }).input
        tx.setInputScript(0, redeemScriptSig)

        // TODO: test that it failures _prior_ to expiry, unfortunately, race conditions when run concurrently
        // ...
        // into the future!
        regtestUtils.mine(10, function (err) {
          if (err) return done(err)

          regtestUtils.broadcast(tx.toHex(), function (err) {
            if (err) return done(err)

            regtestUtils.verify({
              txId: tx.getId(),
              address: regtestUtils.RANDOM_ADDRESS,
              vout: 0,
              value: 7e4
            }, done)
          })
        })
      })
    })
  })

  // expiry in the future, {Alice's signature} OP_TRUE
  it('can create (but fail to broadcast via 3PBP) a Transaction where Alice attempts to redeem before the expiry (simple CHECKSEQUENCEVERIFY)', function (done) {
    // two hours after confirmation
    const sequence = bip68.encode({ seconds: 7168 })
    const p2sh = bitcoin.payments.p2sh({
      network: regtest,
      redeem: {
        output: csvCheckSigOutput(alice, bob, sequence)
      }
    })

    // fund the P2SH(CSV) address
    regtestUtils.faucet(p2sh.address, 2e4, function (err, unspent) {
      if (err) return done(err)

      const txb = new bitcoin.TransactionBuilder(regtest)
      txb.addInput(unspent.txId, unspent.vout, sequence)
      txb.addOutput(regtestUtils.RANDOM_ADDRESS, 1e4)

      // {Alice's signature} OP_TRUE
      const tx = txb.buildIncomplete()
      const signatureHash = tx.hashForSignature(0, p2sh.redeem.output, hashType)
      const redeemScriptSig = bitcoin.payments.p2sh({
        network: regtest,
        redeem: {
          network: regtest,
          output: p2sh.redeem.output,
          input: bitcoin.script.compile([
            bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
            bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
            bitcoin.opcodes.OP_TRUE
          ])
        }
      }).input
      tx.setInputScript(0, redeemScriptSig)

      regtestUtils.broadcast(tx.toHex(), function (err) {
        assert.throws(function () {
          if (err) throw err
        }, /Error: 64: non-BIP68-final/)

        done()
      })
    })
  })

  // Check first combination of complex CSV, 2 of 3
  it('can create (and broadcast via 3PBP) a Transaction where Bob and Charles can send (complex CHECKSEQUENCEVERIFY)', function (done) {
    regtestUtils.height(function (err, height) {
      if (err) return done(err)

      // 2 blocks from now
      const sequence1 = bip68.encode({ blocks: 2 })
      // 5 blocks from now
      const sequence2 = bip68.encode({ blocks: 5 })
      const p2sh = bitcoin.payments.p2sh({
        redeem: {
          output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2)
        },
        network: regtest
      })

      // fund the P2SH(CCSV) address
      regtestUtils.faucet(p2sh.address, 1e5, function (err, unspent) {
        if (err) return done(err)

        const txb = new bitcoin.TransactionBuilder(regtest)
        txb.addInput(unspent.txId, unspent.vout)
        txb.addOutput(regtestUtils.RANDOM_ADDRESS, 7e4)

        // OP_0 {Bob sig} {Charles sig} OP_TRUE OP_TRUE
        const tx = txb.buildIncomplete()
        const signatureHash = tx.hashForSignature(0, p2sh.redeem.output, hashType)
        const redeemScriptSig = bitcoin.payments.p2sh({
          network: regtest,
          redeem: {
            network: regtest,
            output: p2sh.redeem.output,
            input: bitcoin.script.compile([
              bitcoin.opcodes.OP_0,
              bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
              bitcoin.script.signature.encode(charles.sign(signatureHash), hashType),
              bitcoin.opcodes.OP_TRUE,
              bitcoin.opcodes.OP_TRUE
            ])
          }
        }).input
        tx.setInputScript(0, redeemScriptSig)

        regtestUtils.broadcast(tx.toHex(), function (err) {
          if (err) return done(err)

          regtestUtils.verify({
            txId: tx.getId(),
            address: regtestUtils.RANDOM_ADDRESS,
            vout: 0,
            value: 7e4
          }, done)
        })
      })
    })
  })

  // Check first combination of complex CSV, mediator + 1 of 3 after 2 blocks
  it('can create (and broadcast via 3PBP) a Transaction where Alice (mediator) and Bob can send after 2 blocks (complex CHECKSEQUENCEVERIFY)', function (done) {
    regtestUtils.height(function (err, height) {
      if (err) return done(err)

      // 2 blocks from now
      const sequence1 = bip68.encode({ blocks: 2 })
      // 5 blocks from now
      const sequence2 = bip68.encode({ blocks: 5 })
      const p2sh = bitcoin.payments.p2sh({
        redeem: {
          output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2)
        },
        network: regtest
      })

      // fund the P2SH(CCSV) address
      regtestUtils.faucet(p2sh.address, 1e5, function (err, unspent) {
        if (err) return done(err)

        const txb = new bitcoin.TransactionBuilder(regtest)
        txb.addInput(unspent.txId, unspent.vout, sequence1) // Set sequence1 for input
        txb.addOutput(regtestUtils.RANDOM_ADDRESS, 7e4)

        // OP_0 {Bob sig} {Alice mediator sig} OP_FALSE OP_TRUE
        const tx = txb.buildIncomplete()
        const signatureHash = tx.hashForSignature(0, p2sh.redeem.output, hashType)
        const redeemScriptSig = bitcoin.payments.p2sh({
          network: regtest,
          redeem: {
            network: regtest,
            output: p2sh.redeem.output,
            input: bitcoin.script.compile([
              bitcoin.opcodes.OP_0,
              bitcoin.script.signature.encode(bob.sign(signatureHash), hashType),
              bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
              bitcoin.opcodes.OP_0,
              bitcoin.opcodes.OP_TRUE
            ])
          }
        }).input
        tx.setInputScript(0, redeemScriptSig)

        // Wait 2 blocks
        regtestUtils.mine(2, function (err) {
          if (err) return done(err)

          regtestUtils.broadcast(tx.toHex(), function (err) {
            if (err) return done(err)

            regtestUtils.verify({
              txId: tx.getId(),
              address: regtestUtils.RANDOM_ADDRESS,
              vout: 0,
              value: 7e4
            }, done)
          })
        })
      })
    })
  })

  // Check first combination of complex CSV, mediator after 5 blocks
  it('can create (and broadcast via 3PBP) a Transaction where Alice (mediator) can send after 5 blocks (complex CHECKSEQUENCEVERIFY)', function (done) {
    regtestUtils.height(function (err, height) {
      if (err) return done(err)

      // 2 blocks from now
      const sequence1 = bip68.encode({ blocks: 2 })
      // 5 blocks from now
      const sequence2 = bip68.encode({ blocks: 5 })
      const p2sh = bitcoin.payments.p2sh({
        redeem: {
          output: complexCsvOutput(alice, bob, charles, dave, sequence1, sequence2)
        },
        network: regtest
      })

      // fund the P2SH(CCSV) address
      regtestUtils.faucet(p2sh.address, 1e5, function (err, unspent) {
        if (err) return done(err)

        const txb = new bitcoin.TransactionBuilder(regtest)
        txb.addInput(unspent.txId, unspent.vout, sequence2) // Set sequence2 for input
        txb.addOutput(regtestUtils.RANDOM_ADDRESS, 7e4)

        // {Alice mediator sig} OP_FALSE
        const tx = txb.buildIncomplete()
        const signatureHash = tx.hashForSignature(0, p2sh.redeem.output, hashType)
        const redeemScriptSig = bitcoin.payments.p2sh({
          network: regtest,
          redeem: {
            network: regtest,
            output: p2sh.redeem.output,
            input: bitcoin.script.compile([
              bitcoin.script.signature.encode(alice.sign(signatureHash), hashType),
              bitcoin.opcodes.OP_0
            ])
          }
        }).input
        tx.setInputScript(0, redeemScriptSig)

        // Wait 5 blocks
        regtestUtils.mine(5, function (err) {
          if (err) return done(err)

          regtestUtils.broadcast(tx.toHex(), function (err) {
            if (err) return done(err)

            regtestUtils.verify({
              txId: tx.getId(),
              address: regtestUtils.RANDOM_ADDRESS,
              vout: 0,
              value: 7e4
            }, done)
          })
        })
      })
    })
  })
})