@psf/bch-js 6.8.2 → 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"
+