bch-js/test/unit/slp-tokentype1.js

/*
  Unit tests for the TokenType1 library.
*/

const assert = require("chai").assert
const nock = require("nock") // http call mocking
const sinon = require("sinon")
// const axios = require("axios")

// Default to unit tests unless some other value for TEST is passed.
if (!process.env.TEST) process.env.TEST = "unit"
// const SERVER = bchjs.restURL

const BCHJS = require("../../src/bch-js")
const bchjs = new BCHJS()

// Mock data used for unit tests
// const mockData = require("./fixtures/slp/mock-utils")

// Default to unit tests unless some other value for TEST is passed.
if (!process.env.TEST) process.env.TEST = "unit"

describe("#SLP TokenType1", () => {
  let sandbox

  beforeEach(() => {
    // Activate nock if it's inactive.
    if (!nock.isActive()) nock.activate()

    sandbox = sinon.createSandbox()
  })

  afterEach(() => {
    // Clean up HTTP mocks.
    nock.cleanAll() // clear interceptor list.
    nock.restore()

    sandbox.restore()
  })

  // CT 5/31/2020 This is old code for the older version of generateSendOpReturn()
  // This code can be delete in a couple weeks once things are stable.
  //
  // describe("#generateSendOpReturn", () => {
  //   it("should generate send OP_RETURN code", async () => {
  //     // Mock UTXO.
  //     const tokenUtxos = [
  //       {
  //         txid:
  //           "a8eb788b8ddda6faea00e6e2756624b8feb97655363d0400dd66839ea619d36e",
  //         vout: 2,
  //         value: "546",
  //         confirmations: 0,
  //         satoshis: 546,
  //         utxoType: "token",
  //         transactionType: "send",
  //         tokenId:
  //           "497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7",
  //         tokenTicker: "TOK-CH",
  //         tokenName: "TokyoCash",
  //         tokenDocumentUrl: "",
  //         tokenDocumentHash: "",
  //         decimals: 8,
  //         tokenQty: 7
  //       }
  //     ]
  //
  //     const result = await bchjs.SLP.TokenType1.generateSendOpReturn(
  //       tokenUtxos,
  //       1
  //     )
  //     console.log(`result: ${JSON.stringify(result, null, 2)}`)
  //
  //     assert.hasAllKeys(result, ["script", "outputs"])
  //     assert.isNumber(result.outputs)
  //   })
  //
  //   it("should handle problematic configuration", async () => {
  //     // Mock UTXO.
  //     const tokenUtxos = [
  //       {
  //         txid:
  //           "0bd6b874246202b4cbc2f501419a5ce6f9b01e8ba9521298afd15c7e8eac5951",
  //         vout: 2,
  //         value: "546",
  //         confirmations: 0,
  //         satoshis: 546,
  //         utxoType: "token",
  //         transactionType: "send",
  //         tokenId:
  //           "155784a206873c98acc09e8dabcccf6abf13c4c14d8662190534138a16bb93ce",
  //         tokenTicker: "PSF",
  //         tokenName: "PSF Testnet Token",
  //         tokenDocumentUrl: "",
  //         tokenDocumentHash: "",
  //         decimals: 8,
  //         tokenQty: 18004.71169917
  //       }
  //     ]
  //
  //     const result = await bchjs.SLP.TokenType1.generateSendOpReturn(
  //       tokenUtxos,
  //       5000
  //     )
  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
  //     console.log(`result.script: `, result.script)
  //     console.log(`result.script: `, result.script.toString("hex"))
  //
  //     // This transaction failed due to a floating point error. This is expressed
  //     // by the script[6] being length 2 (incorrect) instead of 8 (correct).
  //     assert.equal(result.script[5].length, 8)
  //     assert.equal(result.script[6].length, 8)
  //   })
  //
  //   it("should generate good OP_RETURN for problematic TX", () => {
  //     const utxo1 = {
  //       txid:
  //         "35287aa2aa7d3f1954fbbcb8a748d8773359b4f2771a851959a4a6116bcb552c",
  //       vout: 1,
  //       amount: 0.00000546,
  //       satoshis: 546,
  //       legacyAddress: "1MuLZ9LzLSTKioBHoPzeSfFANTEN2CZhuS",
  //       cashAddress: "bitcoincash:qrj5sala6z53v559q54mekexru2xe34yrquhmpy5kx",
  //       tokenId:
  //         "c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca479",
  //       decimals: 2,
  //       tokenQty: 1371.6
  //     }
  //
  //     const utxo2 = {
  //       txid:
  //         "cb652ce62babc81936f0f1e1d5b80102cb44de99dece83f4bbd34cfaeef744b0",
  //       vout: 2,
  //       amount: 0.00000546,
  //       satoshis: 546,
  //       legacyAddress: "1LzjkvDVB16k6kcSz8hZodW9KPP2zxwmGh",
  //       cashAddress: "bitcoincash:qrd4tj48lpf0wv36qt5mkd6c3n4h5xcfgqqw77s63d",
  //       tokenId:
  //         "c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca479",
  //       decimals: 2,
  //       tokenQty: 3250.75
  //     }
  //
  //     const utxos = [utxo1, utxo2]
  //
  //     const { script } = bchjs.SLP.TokenType1.generateSendOpReturn(utxos, 1400)
  //
  //     // console.log(`script: `, script)
  //     // console.log(`outputs: `, outputs)
  //
  //     // console.log(`script[6]: ${script[6].toString("hex")}`)
  //     // console.log(`script[6].length: ${script[6].length}`)
  //
  //     // This transaction failed due to a floating point error. This is expressed
  //     // by the script[6] being length 2 (incorrect) instead of 8 (correct).
  //     assert.equal(script[6].length, 8)
  //   })
  // })

  describe("#generateSendOpReturn", () => {
    it("should generate send OP_RETURN code", async () => {
      // Mock UTXO.
      const tokenUtxos = [
        {
          txid:
            "a8eb788b8ddda6faea00e6e2756624b8feb97655363d0400dd66839ea619d36e",
          vout: 2,
          value: "546",
          confirmations: 0,
          satoshis: 546,
          utxoType: "token",
          transactionType: "send",
          tokenId:
            "497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7",
          tokenTicker: "TOK-CH",
          tokenName: "TokyoCash",
          tokenDocumentUrl: "",
          tokenDocumentHash: "",
          decimals: 8,
          tokenQty: 7
        }
      ]

      const result = await bchjs.SLP.TokenType1.generateSendOpReturn(
        tokenUtxos,
        1
      )
      // console.log(`result: ${JSON.stringify(result, null, 2)}`)

      assert.hasAllKeys(result, ["script", "outputs"])
      assert.isNumber(result.outputs)
    })
  })

  describe("#generateBurnOpReturn", () => {
    it("should generate burn OP_RETURN code", async () => {
      // Mock UTXO.
      const tokenUtxos = [
        {
          txid:
            "a8eb788b8ddda6faea00e6e2756624b8feb97655363d0400dd66839ea619d36e",
          vout: 2,
          value: "546",
          confirmations: 0,
          satoshis: 546,
          utxoType: "token",
          transactionType: "send",
          tokenId:
            "497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7",
          tokenTicker: "TOK-CH",
          tokenName: "TokyoCash",
          tokenDocumentUrl: "",
          tokenDocumentHash: "",
          decimals: 8,
          tokenQty: 7
        }
      ]

      const result = await bchjs.SLP.TokenType1.generateBurnOpReturn(
        tokenUtxos,
        1
      )
      // console.log(`result: ${JSON.stringify(result, null, 2)}`)

      assert.isArray(result)
    })
  })

  describe("#generateGenesisOpReturn", () => {
    it("should generate genesis OP_RETURN code", async () => {
      const configObj = {
        name: "SLP Test Token",
        ticker: "SLPTEST",
        documentUrl: "https://bchjs.cash",
        decimals: 8,
        initialQty: 10
      }

      const result = await bchjs.SLP.TokenType1.generateGenesisOpReturn(
        configObj
      )

      assert.isArray(result)
      assert.equal(Buffer.isBuffer(result[1]), true)
    })
  })
})