@bsv/wallet-toolbox 1.1.12 → 1.1.14

package/.github/workflows/push.yaml

@@ -15,7 +15,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - name: Cache node_modules
       id: cache-modules
-      uses: actions/cache@v1
+      uses: actions/cache@v4
       with:
         path: node_modules
         key: ${{ matrix.node-version }}-${{ runner.OS }}-build-${{ hashFiles('package.json') }}
@@ -46,7 +46,7 @@ jobs:
         NODE_AUTH_TOKEN: ${{ secrets.BSV_NPM_TOKEN }}
     - name: Cache node_modules
       id: cache-modules
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: node_modules
         key: 20.x-${{ runner.OS }}-build-${{ hashFiles('package.json') }}

package/README.md

@@ -2,39 +2,20 @@
 
 BSV BLOCKCHAIN | BRC100 Conforming Wallet, Wallet Storage and Wallet Signer Components
 
-The BSV Wallet Toolbox builds on the [SDK](https://bitcoin-sv.github.io/ts-sdk) to add support for:
-
-    - Persistent UTXO and transaction history management
-    - Standardized key derivation protocols.
-
-# Table of Contents
-
-- [Objective](#objective)
-- [Getting Started](#getting-started)
-- [Features \& Deliverables](#features--deliverables)
-- [Documentation](#documentation)
-- [Contribution Guidelines](#contribution-guidelines)
-- [Support \& Contacts](#support--contacts)
-- [License](#license)
-
 ## Objective
 
-The BSV Wallet Toolbox Project aims to support building sophisticated applications and services on the BSV Blockchain technology stack.
+The BSV Wallet Toolbox builds on the [SDK](https://bitcoin-sv.github.io/ts-sdk).
+
+It aims to support building sophisticated applications and services on the BSV Blockchain technology stack.
 
 By providing interlocking building blocks for persistent storage and protocol based key derivation, it serves as an essential toolbox for developers looking to build on the BSV Blockchain.
 
 ## Documentation
 
 [The Docs](https://bitcoin-sv.github.io/wallet-toolbox) are available here on Github pages.  
-[Example code](https://docs.bsvblockchain.org/guides/sdks/ts/examples) is available over on our gitbook.  
 
 The Toolbox is richly documented with code-level annotations. This should show up well within editors like VSCode.  
 
-
-## Features & Deliverables
-
-- **Feature1**: Summary of feature1.
-
 ## Contribution Guidelines
 
 We're always looking for contributors to help us improve the SDK. Whether it's bug reports, feature requests, or pull requests - all contributions are welcome.

package/docs/README.md

@@ -2,19 +2,25 @@
 
 The documentation is split into various pages, each covering a set of related functionality. The pages are as follows:
 
-- [Getting Started](#getting-started) -
-- [Setup](./setup.md) —
-- [Wallet](./wallet.md) —
-- [Client](./client.md) —
-- [Storage](./storage.md) —
-- [Services](./services.md) —
-- [Monitor](./monitor.md) —
+- [Examples](https://bitcoin-sv.github.io/wallet-toolbox-examples/) - Getting started and specialized examples.
+- [Setup](./setup.md) — Classes supporting wallet setup, experimentation and customization.
+- [Wallet](./wallet.md) — Top level `Wallet` class and related APIs.
+- [Client](./client.md) — Browser deployment friendly toolbox subset.
+- [Storage](./storage.md) — Wallet data persistent storage classes and related APIs.
+- [Services](./services.md) — Support for abstracted external network services.
+- [Monitor](./monitor.md) — Background task manager for wallet action validation and processing.
 
-## Swagger
+## Open API
 
 [BRC-100](https://brc.dev/100) defines a Unified, Vendor-Neutral, Unchanging, and Open BSV Blockchain Standard Wallet-to-Application Interface which is implemented in this library within the WalletClient class. The API is laid out here as a swagger openapi document to offer a fast-track to understanding the interface which is implemented across multiple substrates. The JSON api is generally considered a developer friendly introduction to the WalletClient, where an binary equivalent ABI may be preferred for production use cases.
 
-- [Wallet JSON API Swagger](https://bitcoin-sv.github.io/ts-sdk/swagger)
+- [Wallet API Swagger UI](https://bitcoin-sv.github.io/ts-sdk/swagger)
+
+## Open RPC
+
+StorageClient implements the WalletStorageProvider interface over https using a JSON-RPC api which can be explored using the JSight UI.
+
+- [StorageClient JSight UI](https://bitcoin-sv.github.io/wallet-toolbox/open-rpc)
 
 ## Getting Started
 
@@ -76,4 +82,4 @@ const rw = await wallet.internalizeAction(args)
 console.log(rw.accepted)
 ```
 
-For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).
+[Return to Top](#bsv-wallet-toolbox-api-documentation)