@psf/bch-js 6.8.2 → 7.0.1

package/test/unit/raw-tranactions.js

@@ -3,22 +3,23 @@
 */
 
 // Public npm libraries
-const assert = require('assert')
-const assert2 = require('chai').assert
-const axios = require('axios')
-const sinon = require('sinon')
-// const nock = require("nock") // HTTP mocking
+import assert from 'assert'
+import chai from 'chai'
+import axios from 'axios'
+import sinon from 'sinon'
+// import nock from "nock" // HTTP mocking
 
 // Unit under test (uut)
-const BCHJS = require('../../src/bch-js')
-// const bchjs = new BCHJS()
-let bchjs
+import BCHJS from '../../src/bch-js.js'
 
 // Used for debugging
 // const util = require("util")
 // util.inspect.defaultOptions = { depth: 1 }
 
-const mockData = require('./fixtures/rawtransaction-mock')
+import mockData from './fixtures/rawtransaction-mock.js'
+const { assert: assert2 } = chai
+// const bchjs = new BCHJS()
+let bchjs
 
 describe('#RawTransactions', () => {
   let sandbox
@@ -44,7 +45,7 @@ describe('#RawTransactions', () => {
         vout: []
       }
 
-      const resolved = new Promise(resolve => resolve({ data: data }))
+      const resolved = new Promise(resolve => resolve({ data }))
       sandbox.stub(axios, 'get').returns(resolved)
 
       bchjs.RawTransactions.decodeRawTransaction('02000000000000000000')
@@ -67,7 +68,7 @@ describe('#RawTransactions', () => {
         p2sh: 'bitcoincash:prswx5965nfumux9qng5kj8hw603vcne7q08t8c6jp'
       }
 
-      const resolved = new Promise(resolve => resolve({ data: data }))
+      const resolved = new Promise(resolve => resolve({ data }))
       sandbox.stub(axios, 'get').returns(resolved)
 
       const result = await bchjs.RawTransactions.decodeScript(
@@ -88,7 +89,7 @@ describe('#RawTransactions', () => {
       const data =
         '020000000160d663961c63c7f0a07f22ec07b8f55b3935bfdbed8b1d8454916e8932fbf109010000006b4830450221008479fab4cfdcb111833d250a43f98ac26d43272b7a29cb1b9a0491eae5c44b3502203448b17253632395c29a7d62058bbfe93efb20fc8636ba6837002d464195aec04121029123258f7cdcd45b864066bcaa9b71f24d5ed1fa1dd36eaf107d8432b5014658ffffffff016d180000000000001976a91479d3297d1823149f4ec61df31d19f2fad5390c0288ac00000000'
 
-      const resolved = new Promise(resolve => resolve({ data: data }))
+      const resolved = new Promise(resolve => resolve({ data }))
       sandbox.stub(axios, 'get').returns(resolved)
 
       bchjs.RawTransactions.getRawTransaction(
@@ -109,7 +110,7 @@ describe('#RawTransactions', () => {
     it('should send single raw transaction', async () => {
       const data = 'Error: transaction already in block chain'
 
-      const resolved = new Promise(resolve => resolve({ data: data }))
+      const resolved = new Promise(resolve => resolve({ data }))
       sandbox.stub(axios, 'get').returns(resolved)
 
       const result = await bchjs.RawTransactions.sendRawTransaction(

package/test/unit/scripts.js

@@ -1,12 +1,14 @@
 // Public npm libraries
-const assert = require('assert')
-const Buffer = require('safe-buffer').Buffer
+import assert from 'assert'
+import { Buffer } from 'safe-buffer'
 
 // Mocks
-const fixtures = require('./fixtures/script.json')
+import { createRequire } from 'module'
 
 // Unit under test (uut)
-const BCHJS = require('../../src/bch-js')
+import BCHJS from '../../src/bch-js.js'
+const require = createRequire(import.meta.url)
+const fixtures = require('./fixtures/script.json')
 let bchjs
 
 describe('#Script', () => {
@@ -438,8 +440,8 @@ describe('#Script', () => {
               Buffer.from(fixture.hex, 'hex')
             ),
             {
-              redeemScriptSig: redeemScriptSig,
-              redeemScript: redeemScript
+              redeemScriptSig,
+              redeemScript
             }
           )
         })

package/test/unit/slp-address.js

@@ -1,10 +1,12 @@
-const assert = require('assert')
+import assert from 'assert'
 
-const BCHJS = require('../../src/bch-js')
-// const SLP = require("../../src/slp/slp")
+import BCHJS from '../../src/bch-js.js'
+
+import { createRequire } from 'module'
+// import SLP from "../../src/slp/slp.js"
 // const SLP = new slp({ restURL: "http://fakeurl.com/" })
 let slp
-
+const require = createRequire(import.meta.url)
 const fixtures = require('./fixtures/slp/address.json')
 // const axios = require("axios")
 // const sinon = require("sinon")

package/test/unit/slp-ecpair.js

@@ -1,8 +1,10 @@
-const assert = require('assert')
+import assert from 'assert'
 
-const fixtures = require('./fixtures/slp/ecpair.json')
+import { createRequire } from 'module'
 
-const BCHJS = require('../../src/bch-js')
+import BCHJS from '../../src/bch-js.js'
+const require = createRequire(import.meta.url)
+const fixtures = require('./fixtures/slp/ecpair.json')
 let slp
 
 // const SLP = require("../../src/slp/slp")

package/test/unit/slp-nft1.js

@@ -2,15 +2,16 @@
   Unit tests for the TokenType1 library.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-// const axios = require('axios')
+import chai from 'chai'
+import sinon from 'sinon'
+// const SERVER = bchjs.restURL
+
+import BCHJS from '../../src/bch-js.js'
+const { assert } = chai
+// import axios from '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

package/test/unit/slp-tokentype1.js

@@ -2,15 +2,16 @@
   Unit tests for the TokenType1 library.
 */
 
-const assert = require('chai').assert
-const sinon = require('sinon')
-// const axios = require("axios")
+import chai from 'chai'
+import sinon from 'sinon'
+// const SERVER = bchjs.restURL
+
+import BCHJS from '../../src/bch-js.js'
+const { assert } = chai
+// import axios from "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

package/test/unit/slp-utils.js

@@ -1,19 +1,20 @@
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
-const cloneDeep = require('lodash.clonedeep')
+import chai from 'chai'
+import sinon from 'sinon'
+import cloneDeep from 'lodash.clonedeep'
 
 // Unit under test
-const SLP = require('../../src/slp/slp')
+import SLP from '../../src/slp/slp.js'
+
+// Mock data used for unit tests
+import mockDataLib from './fixtures/slp/mock-utils.js'
+const { assert } = chai
 let uut
 // let SERVER
 
 const REST_URL = process.env.RESTURL
   ? process.env.RESTURL
   : 'https://bchn.fullstack.cash/v5/'
-
-// Mock data used for unit tests
-const mockDataLib = require('./fixtures/slp/mock-utils')
 let mockData
 
 // Default to unit tests unless some other value for TEST is passed.

package/test/unit/transaction-builder.js

@@ -1,9 +1,12 @@
+import { createRequire } from 'module'
+import assert from 'assert'
+import chai from 'chai'
+import BCHJS from '../../src/bch-js.js'
+import { Buffer } from 'safe-buffer'
+const require = createRequire(import.meta.url)
 const fixtures = require('./fixtures/transaction-builder.json')
-const assert = require('assert')
-const assert2 = require('chai').assert
-const BCHJS = require('../../src/bch-js')
+const { assert: assert2 } = chai
 const bchjs = new BCHJS()
-const Buffer = require('safe-buffer').Buffer
 
 describe('#TransactionBuilder', () => {
   describe('#hashTypes', () => {

package/test/unit/transaction-unit.js

@@ -3,11 +3,12 @@
 */
 
 // Public npm libraries
-const assert = require('chai').assert
-const sinon = require('sinon')
-// const cloneDeep = require('lodash.clonedeep')
+import chai from 'chai'
+import sinon from 'sinon'
+// import cloneDeep from 'lodash.clonedeep'
 
-const BCHJS = require('../../src/bch-js')
+import BCHJS from '../../src/bch-js.js'
+const { assert } = chai
 const bchjs = new BCHJS()
 
 // const mockDataLib = require('./fixtures/transaction-mock.js')

package/test/unit/util.js

@@ -1,39 +1,18 @@
-const assert = require('assert')
-const assert2 = require('chai').assert
-const axios = require('axios')
-const BCHJS = require('../../src/bch-js')
-const bchjs = new BCHJS()
-const sinon = require('sinon')
+/*
+  Unit tests for util.js library.
+*/
 
-describe('#Util', () => {
-  describe('#validateAddress', () => {
-    let sandbox
-    beforeEach(() => (sandbox = sinon.createSandbox()))
-    afterEach(() => sandbox.restore())
-
-    it('should validate address', done => {
-      const data = {
-        isvalid: true,
-        address: 'bitcoincash:qpz7qtkuyhrsz4qmnnrvf8gz9zd0u9v7eqsewyk4w5',
-        scriptPubKey: '76a91445e02edc25c701541b9cc6c49d02289afe159ec888ac',
-        ismine: false,
-        iswatchonly: false,
-        isscript: false
-      }
+// Global npm libraries
+import chai from 'chai'
 
-      const resolved = new Promise(resolve => resolve({ data: data }))
-      sandbox.stub(axios, 'get').returns(resolved)
+// Local libraries
+import BCHJS from '../../src/bch-js.js'
+// import sinon from 'sinon'
+const { assert: assert2 } = chai
 
-      bchjs.Util.validateAddress(
-        'bitcoincash:qpz7qtkuyhrsz4qmnnrvf8gz9zd0u9v7eqsewyk4w5'
-      )
-        .then(result => {
-          assert.deepStrictEqual(data, result)
-        })
-        .then(done, done)
-    })
-  })
+const bchjs = new BCHJS()
 
+describe('#Util', () => {
   describe('#floor8', () => {
     it('should floor a number to 8 decimals', () => {
       const num = 1.234567891111

package/test/unit/utxo-unit.js

@@ -2,13 +2,14 @@
   Unit tests for the utxo.js library.
 */
 
-const sinon = require('sinon')
-const assert = require('chai').assert
+import sinon from 'sinon'
+import chai from 'chai'
 
-const BCHJS = require('../../src/bch-js')
-const bchjs = new BCHJS()
+import BCHJS from '../../src/bch-js.js'
 
-const mockData = require('./fixtures/utxo-mocks')
+import mockData from './fixtures/utxo-mocks.js'
+const { assert } = chai
+const bchjs = new BCHJS()
 
 describe('#utxo', () => {
   let sandbox

package/test/unit/x402.js

@@ -0,0 +1,193 @@
+import assert from 'assert'
+import sinon from 'sinon'
+import BCHJS from '../../src/bch-js.js'
+
+describe('#X402 Integration', () => {
+  let sandbox
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#Constructor Configuration', () => {
+    it('should initialize without x402 by default', () => {
+      const bchjs = new BCHJS()
+
+      assert.strictEqual(bchjs.wif, '')
+      assert.strictEqual(bchjs.paymentAmountSats, 20000)
+      assert.strictEqual(bchjs.bchServerURL, 'https://free-bch.fullstack.cash')
+    })
+
+    it('should accept wif in config', () => {
+      const testWif = 'L1eYaneXDDXy8VDig4Arwe8wYHbhtsA5wuQvwsKwhaYeneoZuKG4'
+      const bchjs = new BCHJS({
+        wif: testWif
+      })
+
+      assert.strictEqual(bchjs.wif, testWif)
+    })
+
+    it('should accept paymentAmountSats in config', () => {
+      const bchjs = new BCHJS({
+        paymentAmountSats: 5000
+      })
+
+      assert.strictEqual(bchjs.paymentAmountSats, 5000)
+    })
+
+    it('should accept bchServerURL in config', () => {
+      const customUrl = 'http://localhost:5000'
+      const bchjs = new BCHJS({
+        bchServerURL: customUrl
+      })
+
+      assert.strictEqual(bchjs.bchServerURL, customUrl)
+    })
+
+    it('should use default values when config options are not provided', () => {
+      const bchjs = new BCHJS({
+        restURL: 'http://localhost:3000/v6/'
+      })
+
+      assert.strictEqual(bchjs.wif, '')
+      assert.strictEqual(bchjs.paymentAmountSats, 20000)
+      assert.strictEqual(bchjs.bchServerURL, 'https://free-bch.fullstack.cash')
+    })
+
+    it('should read WIF from BCHJSWIF environment variable', () => {
+      const testWif = 'L1eYaneXDDXy8VDig4Arwe8wYHbhtsA5wuQvwsKwhaYeneoZuKG4'
+      const originalEnv = process.env.BCHJSWIF
+      process.env.BCHJSWIF = testWif
+
+      try {
+        const bchjs = new BCHJS()
+        assert.strictEqual(bchjs.wif, testWif)
+      } finally {
+        // Restore original env value
+        if (originalEnv === undefined) {
+          delete process.env.BCHJSWIF
+        } else {
+          process.env.BCHJSWIF = originalEnv
+        }
+      }
+    })
+
+    it('should prefer config.wif over BCHJSWIF environment variable', () => {
+      const configWif = 'L1XHKhaBAfkr2FJQn3pTfCMxz652WYfmvKj8xDCHCEDV9tWGcbYj'
+      const envWif = 'L1eYaneXDDXy8VDig4Arwe8wYHbhtsA5wuQvwsKwhaYeneoZuKG4'
+      const originalEnv = process.env.BCHJSWIF
+      process.env.BCHJSWIF = envWif
+
+      try {
+        const bchjs = new BCHJS({ wif: configWif })
+        assert.strictEqual(bchjs.wif, configWif)
+      } finally {
+        // Restore original env value
+        if (originalEnv === undefined) {
+          delete process.env.BCHJSWIF
+        } else {
+          process.env.BCHJSWIF = originalEnv
+        }
+      }
+    })
+  })
+
+  describe('#x402 Helper Functions', () => {
+    it('should expose createSigner function', () => {
+      const bchjs = new BCHJS()
+
+      assert.strictEqual(typeof bchjs.x402.createSigner, 'function')
+    })
+
+    it('should expose withPaymentInterceptor function', () => {
+      const bchjs = new BCHJS()
+
+      assert.strictEqual(typeof bchjs.x402.withPaymentInterceptor, 'function')
+    })
+
+    it('should expose createPaymentHeader function', () => {
+      const bchjs = new BCHJS()
+
+      assert.strictEqual(typeof bchjs.x402.createPaymentHeader, 'function')
+    })
+
+    it('should expose selectPaymentRequirements function', () => {
+      const bchjs = new BCHJS()
+
+      assert.strictEqual(typeof bchjs.x402.selectPaymentRequirements, 'function')
+    })
+  })
+
+  describe('#Axios Instance', () => {
+    it('should have axios available in sub-modules', () => {
+      const bchjs = new BCHJS()
+
+      // Check that sub-modules have axios available (from their own import or config)
+      assert.ok(bchjs.Control.axios)
+      assert.ok(bchjs.Blockchain.axios)
+      assert.ok(bchjs.Mining.axios)
+      assert.ok(bchjs.Electrumx.axios)
+      assert.ok(bchjs.RawTransactions.axios)
+      assert.ok(bchjs.Price.axios)
+    })
+
+    it('should pass x402-wrapped axios instance when WIF is provided', () => {
+      const testWif = 'L1eYaneXDDXy8VDig4Arwe8wYHbhtsA5wuQvwsKwhaYeneoZuKG4'
+      const bchjs = new BCHJS({
+        wif: testWif
+      })
+
+      // All modules should have the same wrapped axios instance
+      assert.ok(bchjs.Control.axios)
+      assert.ok(bchjs.Blockchain.axios)
+      // When WIF is provided, the axios instances should be the same wrapped instance
+      assert.strictEqual(bchjs.Control.axios, bchjs.Blockchain.axios)
+    })
+  })
+
+  describe('#selectPaymentRequirements', () => {
+    it('should select BCH utxo payment requirements from accepts array', () => {
+      const bchjs = new BCHJS()
+
+      const accepts = [
+        {
+          scheme: 'exact',
+          network: 'base-sepolia',
+          maxAmountRequired: '10000'
+        },
+        {
+          scheme: 'utxo',
+          network: 'bch',
+          minAmountRequired: '1000',
+          payTo: 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
+        }
+      ]
+
+      const result = bchjs.x402.selectPaymentRequirements(accepts)
+
+      assert.strictEqual(result.scheme, 'utxo')
+      assert.strictEqual(result.network, 'bch')
+      assert.strictEqual(result.minAmountRequired, '1000')
+    })
+
+    it('should throw an error when no BCH requirements found', () => {
+      const bchjs = new BCHJS()
+
+      const accepts = [
+        {
+          scheme: 'exact',
+          network: 'base-sepolia',
+          maxAmountRequired: '10000'
+        }
+      ]
+
+      assert.throws(() => {
+        bchjs.x402.selectPaymentRequirements(accepts)
+      }, /No BCH payment requirements found/)
+    })
+  })
+})

package/test/integration/chains/abc/psf-slp-indexer-integration.js

@@ -1,38 +0,0 @@
-/*
-  Integration tests for the psf-slp-indexer.js library, specific to the eCash
-  blockchain.
-*/
-
-// Global npm libraries
-const assert = require('chai').assert
-
-// Local libraries
-const BCHJS = require('../../../../src/bch-js')
-let bchjs
-
-describe('#psf-slp-indexer', () => {
-  beforeEach(async () => {
-    // Introduce a delay so that the BVT doesn't trip the rate limits.
-    if (process.env.IS_USING_FREE_TIER) await sleep(3000)
-
-    bchjs = new BCHJS()
-  })
-
-  describe('#balance', () => {
-    it('should get token balance for an ecash address', async () => {
-      const addr = 'ecash:qr5c4hfy52zn87484cucvzle5pljz0gtr5vhtw9z09'
-
-      const result = await bchjs.PsfSlpIndexer.balance(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result.balance, 'utxos')
-      assert.property(result.balance, 'txs')
-      assert.property(result.balance, 'balances')
-    })
-  })
-})
-
-// Promise-based sleep function
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}

package/test/integration/chains/abc/rawtransaction.js

@@ -1,73 +0,0 @@
-/*
-  Integration tests for the bchjs. Only covers calls made to
-  rest.bitcoin.com.
-
-  TODO
-*/
-
-const chai = require('chai')
-const assert = chai.assert
-const BCHJS = require('../../../../src/bch-js')
-const bchjs = new BCHJS({ restURL: process.env.RESTURL })
-
-// Inspect utility used for debugging.
-const util = require('util')
-util.inspect.defaultOptions = {
-  showHidden: true,
-  colors: true,
-  depth: 3
-}
-
-describe('#rawtransaction', () => {
-  beforeEach(async () => {
-    if (process.env.IS_USING_FREE_TIER) await sleep(1500)
-  })
-
-  /*
-    Testing sentRawTransaction isn't really possible with an integration test,
-    as the endpoint really needs an e2e test to be properly tested. The tests
-    below expect error messages returned from the server, but at least test
-    that the server is responding on those endpoints, and responds consistently.
-  */
-  describe('sendRawTransaction', () => {
-    it('should send a single transaction hex', async () => {
-      try {
-        const hex =
-          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000'
-
-        await bchjs.RawTransactions.sendRawTransaction(hex)
-        // console.log(`result ${JSON.stringify(result, null, 2)}`)
-
-        assert.equal(true, false, 'Unexpected result!')
-      } catch (err) {
-        // console.log(`err: ${util.inspect(err)}`)
-
-        assert.hasAllKeys(err, ['error'])
-        assert.include(err.error, 'bad-txns-inputs-missingorspent')
-        // assert.include(err.error, 'Missing inputs')
-      }
-    })
-
-    it('should send an array of tx hexes', async () => {
-      try {
-        const hexes = [
-          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000',
-          '01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000'
-        ]
-
-        const result = await bchjs.RawTransactions.sendRawTransaction(hexes)
-        console.log(`result ${JSON.stringify(result, null, 2)}`)
-      } catch (err) {
-        // console.log(`err: ${util.inspect(err)}`)
-
-        assert.hasAllKeys(err, ['error'])
-        assert.include(err.error, 'bad-txns-inputs-missingorspent')
-        // assert.include(err.error, 'Missing inputs')
-      }
-    })
-  })
-})
-
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}

package/test/integration/chains/abc/utxo-integration.js

@@ -1,38 +0,0 @@
-/*
-  Integration tests for the utxo.js library.
-*/
-
-const assert = require('chai').assert
-
-const BCHJS = require('../../../../src/bch-js')
-const bchjs = new BCHJS()
-
-describe('#UTXO', () => {
-  beforeEach(async () => {
-    // sandbox = sinon.createSandbox()
-
-    if (process.env.IS_USING_FREE_TIER) await sleep(1500)
-  })
-
-  describe('#get', () => {
-    it('should get hydrated and filtered UTXOs for an address', async () => {
-      const addr = 'ecash:qr5c4hfy52zn87484cucvzle5pljz0gtr5vhtw9z09'
-      // const addr = 'simpleledger:qzv3zz2trz0xgp6a96lu4m6vp2nkwag0kvyucjzqt9'
-
-      const result = await bchjs.Utxo.get(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      // assert.isArray(result)
-      assert.property(result, 'address')
-      assert.property(result, 'bchUtxos')
-      assert.property(result, 'nullUtxos')
-      assert.property(result, 'slpUtxos')
-      assert.isArray(result.bchUtxos)
-      assert.isArray(result.nullUtxos)
-    })
-  })
-})
-
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}