psf-bch-api 1.1.0 → 1.3.0

package/test/unit/use-cases/full-node-dsproof-use-cases-unit.js

@@ -0,0 +1,54 @@
+/*
+  Unit tests for DSProofUseCases.
+*/
+
+import { assert } from 'chai'
+
+import DSProofUseCases from '../../../src/use-cases/full-node-dsproof-use-cases.js'
+
+describe('#full-node-dsproof-use-cases.js', () => {
+  let mockAdapters
+  let uut
+
+  beforeEach(() => {
+    mockAdapters = {
+      fullNode: {
+        call: async () => ({})
+      }
+    }
+
+    uut = new DSProofUseCases({ adapters: mockAdapters })
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new DSProofUseCases()
+      }, /Adapters instance required/)
+    })
+
+    it('should require full node adapter', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new DSProofUseCases({ adapters: {} })
+      }, /Full node adapter required/)
+    })
+  })
+
+  describe('#getDSProof()', () => {
+    it('should pass txid and verbose parameters to adapter', async () => {
+      let capturedArgs = null
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedArgs = { method, params }
+        return { success: true }
+      }
+
+      const result = await uut.getDSProof({ txid: 'a'.repeat(64), verbose: 2 })
+
+      assert.equal(capturedArgs.method, 'getdsproof')
+      assert.deepEqual(capturedArgs.params, ['a'.repeat(64), 2])
+      assert.deepEqual(result, { success: true })
+    })
+  })
+})

package/test/unit/use-cases/full-node-mining-use-cases-unit.js

@@ -0,0 +1,84 @@
+/*
+  Unit tests for MiningUseCases.
+*/
+
+import { assert } from 'chai'
+
+import MiningUseCases from '../../../src/use-cases/full-node-mining-use-cases.js'
+
+describe('#full-node-mining-use-cases.js', () => {
+  let mockAdapters
+  let uut
+
+  beforeEach(() => {
+    mockAdapters = {
+      fullNode: {
+        call: async () => ({})
+      }
+    }
+
+    uut = new MiningUseCases({ adapters: mockAdapters })
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new MiningUseCases()
+      }, /Adapters instance required/)
+    })
+
+    it('should require full node adapter', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new MiningUseCases({ adapters: {} })
+      }, /Full node adapter required/)
+    })
+  })
+
+  describe('#getMiningInfo()', () => {
+    it('should call full node adapter with correct method', async () => {
+      let capturedMethod = ''
+      mockAdapters.fullNode.call = async method => {
+        capturedMethod = method
+        return { blocks: 100, difficulty: 1.5 }
+      }
+
+      const result = await uut.getMiningInfo()
+
+      assert.equal(capturedMethod, 'getmininginfo')
+      assert.deepEqual(result, { blocks: 100, difficulty: 1.5 })
+    })
+  })
+
+  describe('#getNetworkHashPS()', () => {
+    it('should call full node adapter with correct method and default params', async () => {
+      let capturedMethod = ''
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedMethod = method
+        capturedParams = params
+        return 1234567890
+      }
+
+      const result = await uut.getNetworkHashPS({ nblocks: 120, height: -1 })
+
+      assert.equal(capturedMethod, 'getnetworkhashps')
+      assert.deepEqual(capturedParams, [120, -1])
+      assert.equal(result, 1234567890)
+    })
+
+    it('should call full node adapter with custom params', async () => {
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedParams = params
+        return 9876543210
+      }
+
+      const result = await uut.getNetworkHashPS({ nblocks: 240, height: 1000 })
+
+      assert.deepEqual(capturedParams, [240, 1000])
+      assert.equal(result, 9876543210)
+    })
+  })
+})

package/test/unit/use-cases/full-node-rawtransactions-use-cases-unit.js

@@ -0,0 +1,267 @@
+/*
+  Unit tests for RawTransactionsUseCases.
+*/
+
+import { assert } from 'chai'
+
+import RawTransactionsUseCases from '../../../src/use-cases/full-node-rawtransactions-use-cases.js'
+
+describe('#full-node-rawtransactions-use-cases.js', () => {
+  let mockAdapters
+  let uut
+
+  beforeEach(() => {
+    mockAdapters = {
+      fullNode: {
+        call: async () => ({})
+      }
+    }
+
+    uut = new RawTransactionsUseCases({ adapters: mockAdapters })
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new RawTransactionsUseCases()
+      }, /Adapters instance required/)
+    })
+
+    it('should require full node adapter', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new RawTransactionsUseCases({ adapters: {} })
+      }, /Full node adapter required/)
+    })
+  })
+
+  describe('#decodeRawTransaction()', () => {
+    it('should call full node adapter with correct method', async () => {
+      let capturedMethod = ''
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedMethod = method
+        capturedParams = params
+        return { txid: 'abc123', version: 2 }
+      }
+
+      const result = await uut.decodeRawTransaction({ hex: '01000000' })
+
+      assert.equal(capturedMethod, 'decoderawtransaction')
+      assert.deepEqual(capturedParams, ['01000000'])
+      assert.deepEqual(result, { txid: 'abc123', version: 2 })
+    })
+  })
+
+  describe('#decodeRawTransactions()', () => {
+    it('should call full node adapter for each hex in parallel', async () => {
+      const callCount = { count: 0 }
+      mockAdapters.fullNode.call = async (method, params) => {
+        callCount.count++
+        return { txid: `tx${callCount.count}`, hex: params[0] }
+      }
+
+      const hexes = ['hex1', 'hex2', 'hex3']
+      const result = await uut.decodeRawTransactions({ hexes })
+
+      assert.equal(callCount.count, 3)
+      assert.equal(result.length, 3)
+      assert.equal(result[0].txid, 'tx1')
+      assert.equal(result[1].txid, 'tx2')
+      assert.equal(result[2].txid, 'tx3')
+    })
+  })
+
+  describe('#decodeScript()', () => {
+    it('should call full node adapter with correct method', async () => {
+      let capturedMethod = ''
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedMethod = method
+        capturedParams = params
+        return { asm: 'OP_DUP OP_HASH160', type: 'pubkeyhash' }
+      }
+
+      const result = await uut.decodeScript({ hex: '76a914' })
+
+      assert.equal(capturedMethod, 'decodescript')
+      assert.deepEqual(capturedParams, ['76a914'])
+      assert.deepEqual(result, { asm: 'OP_DUP OP_HASH160', type: 'pubkeyhash' })
+    })
+  })
+
+  describe('#decodeScripts()', () => {
+    it('should call full node adapter for each hex in parallel', async () => {
+      const callCount = { count: 0 }
+      mockAdapters.fullNode.call = async (method, params) => {
+        callCount.count++
+        return { asm: `script${callCount.count}`, hex: params[0] }
+      }
+
+      const hexes = ['script1', 'script2']
+      const result = await uut.decodeScripts({ hexes })
+
+      assert.equal(callCount.count, 2)
+      assert.equal(result.length, 2)
+    })
+  })
+
+  describe('#getRawTransaction()', () => {
+    it('should call full node adapter with verbose=false by default', async () => {
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedParams = params
+        return '01000000'
+      }
+
+      await uut.getRawTransaction({ txid: 'abc123' })
+
+      assert.deepEqual(capturedParams, ['abc123', 0])
+    })
+
+    it('should call full node adapter with verbose=true when specified', async () => {
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedParams = params
+        return { txid: 'abc123', version: 2 }
+      }
+
+      await uut.getRawTransaction({ txid: 'abc123', verbose: true })
+
+      assert.deepEqual(capturedParams, ['abc123', 1])
+    })
+  })
+
+  describe('#getRawTransactions()', () => {
+    it('should call full node adapter for each txid in parallel', async () => {
+      const callCount = { count: 0 }
+      mockAdapters.fullNode.call = async (method, params) => {
+        callCount.count++
+        return { txid: params[0], version: 2 }
+      }
+
+      const txids = ['tx1', 'tx2']
+      const result = await uut.getRawTransactions({ txids, verbose: true })
+
+      assert.equal(callCount.count, 2)
+      assert.equal(result.length, 2)
+    })
+  })
+
+  describe('#getRawTransactionWithHeight()', () => {
+    it('should return transaction without height when verbose=false', async () => {
+      mockAdapters.fullNode.call = async (method, params) => {
+        if (method === 'getrawtransaction') {
+          return '01000000'
+        }
+        return {}
+      }
+
+      const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: false })
+
+      assert.equal(result, '01000000')
+    })
+
+    it('should fetch and append height when verbose=true and blockhash exists', async () => {
+      let callCount = 0
+      mockAdapters.fullNode.call = async (method, params) => {
+        callCount++
+        if (method === 'getrawtransaction') {
+          return { txid: 'abc123', blockhash: 'block123' }
+        }
+        if (method === 'getblockheader') {
+          return { height: 100, hash: 'block123' }
+        }
+        return {}
+      }
+
+      const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: true })
+
+      assert.equal(callCount, 2)
+      assert.equal(result.height, 100)
+      assert.equal(result.txid, 'abc123')
+    })
+
+    it('should handle block header lookup failure gracefully', async () => {
+      let callCount = 0
+      mockAdapters.fullNode.call = async (method, params) => {
+        callCount++
+        if (method === 'getrawtransaction') {
+          return { txid: 'abc123', blockhash: 'block123' }
+        }
+        if (method === 'getblockheader') {
+          throw new Error('Block not found')
+        }
+        return {}
+      }
+
+      const result = await uut.getRawTransactionWithHeight({ txid: 'abc123', verbose: true })
+
+      assert.equal(callCount, 2)
+      assert.isNull(result.height)
+      assert.equal(result.txid, 'abc123')
+    })
+  })
+
+  describe('#getBlockHeader()', () => {
+    it('should call full node adapter with correct method', async () => {
+      let capturedMethod = ''
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedMethod = method
+        capturedParams = params
+        return { height: 100, hash: 'block123' }
+      }
+
+      const result = await uut.getBlockHeader({ blockHash: 'block123', verbose: true })
+
+      assert.equal(capturedMethod, 'getblockheader')
+      assert.deepEqual(capturedParams, ['block123', true])
+      assert.deepEqual(result, { height: 100, hash: 'block123' })
+    })
+  })
+
+  describe('#sendRawTransaction()', () => {
+    it('should call full node adapter with correct method', async () => {
+      let capturedMethod = ''
+      let capturedParams = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        capturedMethod = method
+        capturedParams = params
+        return 'txid123'
+      }
+
+      const result = await uut.sendRawTransaction({ hex: '01000000' })
+
+      assert.equal(capturedMethod, 'sendrawtransaction')
+      assert.deepEqual(capturedParams, ['01000000'])
+      assert.equal(result, 'txid123')
+    })
+  })
+
+  describe('#sendRawTransactions()', () => {
+    it('should send transactions serially, not in parallel', async () => {
+      const callOrder = []
+      mockAdapters.fullNode.call = async (method, params) => {
+        callOrder.push(params[0])
+        // Simulate some async work
+        await new Promise(resolve => setTimeout(resolve, 10))
+        return `txid-${params[0]}`
+      }
+
+      const hexes = ['hex1', 'hex2', 'hex3']
+      const startTime = Date.now()
+      const result = await uut.sendRawTransactions({ hexes })
+      const endTime = Date.now()
+
+      // Should take at least 30ms if serial (3 * 10ms)
+      assert.isAtLeast(endTime - startTime, 25)
+      assert.deepEqual(callOrder, ['hex1', 'hex2', 'hex3'])
+      assert.equal(result.length, 3)
+      assert.equal(result[0], 'txid-hex1')
+      assert.equal(result[1], 'txid-hex2')
+      assert.equal(result[2], 'txid-hex3')
+    })
+  })
+})

package/test/unit/use-cases/slp-use-cases-unit.js

@@ -0,0 +1,296 @@
+/*
+  Unit tests for SlpUseCases.
+*/
+
+import { assert } from 'chai'
+import sinon from 'sinon'
+import BCHJS from '@psf/bch-js'
+
+import SlpUseCases from '../../../src/use-cases/slp-use-cases.js'
+
+describe('#slp-use-cases.js', () => {
+  let sandbox
+  let mockAdapters
+  let mockConfig
+  let uut
+  let mockBchjs
+  let mockWallet
+  let mockSlpTokenMedia
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+    mockConfig = {
+      restURL: 'http://localhost:3000/v5/',
+      ipfsGateway: 'p2wdb-gateway-678.fullstack.cash'
+    }
+
+    mockAdapters = {
+      slpIndexer: {
+        get: sandbox.stub().resolves({}),
+        post: sandbox.stub().resolves({})
+      }
+    }
+
+    // Create mock BCHJS
+    mockBchjs = new BCHJS()
+    mockBchjs.Electrumx = {
+      txData: sandbox.stub().resolves({
+        details: {
+          vout: [
+            {
+              scriptPubKey: {
+                hex: '6a0c48656c6c6f20576f726c6421'
+              }
+            }
+          ]
+        }
+      })
+    }
+    mockBchjs.Script = {
+      toASM: sandbox.stub().returns('OP_RETURN 48656c6c6f20576f726c6421')
+    }
+
+    // Create mock wallet
+    mockWallet = {
+      walletInfoPromise: Promise.resolve(),
+      getTransactions: sandbox.stub().resolves([]),
+      getTxData: sandbox.stub().resolves([{
+        vin: [{
+          address: 'bitcoincash:test123'
+        }]
+      }])
+    }
+
+    // Create mock SlpTokenMedia
+    mockSlpTokenMedia = {
+      getIcon: sandbox.stub().resolves({ tokenIcon: 'test-icon.png' })
+    }
+
+    // Mock the imports
+    uut = new SlpUseCases({
+      adapters: mockAdapters,
+      bchjs: mockBchjs,
+      config: mockConfig
+    })
+
+    // Replace the wallet initialization with our mocks
+    uut.wallet = mockWallet
+    uut.slpTokenMedia = mockSlpTokenMedia
+    uut.walletInitialized = true
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new SlpUseCases()
+      }, /Adapters instance required/)
+    })
+
+    it('should require slpIndexer adapter', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new SlpUseCases({ adapters: {} })
+      }, /SLP Indexer adapter required/)
+    })
+  })
+
+  describe('#getStatus()', () => {
+    it('should call slpIndexer adapter get method', async () => {
+      mockAdapters.slpIndexer.get.resolves({ status: 'ok' })
+
+      const result = await uut.getStatus()
+
+      assert.isTrue(mockAdapters.slpIndexer.get.calledOnceWith('slp/status/'))
+      assert.deepEqual(result, { status: 'ok' })
+    })
+  })
+
+  describe('#getAddress()', () => {
+    it('should call slpIndexer adapter post method', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      mockAdapters.slpIndexer.post.resolves({ balance: 1000 })
+
+      const result = await uut.getAddress({ address })
+
+      assert.isTrue(
+        mockAdapters.slpIndexer.post.calledOnceWith('slp/address/', { address })
+      )
+      assert.deepEqual(result, { balance: 1000 })
+    })
+  })
+
+  describe('#getTxid()', () => {
+    it('should call slpIndexer adapter post method', async () => {
+      const txid = 'a'.repeat(64)
+      mockAdapters.slpIndexer.post.resolves({ txid })
+
+      const result = await uut.getTxid({ txid })
+
+      assert.isTrue(
+        mockAdapters.slpIndexer.post.calledOnceWith('slp/tx/', { txid })
+      )
+      assert.deepEqual(result, { txid })
+    })
+  })
+
+  describe('#getTokenStats()', () => {
+    it('should call slpIndexer adapter post method', async () => {
+      const tokenId = 'a'.repeat(64)
+      const withTxHistory = false
+      mockAdapters.slpIndexer.post.resolves({ tokenData: {} })
+
+      const result = await uut.getTokenStats({ tokenId, withTxHistory })
+
+      assert.isTrue(
+        mockAdapters.slpIndexer.post.calledOnceWith('slp/token/', { tokenId, withTxHistory })
+      )
+      assert.deepEqual(result, { tokenData: {} })
+    })
+  })
+
+  describe('#getTokenData()', () => {
+    it('should get token data with mutable and immutable data', async () => {
+      const tokenId = 'a'.repeat(64)
+      const tokenStats = {
+        tokenData: {
+          documentUri: 'ipfs://test123',
+          documentHash: 'b'.repeat(64)
+        }
+      }
+      mockAdapters.slpIndexer.post.resolves(tokenStats)
+
+      // Mock decodeOpReturn to return JSON with mda
+      sandbox.stub(uut, 'decodeOpReturn').resolves(JSON.stringify({ mda: 'bitcoincash:test123' }))
+      sandbox.stub(uut, 'getMutableCid').resolves('mutable-cid-123')
+
+      const result = await uut.getTokenData({ tokenId })
+
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.property(result, 'mutableData')
+    })
+
+    it('should handle errors when getting mutable data', async () => {
+      const tokenId = 'a'.repeat(64)
+      const tokenStats = {
+        tokenData: {
+          documentUri: 'ipfs://test123',
+          documentHash: 'b'.repeat(64)
+        }
+      }
+      mockAdapters.slpIndexer.post.resolves(tokenStats)
+
+      sandbox.stub(uut, 'getMutableCid').rejects(new Error('Test error'))
+
+      const result = await uut.getTokenData({ tokenId })
+
+      assert.property(result, 'genesisData')
+      assert.property(result, 'immutableData')
+      assert.equal(result.mutableData, '')
+    })
+  })
+
+  describe('#decodeOpReturn()', () => {
+    it('should decode OP_RETURN data from transaction', async () => {
+      const txid = 'a'.repeat(64)
+      const mockTxData = {
+        details: {
+          vout: [
+            {
+              scriptPubKey: {
+                hex: '6a0c48656c6c6f20576f726c6421'
+              }
+            }
+          ]
+        }
+      }
+      mockBchjs.Electrumx.txData.resolves(mockTxData)
+      mockBchjs.Script.toASM.returns('OP_RETURN 48656c6c6f20576f726c6421')
+
+      const result = await uut.decodeOpReturn({ txid })
+
+      assert.isTrue(mockBchjs.Electrumx.txData.calledOnceWith(txid))
+      assert.isString(result)
+    })
+
+    it('should throw error if txid is not a string', async () => {
+      try {
+        await uut.decodeOpReturn({ txid: null })
+        assert.fail('Should have thrown an error')
+      } catch (err) {
+        assert.include(err.message, 'txid must be a string')
+      }
+    })
+  })
+
+  describe('#getCIDData()', () => {
+    it('should fetch IPFS data from CID', async () => {
+      const cid = 'ipfs://test123'
+      const mockData = { name: 'Test Token' }
+
+      // Mock axios
+      const axios = await import('axios')
+      sandbox.stub(axios.default, 'get').resolves({ data: mockData })
+
+      const result = await uut.getCIDData({ cid })
+
+      assert.deepEqual(result, mockData)
+    })
+
+    it('should throw error if cid is not a string', async () => {
+      try {
+        await uut.getCIDData({ cid: null })
+        assert.fail('Should have thrown an error')
+      } catch (err) {
+        assert.include(err.message, 'cid must be a string')
+      }
+    })
+  })
+
+  describe('#getMutableCid()', () => {
+    it('should extract mutable CID from token stats', async () => {
+      const tokenStats = {
+        documentHash: 'a'.repeat(64)
+      }
+
+      const mockOpReturn = JSON.stringify({ mda: 'bitcoincash:test123' })
+      sandbox.stub(uut, 'decodeOpReturn').resolves(mockOpReturn)
+
+      mockWallet.getTransactions.resolves([
+        {
+          tx_hash: 'b'.repeat(64),
+          height: 100
+        }
+      ])
+
+      mockWallet.getTxData.resolves([{
+        vin: [{
+          address: 'bitcoincash:test123'
+        }]
+      }])
+
+      // Mock decodeOpReturn for the transaction
+      uut.decodeOpReturn.onSecondCall().resolves(JSON.stringify({ cid: 'ipfs://mutable-cid-123', ts: 1234567890 }))
+
+      const result = await uut.getMutableCid({ tokenStats })
+
+      assert.isString(result)
+    })
+
+    it('should return false if no documentHash in tokenStats', async () => {
+      const tokenStats = {}
+
+      try {
+        await uut.getMutableCid({ tokenStats })
+        assert.fail('Should have thrown an error')
+      } catch (err) {
+        assert.include(err.message, 'No documentHash property found')
+      }
+    })
+  })
+})