psf-bch-api 1.2.0 → 7.1.0

package/test/unit/controllers/slp-controller-unit.js

@@ -0,0 +1,312 @@
+/*
+  Unit tests for SlpRESTController.
+*/
+
+import { assert } from 'chai'
+import sinon from 'sinon'
+
+import SlpRESTController from '../../../src/controllers/rest-api/slp/controller.js'
+import {
+  createMockRequest,
+  createMockResponse
+} from '../mocks/controller-mocks.js'
+
+// Valid mainnet cash address for testing
+const VALID_MAINNET_ADDRESS = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+
+describe('#slp-controller.js', () => {
+  let sandbox
+  let mockUseCases
+  let mockAdapters
+  let uut
+
+  const createSlpUseCaseStubs = () => ({
+    getStatus: sandbox.stub().resolves({ status: 'ok' }),
+    getAddress: sandbox.stub().resolves({ balance: 1000 }),
+    getTxid: sandbox.stub().resolves({ txid: 'abc' }),
+    getTokenStats: sandbox.stub().resolves({ tokenData: {} }),
+    getTokenData: sandbox.stub().resolves({ genesisData: {}, immutableData: '', mutableData: '' })
+  })
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+    mockAdapters = {}
+    mockUseCases = {
+      slp: createSlpUseCaseStubs()
+    }
+
+    uut = new SlpRESTController({
+      adapters: mockAdapters,
+      useCases: mockUseCases
+    })
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new SlpRESTController({ useCases: mockUseCases })
+      }, /Adapters library required/)
+    })
+
+    it('should require slp use cases', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new SlpRESTController({ adapters: mockAdapters, useCases: {} })
+      }, /SLP use cases required/)
+    })
+  })
+
+  describe('#root()', () => {
+    it('should return service status', async () => {
+      const req = createMockRequest()
+      const res = createMockResponse()
+
+      await uut.root(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.deepEqual(res.jsonData, { status: 'psf-slp-indexer' })
+    })
+  })
+
+  describe('#getStatus()', () => {
+    it('should return status on success', async () => {
+      const req = createMockRequest()
+      const res = createMockResponse()
+
+      await uut.getStatus(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.deepEqual(res.jsonData, { status: 'ok' })
+      assert.isTrue(mockUseCases.slp.getStatus.calledOnce)
+    })
+
+    it('should handle errors via handleError', async () => {
+      const error = new Error('failure')
+      error.status = 503
+      mockUseCases.slp.getStatus.rejects(error)
+      const req = createMockRequest()
+      const res = createMockResponse()
+
+      await uut.getStatus(req, res)
+
+      assert.equal(res.statusValue, 503)
+      assert.deepEqual(res.jsonData, { error: 'failure' })
+    })
+  })
+
+  describe('#getAddress()', () => {
+    it('should return address balance on success', async () => {
+      const req = createMockRequest({
+        body: { address: VALID_MAINNET_ADDRESS }
+      })
+      const res = createMockResponse()
+
+      await uut.getAddress(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.deepEqual(res.jsonData, { balance: 1000 })
+      assert.isTrue(mockUseCases.slp.getAddress.calledOnce)
+    })
+
+    it('should return error if address is empty', async () => {
+      const req = createMockRequest({
+        body: { address: '' }
+      })
+      const res = createMockResponse()
+
+      await uut.getAddress(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+      assert.include(res.jsonData.error, 'can not be empty')
+    })
+
+    it('should return error if address is missing', async () => {
+      const req = createMockRequest({
+        body: {}
+      })
+      const res = createMockResponse()
+
+      await uut.getAddress(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+    })
+
+    it('should handle errors via handleError', async () => {
+      const error = new Error('Invalid address')
+      error.status = 400
+      mockUseCases.slp.getAddress.rejects(error)
+      const req = createMockRequest({
+        body: { address: VALID_MAINNET_ADDRESS }
+      })
+      const res = createMockResponse()
+
+      await uut.getAddress(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.deepEqual(res.jsonData, { error: 'Invalid address' })
+    })
+  })
+
+  describe('#getTxid()', () => {
+    it('should return transaction data on success', async () => {
+      const req = createMockRequest({
+        body: { txid: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTxid(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.deepEqual(res.jsonData, { txid: 'abc' })
+      assert.isTrue(mockUseCases.slp.getTxid.calledOnce)
+    })
+
+    it('should return error if txid is empty', async () => {
+      const req = createMockRequest({
+        body: { txid: '' }
+      })
+      const res = createMockResponse()
+
+      await uut.getTxid(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+      assert.include(res.jsonData.error, 'can not be empty')
+    })
+
+    it('should return error if txid is not 64 characters', async () => {
+      const req = createMockRequest({
+        body: { txid: 'abc' }
+      })
+      const res = createMockResponse()
+
+      await uut.getTxid(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+      assert.include(res.jsonData.error, 'not a txid')
+    })
+
+    it('should handle errors via handleError', async () => {
+      const error = new Error('Transaction not found')
+      error.status = 404
+      mockUseCases.slp.getTxid.rejects(error)
+      const req = createMockRequest({
+        body: { txid: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTxid(req, res)
+
+      assert.equal(res.statusValue, 404)
+      assert.deepEqual(res.jsonData, { error: 'Transaction not found' })
+    })
+  })
+
+  describe('#getTokenStats()', () => {
+    it('should return token stats on success', async () => {
+      const req = createMockRequest({
+        body: { tokenId: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenStats(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.deepEqual(res.jsonData, { tokenData: {} })
+      assert.isTrue(mockUseCases.slp.getTokenStats.calledOnce)
+    })
+
+    it('should pass withTxHistory flag', async () => {
+      const req = createMockRequest({
+        body: { tokenId: 'a'.repeat(64), withTxHistory: true }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenStats(req, res)
+
+      assert.isTrue(mockUseCases.slp.getTokenStats.calledWith({
+        tokenId: 'a'.repeat(64),
+        withTxHistory: true
+      }))
+    })
+
+    it('should return error if tokenId is empty', async () => {
+      const req = createMockRequest({
+        body: { tokenId: '' }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenStats(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+    })
+
+    it('should handle errors via handleError', async () => {
+      const error = new Error('Token not found')
+      error.status = 404
+      mockUseCases.slp.getTokenStats.rejects(error)
+      const req = createMockRequest({
+        body: { tokenId: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenStats(req, res)
+
+      assert.equal(res.statusValue, 404)
+      assert.deepEqual(res.jsonData, { error: 'Token not found' })
+    })
+  })
+
+  describe('#getTokenData()', () => {
+    it('should return token data on success', async () => {
+      const req = createMockRequest({
+        body: { tokenId: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenData(req, res)
+
+      assert.equal(res.statusValue, 200)
+      assert.property(res.jsonData, 'genesisData')
+      assert.property(res.jsonData, 'immutableData')
+      assert.property(res.jsonData, 'mutableData')
+      assert.isTrue(mockUseCases.slp.getTokenData.calledOnce)
+    })
+
+    it('should return error if tokenId is empty', async () => {
+      const req = createMockRequest({
+        body: { tokenId: '' }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenData(req, res)
+
+      assert.equal(res.statusValue, 400)
+      assert.property(res.jsonData, 'error')
+    })
+
+    it('should handle errors via handleError', async () => {
+      const error = new Error('Token data not found')
+      error.status = 404
+      mockUseCases.slp.getTokenData.rejects(error)
+      const req = createMockRequest({
+        body: { tokenId: 'a'.repeat(64) }
+      })
+      const res = createMockResponse()
+
+      await uut.getTokenData(req, res)
+
+      assert.equal(res.statusValue, 404)
+      assert.deepEqual(res.jsonData, { error: 'Token data not found' })
+    })
+  })
+})

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

@@ -0,0 +1,297 @@
+/*
+  Unit tests for FulcrumUseCases.
+*/
+
+import { assert } from 'chai'
+import sinon from 'sinon'
+import BCHJS from '@psf/bch-js'
+
+import FulcrumUseCases from '../../../src/use-cases/fulcrum-use-cases.js'
+
+describe('#fulcrum-use-cases.js', () => {
+  let sandbox
+  let mockAdapters
+  let uut
+  let sortAllTxsStub
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+    mockAdapters = {
+      fulcrum: {
+        get: sandbox.stub().resolves({}),
+        post: sandbox.stub().resolves({})
+      }
+    }
+
+    // Create a mock BCHJS instance with stubbed sortAllTxs method
+    const mockBchjs = new BCHJS()
+    if (!mockBchjs.Electrumx) {
+      mockBchjs.Electrumx = {}
+    }
+
+    // Create a stub that sorts transactions
+    sortAllTxsStub = sandbox.stub(mockBchjs.Electrumx, 'sortAllTxs')
+    sortAllTxsStub.callsFake(async (txs, order) => {
+      const sorted = [...txs].sort((a, b) => {
+        if (order === 'DESCENDING') {
+          return (b.height || 0) - (a.height || 0)
+        }
+        return (a.height || 0) - (b.height || 0)
+      })
+      return sorted
+    })
+
+    // Inject the mocked bchjs instance into the use cases
+    uut = new FulcrumUseCases({ adapters: mockAdapters, bchjs: mockBchjs })
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#constructor()', () => {
+    it('should require adapters', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new FulcrumUseCases()
+      }, /Adapters instance required/)
+    })
+
+    it('should require fulcrum adapter', () => {
+      assert.throws(() => {
+        // eslint-disable-next-line no-new
+        new FulcrumUseCases({ adapters: {} })
+      }, /Fulcrum adapter required/)
+    })
+  })
+
+  describe('#getBalance()', () => {
+    it('should call fulcrum adapter get method', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      mockAdapters.fulcrum.get.resolves({ balance: 1000 })
+
+      const result = await uut.getBalance({ address })
+
+      assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/balance/${address}`))
+      assert.deepEqual(result, { balance: 1000 })
+    })
+  })
+
+  describe('#getBalances()', () => {
+    it('should call fulcrum adapter post method', async () => {
+      const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
+      mockAdapters.fulcrum.post.resolves({ balances: [] })
+
+      const result = await uut.getBalances({ addresses })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/balance/', { addresses })
+      )
+      assert.deepEqual(result, { balances: [] })
+    })
+  })
+
+  describe('#getUtxos()', () => {
+    it('should call fulcrum adapter get method', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      mockAdapters.fulcrum.get.resolves({ utxos: [] })
+
+      const result = await uut.getUtxos({ address })
+
+      assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/utxos/${address}`))
+      assert.deepEqual(result, { utxos: [] })
+    })
+  })
+
+  describe('#getUtxosBulk()', () => {
+    it('should call fulcrum adapter post method', async () => {
+      const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
+      mockAdapters.fulcrum.post.resolves({ utxos: [] })
+
+      const result = await uut.getUtxosBulk({ addresses })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/utxos/', { addresses })
+      )
+      assert.deepEqual(result, { utxos: [] })
+    })
+  })
+
+  describe('#getTransactionDetails()', () => {
+    it('should call fulcrum adapter get method', async () => {
+      const txid = 'a'.repeat(64)
+      mockAdapters.fulcrum.get.resolves({ txid })
+
+      const result = await uut.getTransactionDetails({ txid })
+
+      assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/tx/data/${txid}`))
+      assert.deepEqual(result, { txid })
+    })
+  })
+
+  describe('#getTransactionDetailsBulk()', () => {
+    it('should call fulcrum adapter post method with verbose', async () => {
+      const txids = ['a'.repeat(64)]
+      const verbose = true
+      mockAdapters.fulcrum.post.resolves({ transactions: [] })
+
+      const result = await uut.getTransactionDetailsBulk({ txids, verbose })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/tx/data', { txids, verbose })
+      )
+      assert.deepEqual(result, { transactions: [] })
+    })
+  })
+
+  describe('#broadcastTransaction()', () => {
+    it('should call fulcrum adapter post method', async () => {
+      const txHex = '010203'
+      mockAdapters.fulcrum.post.resolves({ txid: 'abc' })
+
+      const result = await uut.broadcastTransaction({ txHex })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/tx/broadcast', { txHex })
+      )
+      assert.deepEqual(result, { txid: 'abc' })
+    })
+  })
+
+  describe('#getBlockHeaders()', () => {
+    it('should call fulcrum adapter get method with height and count', async () => {
+      const height = 100
+      const count = 2
+      mockAdapters.fulcrum.get.resolves({ headers: [] })
+
+      const result = await uut.getBlockHeaders({ height, count })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.get.calledOnceWith(`electrumx/block/headers/${height}?count=${count}`)
+      )
+      assert.deepEqual(result, { headers: [] })
+    })
+  })
+
+  describe('#getBlockHeadersBulk()', () => {
+    it('should call fulcrum adapter post method', async () => {
+      const heights = [{ height: 100, count: 2 }]
+      mockAdapters.fulcrum.post.resolves({ headers: [] })
+
+      const result = await uut.getBlockHeadersBulk({ heights })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/block/headers', { heights })
+      )
+      assert.deepEqual(result, { headers: [] })
+    })
+  })
+
+  describe('#getTransactions()', () => {
+    it('should call fulcrum adapter and sort transactions when allTxs is false', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      const allTxs = false
+      const mockTransactions = [
+        { tx_hash: 'aaa', height: 100 },
+        { tx_hash: 'bbb', height: 200 },
+        { tx_hash: 'ccc', height: 150 }
+      ]
+      mockAdapters.fulcrum.get.resolves({
+        transactions: mockTransactions
+      })
+
+      const result = await uut.getTransactions({ address, allTxs })
+
+      assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/transactions/${address}`))
+      assert.property(result, 'transactions')
+      // Transactions should be sorted and limited to 100
+      if (result.transactions && result.transactions.length > 100) {
+        assert.isAtMost(result.transactions.length, 100)
+      }
+    })
+
+    it('should return all transactions when allTxs is true', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      const allTxs = true
+      const mockTransactions = Array(150).fill({ tx_hash: 'aaa', height: 100 })
+      mockAdapters.fulcrum.get.resolves({
+        transactions: mockTransactions
+      })
+
+      const result = await uut.getTransactions({ address, allTxs })
+
+      assert.property(result, 'transactions')
+      // All transactions should be returned when allTxs is true
+      assert.equal(result.transactions.length, 150)
+    })
+  })
+
+  describe('#getTransactionsBulk()', () => {
+    it('should call fulcrum adapter and sort transactions for each address', async () => {
+      const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
+      const allTxs = false
+      const mockResponse = {
+        transactions: [
+          {
+            transactions: [
+              { tx_hash: 'aaa', height: 100 },
+              { tx_hash: 'bbb', height: 200 }
+            ]
+          }
+        ]
+      }
+      mockAdapters.fulcrum.post.resolves(mockResponse)
+
+      const result = await uut.getTransactionsBulk({ addresses, allTxs })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/transactions/', { addresses })
+      )
+      assert.property(result, 'transactions')
+    })
+
+    it('should limit to 100 transactions when allTxs is false', async () => {
+      const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
+      const allTxs = false
+      const mockTransactions = Array(150).fill({ tx_hash: 'aaa', height: 100 })
+      const mockResponse = {
+        transactions: [
+          {
+            transactions: mockTransactions
+          }
+        ]
+      }
+      mockAdapters.fulcrum.post.resolves(mockResponse)
+
+      const result = await uut.getTransactionsBulk({ addresses, allTxs })
+
+      assert.isAtMost(result.transactions[0].transactions.length, 100)
+    })
+  })
+
+  describe('#getMempool()', () => {
+    it('should call fulcrum adapter get method', async () => {
+      const address = 'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+      mockAdapters.fulcrum.get.resolves({ mempool: [] })
+
+      const result = await uut.getMempool({ address })
+
+      assert.isTrue(mockAdapters.fulcrum.get.calledOnceWith(`electrumx/unconfirmed/${address}`))
+      assert.deepEqual(result, { mempool: [] })
+    })
+  })
+
+  describe('#getMempoolBulk()', () => {
+    it('should call fulcrum adapter post method', async () => {
+      const addresses = ['bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf']
+      mockAdapters.fulcrum.post.resolves({ mempool: [] })
+
+      const result = await uut.getMempoolBulk({ addresses })
+
+      assert.isTrue(
+        mockAdapters.fulcrum.post.calledOnceWith('electrumx/unconfirmed/', { addresses })
+      )
+      assert.deepEqual(result, { mempool: [] })
+    })
+  })
+})

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)
+    })
+  })
+})