x402-bch-axios 1.0.0

package/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+
+# A special property that should be specified at the top of the file outside of
+# any sections. Set to true to stop .editor config file search on current file
+root = true
+
+[*]
+# Indentation style
+# Possible values - tab, space
+indent_style = space
+
+# Indentation size in single-spaced characters
+# Possible values - an integer, tab
+indent_size = 2
+
+# Line ending file format
+# Possible values - lf, crlf, cr
+end_of_line = lf
+
+# File character encoding
+# Possible values - latin1, utf-8, utf-16be, utf-16le
+charset = utf-8
+
+# Denotes whether to trim whitespace at the end of lines
+# Possible values - true, false
+trim_trailing_whitespace = true
+
+# Denotes whether file should end with a newline
+# Possible values - true, false
+insert_final_newline = true

package/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": "standard",
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 8
+  }
+}

package/.on-save.json

@@ -0,0 +1,8 @@
+[
+  {
+    "srcDir": "",
+    "destDir": "",
+    "files": "**/*.js",
+    "command": "npm run lint"
+  }
+]

package/.travis.yml

@@ -0,0 +1,33 @@
+# This is a node.js v8+ JavaScript project
+language: node_js
+node_js:
+  - "10"
+
+# Build on Ubuntu Trusty (14.04)
+# https://docs.travis-ci.com/user/reference/trusty/#javascript-and-nodejs-images
+dist: xenial
+sudo: required
+
+# Use Docker
+services:
+  - docker
+
+before_install:
+  #- npm install -g mocha
+
+# https://github.com/greenkeeperio/greenkeeper-lockfile/issues/156
+#install: case $TRAVIS_BRANCH in greenkeeper*) npm i;; *) npm ci;; esac;
+install:
+  - npm install
+
+script: "npm run test"
+
+# Send coverage data to Coveralls
+after_success:
+  - npm run coverage
+
+deploy:
+  provider: script
+  skip_cleanup: true
+  script:
+    - npx semantic-release

package/LICENSE.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2025 Chris Troutner <chris.troutner@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# x402-bch-axios
+
+This is a placeholder for what will become the x402-bch-axios library.
+
+# Licence
+
+[MIT](LICENSE.md)

package/apidoc.json

@@ -0,0 +1,3 @@
+{
+  "sampleUrl": null
+}

package/index.js

@@ -0,0 +1,23 @@
+/*
+  An npm JavaScript library for front end web apps. Implements a minimal
+  Bitcoin Cash wallet.
+*/
+
+/* eslint-disable no-async-promise-executor */
+
+// Global npm libraries
+import BCHJS from '@psf/bch-js'
+
+// Local libraries
+import Util from './lib/util.js'
+const util = new Util()
+
+class BoilerplateLib {
+  constructor () {
+    // Encapsulate dependencies
+    this.bchjs = new BCHJS()
+    this.util = util
+  }
+}
+
+export default BoilerplateLib

package/lib/util.js

@@ -0,0 +1,46 @@
+/*
+  An example of a typical utility library. Things to notice:
+  - This library is exported as a Class.
+  - External dependencies are embedded into the class 'this' object: this.bchjs
+*/
+
+'use strict'
+
+// Global npm libraries
+import BCHJS from '@psf/bch-js'
+
+class UtilLib {
+  constructor () {
+    // Encapsulate dependencies
+    this.bchjs = new BCHJS()
+
+    // Bind 'this' object to all class methods
+    this.getBchData = this.getBchData.bind(this)
+  }
+
+  async getBchData (addr) {
+    try {
+      // Validate Input
+      if (typeof addr !== 'string') throw new Error('Address must be a string')
+
+      const balance = await this.bchjs.Electrumx.balance(addr)
+
+      const utxos = await this.bchjs.Electrumx.utxo(addr)
+
+      const bchData = {
+        balance: balance.balance,
+        utxos: utxos.utxos
+      }
+      // console.log(`bchData: ${JSON.stringify(bchData, null, 2)}`)
+
+      return bchData
+    } catch (err) {
+      // Optional log to indicate the source of the error. This would normally
+      // be written with a logging app like Winston.
+      console.log('Error in util.js/getBalance()')
+      throw err
+    }
+  }
+}
+
+export default UtilLib

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "x402-bch-axios",
+  "version": "1.0.0",
+  "description": "Axios wrapper for x402 payment protocol with Bitcoin Cash (BCH) support.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "start": "node index.js",
+    "test": "npm run lint && TEST=unit c8 mocha test/unit/",
+    "test:integration": "mocha --timeout 25000 test/integration/",
+    "lint": "standard --env mocha --fix",
+    "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
+    "coverage": "c8 --reporter=html mocha test/unit/ --exit"
+  },
+  "keywords": [
+    "bitcoin",
+    "bitcoin cash",
+    "x402",
+    "javascript",
+    "cryptocurrency"
+  ],
+  "author": "Chris Troutner <chris.troutner@gmail.com>",
+  "license": "MIT",
+  "apidoc": {
+    "title": "x402-bch-axios",
+    "url": "localhost:5000"
+  },
+  "repository": "x402-bch/x402-bch-axios",
+  "dependencies": {
+    "@psf/bch-js": "6.8.3",
+    "apidoc": "1.2.0"
+  },
+  "devDependencies": {
+    "c8": "10.1.3",
+    "chai": "6.2.0",
+    "husky": "9.1.7",
+    "lodash.clonedeep": "4.5.0",
+    "mocha": "11.7.5",
+    "semantic-release": "25.0.2",
+    "sinon": "21.0.0",
+    "standard": "17.1.2"
+  },
+  "release": {
+    "publish": [
+      {
+        "path": "@semantic-release/npm",
+        "npmPublish": true
+      }
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint"
+    }
+  }
+}

package/test/integration/util-integration.js

@@ -0,0 +1,33 @@
+/*
+  Integration tests for the util.js utility library.
+*/
+
+// npm libraries
+import chai from 'chai'
+
+// Unit under test
+import UtilLib from '../../lib/util.js'
+
+// Locally global variables.
+const assert = chai.assert
+const uut = new UtilLib()
+
+describe('#util.js', () => {
+  describe('#getBchData', () => {
+    it('should get BCH data on an address', async () => {
+      const addr = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+
+      const bchData = await uut.getBchData(addr)
+
+      // Assert that top-level properties exist.
+      assert.property(bchData, 'balance')
+      assert.property(bchData, 'utxos')
+
+      // Assert essential UTXOs properties exist.
+      assert.isArray(bchData.utxos)
+      assert.property(bchData.utxos[0], 'tx_pos')
+      assert.property(bchData.utxos[0], 'tx_hash')
+      assert.property(bchData.utxos[0], 'value')
+    })
+  })
+})

package/test/unit/mocks/util-mocks.js

@@ -0,0 +1,30 @@
+/*
+  A mocking library for util.js unit tests.
+  A mocking library contains data to use in place of the data that would come
+  from an external dependency.
+*/
+
+'use strict'
+
+const mockBalance = {
+  success: true,
+  balance: {
+    confirmed: 1000,
+    unconfirmed: 0
+  }
+}
+
+const mockUtxos = {
+  success: true,
+  utxos: [
+    {
+      height: 601861,
+      tx_hash:
+        '6181c669614fa18039a19b23eb06806bfece1f7514ab457c3bb82a40fe171a6d',
+      tx_pos: 0,
+      value: 1000
+    }
+  ]
+}
+
+export default { mockBalance, mockUtxos }

package/test/unit/util-unit.js

@@ -0,0 +1,69 @@
+/*
+  Unit tests for the util.js utility library.
+*/
+
+// npm libraries
+import { assert } from 'chai'
+import sinon from 'sinon'
+import cloneDeep from 'lodash.clonedeep'
+
+// Mocking data libraries.
+import mockDataLib from './mocks/util-mocks.js'
+
+// Unit under test
+import UtilLib from '../../lib/util.js'
+
+describe('#util.js', () => {
+  let sandbox
+  let mockData
+  let uut
+
+  beforeEach(() => {
+    // Restore the sandbox before each test.
+    sandbox = sinon.createSandbox()
+
+    // Clone the mock data.
+    mockData = cloneDeep(mockDataLib)
+
+    uut = new UtilLib()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#getBchData', () => {
+    it('should throw error if address is not a string', async () => {
+      try {
+        const addr = 1234
+
+        await uut.getBchData(addr)
+
+        assert.equal(true, false, 'unexpected result')
+      } catch (err) {
+        assert.include(err.message, 'Address must be a string')
+      }
+    })
+
+    it('should get BCH data on an address', async () => {
+      // Mock external dependencies.
+      sandbox
+        .stub(uut.bchjs.Electrumx, 'balance')
+        .resolves(mockData.mockBalance)
+      sandbox.stub(uut.bchjs.Electrumx, 'utxo').resolves(mockData.mockUtxos)
+
+      const addr = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+
+      const bchData = await uut.getBchData(addr)
+      // console.log(`bchData: ${JSON.stringify(bchData, null, 2)}`)
+
+      // Assert that top-level properties exist.
+      assert.property(bchData, 'balance')
+      assert.property(bchData, 'utxos')
+
+      // Assert essential UTXOs properties exist.
+      assert.isArray(bchData.utxos)
+      assert.property(bchData.utxos[0], 'tx_pos')
+      assert.property(bchData.utxos[0], 'tx_hash')
+      assert.property(bchData.utxos[0], 'value')
+    })
+  })
+})