@psf/bch-js 6.8.3 → 7.0.1

package/README.md

@@ -5,23 +5,21 @@
 [![License](https://img.shields.io/npm/l/@psf/bch-js)](https://github.com/Permissionless-Software-Foundation/bch-js/blob/master/LICENSE.md)
 [![js-standard-style](https://img.shields.io/badge/javascript-standard%20code%20style-green.svg?style=flat-square)](https://github.com/feross/standard) [![Join the chat at https://gitter.im/Permissionless-Software-Foundation/bch-js](https://badges.gitter.im/Permissionless-Software-Foundation/bch-js.svg)](https://gitter.im/Permissionless-Software-Foundation/bch-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[bch-js](https://www.npmjs.com/package/@psf/bch-js) is a JavaScript npm library for creating web and mobile apps that can interact with the Bitcoin Cash (BCH) and eCash (XEC) blockchains. bch-js contains a toolbox of handy tools, and an easy API for talking with [bch-api REST API](https://github.com/Permissionless-Software-Foundation/bch-api). [FullStack.cash](https://fullstack.cash) offers paid cloud access to bch-api. You can run your own infrastructure by following documentation on [CashStack.info](https://cashstack.info).
+[bch-js](https://www.npmjs.com/package/@psf/bch-js) is a JavaScript npm library for creating web and mobile apps that can interact with the Bitcoin Cash (BCH) blockchain. bch-js contains a toolbox of handy tools, and an easy API for talking with [psf-bch-api REST API](https://github.com/Permissionless-Software-Foundation/psf-bch-api). [FullStack.cash](https://fullstack.cash) offers paid cloud access to psf-bch-api. You can run your own infrastructure by following documentation on [CashStack.info](https://cashstack.info).
 
 ### Quick Start Videos:
 
-Here are two YouTube walk-through videos to help you get started:
+YouTube walk-through videos to help you get started:
 
 - [Introduction to bch-js and the bch-js-examples repository](https://youtu.be/GD2i1ZUiyrk)
-- [Working with the FullStack.cash JWT token](https://youtu.be/GD2i1ZUiyrk)
 
 ### Quick Links
 
 - [npm Library](https://www.npmjs.com/package/@psf/bch-js)
 - [Documentation](https://bchjs.fullstack.cash/)
 - [Examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
-- [bchn.fullstack.cash](https://bchn.fullstack.cash) - The REST API this library talks to by default.
+- [x402-bch.fullstack.cash](https://x402-bch.fullstack.cash) - The REST API this library talks to by default.
 - [FullStack.cash](https://fullstack.cash) - cloud-based infrastructure for application developers.
-- [FullStack.cash Account](https://fullstack.cash/login) - Get your API key to unlock increased rate limits.
 - [Permissionless Software Foundation](https://psfoundation.cash) - The organization that maintains this library.
 - [CashStack.info](https://cashstack.info) - bch-js is part of the Cash Stack, a JavaScript framework for writing web 2 and web 3 business applications.
 
@@ -31,42 +29,26 @@ Here are two YouTube walk-through videos to help you get started:
 
 - Instantiate the library in your code:
 
-```
-const BCHJS = require("@psf/bch-js")
+```javascript
+import BCHJS from "@psf/bch-js"
 let bchjs = new BCHJS() // Defaults to BCHN network.
 ```
 
 This library is intended to be paired with
-the [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) REST API, and the infrastructure provided by [FullStack.cash](https://fullstack.cash). The `restURL` property can be changed to work with different Bitcoin Cash networks:
+the [psf-bch-api](https://github.com/Permissionless-Software-Foundation/psf-bch-api) REST API, and the infrastructure provided by [FullStack.cash](https://fullstack.cash). The `restURL` property can be changed to work with different Bitcoin Cash networks:
 
-- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v5/
-- ABC Mainnet REST API server: https://abc.fullstack.cash/v5/
+- BCHN Mainnet REST API server: https://x402-bch.fullstack.cash/v7/
 - Check server status: https://metrics.fullstack.cash
 
-### API Key (JWT Token)
-
-The [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) REST API hosted by [FullStack.cash](https://fullstack.cash) uses JWT tokens to pay for increased
-rate limits when interacting with the back end server. See [this article](https://cashstack.info) if you want to understand the system-as-a-whole. The JWT token can be fed to bch-js _implicitly_ or _explicitly_.
-
-- Implicitly: bch-js will detect your JWT token if you set the `BCHJSTOKEN` environment variable.
-- Explicitly: You can directly feed in the JWT token with the `apiToken` property when instantiating the library. Here is an example:
-
-```
-const BCHJS = require("@psf/bch-js")
-let bchjs = new BCHJS({
-  restURL: 'https://bchn.fullstack.cash/v5/',
-  apiToken: 'eyJhbGciO...' // Your JWT token here.
-})
-```
 
-### Gatsby & Web Apps
+### Web Apps
 
 [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is a minimal wallet 'engine' that incorporates bch-js. It's compiled with Browserify for front end apps.
 
-[gatsby-theme-bch-wallet](https://github.com/Permissionless-Software-Foundation/gatsby-theme-bch-wallet) is a Gatsby Theme and [bch-wallet-starter](https://github.com/Permissionless-Software-Foundation/bch-wallet-starter) is a Gatsby Starter for building web wallets using minimal-slp-wallet.
-
 [This gist](https://gist.github.com/christroutner/6cb9d1b615f3f9363af79723157bc434) shows how to include minimal-slp-wallet into a basic web page without using a framework.
 
+[bch-wallet-web3-spa](https://github.com/Permissionless-Software-Foundation/bch-wallet-web3-spa) is a React web app template using bch-js and minimal-slp-wallet.
+
 ## Features
 
 - [ECMAScript 2017 standard JavaScript](https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017) used instead of TypeScript. Works

package/fix-docs-contrast.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Script to improve contrast in auto-generated API documentation
+# The code examples in api-doc use grey-on-grey colors that are hard to read.
+# This fixes that issue by improving text contrast for better readability.
+# Run this script *after* running 'npm run docs'
+
+FILE="./docs/assets/prism.css"
+
+# Check if file exists
+if [ ! -f "$FILE" ]; then
+  echo "Error: $FILE not found. Make sure to run 'npm run docs' first."
+  exit 1
+fi
+
+# Create a backup
+#cp "$FILE" "$FILE.bak"
+
+# Improve contrast:
+# - Change default text color from #ccc to #e8e8e8 (brighter light gray)
+# - Change comment color from #999 to #b5b5b5 (lighter for better visibility)
+# - Change punctuation color from #ccc to #e8e8e8 (consistent with text)
+
+# Replace default text color in code[class*="language-"] and pre[class*="language-"]
+sed -i 's/color: #ccc;/color: #000000;/g' "$FILE"
+
+# Replace comment color
+sed -i 's/color: #999;/color: #b5b5b5;/g' "$FILE"
+
+
+# Replace punctuation color (already handled by first sed, but explicit for clarity)
+# The punctuation token also uses #ccc, so the first sed command handles it
+
+echo "✓ Improved contrast in prism.css:"
+echo "  - Default text: #ccc → #e8e8e8"
+echo "  - Comments: #999 → #b5b5b5"
+echo "  - Punctuation: #ccc → #e8e8e8"
+

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@psf/bch-js",
-  "version": "6.8.3",
+  "version": "7.0.1",
+  "type": "module",
   "description": "A JavaScript library for working with Bitcoin Cash, eCash, and SLP Tokens",
   "author": "Chris Troutner <chris.troutner@gmail.com>",
   "contributors": [
@@ -9,25 +10,16 @@
   ],
   "main": "src/bch-js",
   "scripts": {
-    "test": "nyc mocha --trace-warnings --unhandled-rejections=strict --timeout 30000 test/unit/",
-    "test:integration": "npm run test:integration:bchn",
-    "test:integration:nft": "export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 -g '#nft1' test/integration/chains/bchn/slp.js",
-    "test:integration:abc": "export RESTURL=https://abc.fullstack.cash/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/abc/",
-    "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:bchn:slpdb": "export TESTSLP=1 && export RESTURL=https://bchn.fullstack.cash/v5/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:local:abc": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
-    "test:integration:local:bchn": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:local:testnet": "RESTURL=http://localhost:4000/v5/ mocha --timeout 30000 test/integration/chains/testnet",
-    "test:integration:decatur:bchn": "export RESTURL=http://192.168.2.129:3000/v5/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
-    "test:integration:decatur:abc": "export RESTURL=http://192.168.2.142:3000/v5/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
-    "test:integration:temp:bchn": "export RESTURL=http://157.90.174.219:3000/v5/ && mocha --timeout 30000 test/integration/",
-    "test:temp": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 -g '#Encryption' test/integration/",
-    "test:temp2": "mocha --timeout=30000 -g '#TransactionLib' test/unit/",
-    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v5/ && mocha --timeout 30000 -g '#DSProof' test/integration/chains/",
-    "test:temp4": "export RESTURL=http://localhost:3000/v5/ && mocha --timeout 30000 -g '#decodeOpReturn' test/integration/",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",
-    "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
+    "test": "c8 mocha --trace-warnings --unhandled-rejections=strict --timeout 30000 test/unit/",
+    "test:integration": "npm run test:integration:local:noauth",
+    "test:integration:nft": "export RESTURL=https://bchn.fullstack.cash/v6/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 -g '#nft1' test/integration/slp.js",
+    "test:integration:bchn": "export RESTURL=https://bchn.fullstack.cash/v6/ && export IS_USING_FREE_TIER=true && mocha --timeout 30000 test/integration/",
+    "test:integration:local:noauth": "export RESTURL=http://localhost:5942/v6/ && mocha --timeout 30000 test/integration/",
+    "test:integration:local:auth": "export RESTURL=http://5.78.147.3:5942/v6/ && export BCHJSBEARERTOKEN=temp01 && mocha --timeout 30000 test/integration/",
+    "test:integration:decatur": "export RESTURL=http://192.168.2.127:5942/v6/ && mocha --timeout 30000 test/integration/",
+    "test:integration:x402": "export RESTURL=http://localhost:5942/v6/ && export BCHJSWIF=L1eYaneXDDXy8VDig4Arwe8wYHbhtsA5wuQvwsKwhaYeneoZuKG4 && mocha --timeout 30000 test/integration/",
+    "coverage": "nyc --reporter=html mocha --timeout 25000 test/unit/",
+    "docs": "./node_modules/.bin/apidoc -i src/ -o docs && ./fix-docs-contrast.sh",
     "lint": "standard --env mocha --fix"
   },
   "license": "MIT",
@@ -42,45 +34,39 @@
     "@psf/bitcoincash-ops": "2.0.0",
     "@psf/bitcoincashjs-lib": "4.0.3",
     "@psf/coininfo": "4.0.0",
-    "axios": "1.12.2",
+    "axios": "1.13.2",
     "bc-bip68": "1.0.5",
-    "bchaddrjs-slp": "0.2.5",
+    "bchaddrjs-slp": "0.2.14",
     "bigi": "1.4.2",
-    "bignumber.js": "9.0.0",
-    "bip-schnorr": "0.3.0",
-    "bip38": "2.0.2",
-    "bip39": "3.0.2",
+    "bignumber.js": "9.3.1",
+    "bip-schnorr": "0.6.7",
+    "bip38": "3.1.1",
+    "bip39": "3.1.0",
     "bip66": "1.1.5",
-    "bitcoinjs-message": "2.0.0",
+    "bitcoinjs-message": "2.2.0",
     "bs58": "4.0.1",
     "ecashaddrjs": "1.0.7",
-    "ini": "1.3.8",
-    "randombytes": "2.0.6",
-    "safe-buffer": "5.1.2",
-    "satoshi-bitcoin": "1.0.4",
-    "slp-mdm": "0.0.6",
+    "ini": "6.0.0",
+    "randombytes": "2.1.0",
+    "safe-buffer": "5.2.1",
+    "satoshi-bitcoin": "1.0.5",
+    "slp-mdm": "0.0.7",
     "slp-parser": "0.0.4",
-    "wif": "2.0.6"
+    "wif": "2.0.6",
+    "x402-bch-axios": "1.1.1"
   },
   "devDependencies": {
-    "apidoc": "0.50.5",
-    "assert": "2.0.0",
+    "apidoc": "1.2.0",
+    "assert": "2.1.0",
+    "c8": "10.1.3",
     "chai": "4.1.2",
-    "coveralls": "3.0.2",
-    "eslint": "7.17.0",
-    "eslint-config-prettier": "7.1.0",
-    "eslint-config-standard": "16.0.3",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "3.3.1",
-    "eslint-plugin-standard": "4.0.0",
     "husky": "4.3.8",
     "lodash.clonedeep": "4.5.0",
-    "mocha": "9.2.1",
-    "node-mocks-http": "1.7.0",
+    "mocha": "11.7.5",
     "nyc": "15.1.0",
-    "semantic-release": "^19.0.2",
+    "semantic-release": "24.2.9",
     "sinon": "9.2.2",
-    "standard": "^16.0.4"
+    "standard": "17.1.2"
   },
   "apidoc": {
     "title": "bch-js",
@@ -90,5 +76,10 @@
     "hooks": {
       "pre-commit": "npm run lint"
     }
+  },
+  "standard": {
+    "parserOptions": {
+      "ecmaVersion": "latest"
+    }
   }
 }

package/src/address.js

@@ -1,7 +1,7 @@
-// const axios = require("axios")
-const Bitcoin = require('@psf/bitcoincashjs-lib')
-const cashaddr = require('ecashaddrjs')
-const coininfo = require('@psf/coininfo')
+// import axios from "axios"
+import Bitcoin from '@psf/bitcoincashjs-lib'
+import cashaddr from 'ecashaddrjs'
+import coininfo from '@psf/coininfo'
 
 class Address {
   constructor (config) {
@@ -10,22 +10,11 @@ class Address {
     else tmp.restURL = config.restURL
 
     this.restURL = tmp.restURL
-    this.apiToken = tmp.apiToken
     this.authToken = config.authToken
 
-    if (this.authToken) {
-      // Add Basic Authentication token to the authorization header.
-      this.axiosOptions = {
-        headers: {
-          authorization: this.authToken
-        }
-      }
-    } else {
-      // Add JWT token to the authorization header.
-      this.axiosOptions = {
-        headers: {
-          authorization: `Token ${this.apiToken}`
-        }
+    this.axiosOptions = {
+      headers: {
+        authorization: this.authToken
       }
     }
   }
@@ -312,28 +301,28 @@ class Address {
         return {
           prefix: 'bitcoincash',
           type: 'P2PKH',
-          hash: hash,
+          hash,
           format: 'legacy'
         }
       case info.main.versions.scripthash:
         return {
           prefix: 'bitcoincash',
           type: 'P2SH',
-          hash: hash,
+          hash,
           format: 'legacy'
         }
       case info.test.versions.public:
         return {
           prefix: 'bchtest',
           type: 'P2PKH',
-          hash: hash,
+          hash,
           format: 'legacy'
         }
       case info.test.versions.scripthash:
         return {
           prefix: 'bchtest',
           type: 'P2SH',
-          hash: hash,
+          hash,
           format: 'legacy'
         }
       default:
@@ -871,4 +860,4 @@ class Address {
   }
 }
 
-module.exports = Address
+export default Address

package/src/bch-js.js

@@ -7,36 +7,45 @@
 */
 
 // bch-api mainnet.
-const DEFAULT_REST_API = 'https://api.fullstack.cash/v5/'
 // const DEFAULT_REST_API = "http://localhost:3000/v5/"
 
+// Global npm libraries
+import axios from 'axios'
+import {
+  createSigner,
+  withPaymentInterceptor,
+  createPaymentHeader,
+  selectPaymentRequirements
+} from 'x402-bch-axios'
+
 // local deps
-const BitcoinCash = require('./bitcoincash')
-const Crypto = require('./crypto')
-const Util = require('./util')
-const Blockchain = require('./blockchain')
-const Control = require('./control')
-const Generating = require('./generating')
-const Mining = require('./mining')
-const RawTransactions = require('./raw-transactions')
-const Mnemonic = require('./mnemonic')
-const Address = require('./address')
-const HDNode = require('./hdnode')
-const TransactionBuilder = require('./transaction-builder')
-const ECPair = require('./ecpair')
-const Script = require('./script')
-const Price = require('./price')
-const Schnorr = require('./schnorr')
-const SLP = require('./slp/slp')
-const Encryption = require('./encryption')
-const Utxo = require('./utxo')
-const Transaction = require('./transaction')
-const DSProof = require('./dsproof')
-const Ecash = require('./ecash')
+import BitcoinCash from './bitcoincash.js'
+import Crypto from './crypto.js'
+import Util from './util.js'
+import Blockchain from './blockchain.js'
+import Control from './control.js'
+import Generating from './generating.js'
+import Mining from './mining.js'
+import RawTransactions from './raw-transactions.js'
+import Mnemonic from './mnemonic.js'
+import Address from './address.js'
+import HDNode from './hdnode.js'
+import TransactionBuilder from './transaction-builder.js'
+import ECPair from './ecpair.js'
+import Script from './script.js'
+import Price from './price.js'
+import Schnorr from './schnorr.js'
+import SLP from './slp/slp.js'
+import Encryption from './encryption.js'
+import Utxo from './utxo.js'
+import Transaction from './transaction.js'
+import DSProof from './dsproof.js'
+import Ecash from './ecash.js'
 
 // Indexers
-const Electrumx = require('./electrumx')
-const PsfSlpIndexer = require('./psf-slp-indexer')
+import Electrumx from './electrumx.js'
+import PsfSlpIndexer from './psf-slp-indexer.js'
+const DEFAULT_REST_API = 'https://api.fullstack.cash/v6/'
 
 class BCHJS {
   constructor (config) {
@@ -47,39 +56,55 @@ class BCHJS {
       this.restURL = process.env.RESTURL
     } else this.restURL = DEFAULT_REST_API
 
-    // Retrieve the apiToken
-    this.apiToken = '' // default value.
-    if (config && config.apiToken && config.apiToken !== '') {
-      this.apiToken = config.apiToken
-    } else if (process.env.BCHJSTOKEN && process.env.BCHJSTOKEN !== '') {
-      this.apiToken = process.env.BCHJSTOKEN
+    // Retrieve the Bearer token for simple token authentication.
+    this.bearerToken = '' // default value.
+    if (config && config.bearerToken && config.bearerToken !== '') {
+      this.bearerToken = config.bearerToken
+    } else if (process.env.BCHJSBEARERTOKEN && process.env.BCHJSBEARERTOKEN !== '') {
+      this.bearerToken = process.env.BCHJSBEARERTOKEN
     }
 
-    // Retrieve the Basic Authentication password.
-    this.authPass = '' // default value.
-    if (config && config.authPass && config.authPass !== '') {
-      this.authPass = config.authPass
-    } else if (process.env.BCHJSAUTHPASS && process.env.BCHJSAUTHPASS !== '') {
-      this.authPass = process.env.BCHJSAUTHPASS
+    // Generate the authentication token for the authorization header.
+    this.authToken = ''
+    if (this.bearerToken) {
+      this.authToken = `Bearer ${this.bearerToken}`
     }
 
-    // Generate a Basic Authentication token from an auth password
-    this.authToken = ''
-    if (this.authPass) {
-      // console.log(`bch-js initialized with authPass: ${this.authPass}`)
-      // Generate the header for Basic Authentication.
-      const combined = `fullstackcash:${this.authPass}`
-      const base64Credential = Buffer.from(combined).toString('base64')
-      this.authToken = `Basic ${base64Credential}`
+    // x402 payment configuration
+    // If a WIF private key is provided, enable x402 automatic payment handling
+    this.wif = ''
+    if (config && config.wif && config.wif !== '') {
+      this.wif = config.wif
+    } else if (process.env.BCHJSWIF && process.env.BCHJSWIF !== '') {
+      this.wif = process.env.BCHJSWIF
     }
+    this.paymentAmountSats = (config && config.paymentAmountSats) || 2000 * 10
+    this.bchServerURL = (config && config.bchServerURL) || 'https://free-bch.fullstack.cash'
 
     const libConfig = {
       restURL: this.restURL,
-      apiToken: this.apiToken,
       authToken: this.authToken
     }
 
-    // console.log(`apiToken: ${this.apiToken}`)
+    // If WIF is provided, create an axios instance with x402 payment interceptor
+    // Otherwise, let sub-modules use their own axios import for backwards compatibility
+    if (this.wif) {
+      let axiosInstance = axios.create({
+        baseURL: this.restURL,
+        headers: {
+          authorization: this.authToken
+        }
+      })
+
+      const signer = createSigner(this.wif, this.paymentAmountSats)
+      axiosInstance = withPaymentInterceptor(
+        axiosInstance,
+        signer,
+        { bchServerURL: this.bchServerURL }
+      )
+
+      libConfig.axios = axiosInstance
+    }
 
     // ElectrumX indexer
     this.Electrumx = new Electrumx(libConfig)
@@ -117,7 +142,15 @@ class BCHJS {
     this.eCash = new Ecash()
 
     this.PsfSlpIndexer = new PsfSlpIndexer(libConfig)
+
+    // Expose x402 helper functions for advanced use cases
+    this.x402 = {
+      createSigner,
+      withPaymentInterceptor,
+      createPaymentHeader,
+      selectPaymentRequirements
+    }
   }
 }
 
-module.exports = BCHJS
+export default BCHJS

package/src/bitcoincash.js

@@ -1,13 +1,12 @@
-const Bitcoin = require('@psf/bitcoincashjs-lib')
-const sb = require('satoshi-bitcoin')
-const bitcoinMessage = require('bitcoinjs-message')
-const bs58 = require('bs58')
-const bip21 = require('@psf/bip21')
-const coininfo = require('@psf/coininfo')
-const bip38 = require('bip38')
-const wif = require('wif')
-
-const Buffer = require('safe-buffer').Buffer
+import Bitcoin from '@psf/bitcoincashjs-lib'
+import sb from 'satoshi-bitcoin'
+import bitcoinMessage from 'bitcoinjs-message'
+import bs58 from 'bs58'
+import bip21 from '@psf/bip21'
+import coininfo from '@psf/coininfo'
+import bip38 from 'bip38'
+import wif from 'wif'
+import { Buffer } from 'safe-buffer'
 
 class BitcoinCash {
   constructor (address) {
@@ -519,4 +518,4 @@ class BitcoinCash {
   }
 }
 
-module.exports = BitcoinCash
+export default BitcoinCash