@bopen-io/wallet-toolbox 1.7.18

package/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(cat:*)",
+      "Bash(git -C /Users/satchmo/wallet-toolbox log --oneline -20 --all -- mobile/package.json)",
+      "Bash(git -C /Users/satchmo/wallet-toolbox log --oneline -5 --all -- \"*.npmignore\")",
+      "Bash(git -C /Users/satchmo/wallet-toolbox log --oneline)"
+    ]
+  }
+}

package/.env.template

@@ -0,0 +1,22 @@
+# set to empty if MySQL is available for testing and database schemas exist, set to 1 to not test against MySQL
+NOMYSQL = 1
+# set to empty to not run slow and long running tests. set to 1 to run them.
+RUNSLOWTESTS =
+
+# this will be getEnv('main').identityKey property value
+MY_MAIN_IDENTITY = '028cb1d772b59157ee2d72cce30c515e4c3312e5e73ea111ff689dac88d93aaeb8'
+# this will be getEnv('main').userId property value
+MY_MAIN_USERID = 83
+
+# this will be getEnv('test').identityKey property value
+MY_TEST_IDENTITY = '03ac2d10bdb0023f4145cc2eba2fcd2ad3070cb2107b0b48170c46a9440e4cc3fe'
+# this will be getEnv('test').userId property value
+MY_TEST_USERID = 6
+
+# JSON.stringified of object who's keys are identityKey values and the values are corresponding private keys.
+DEV_KEYS = '{
+    "03ac2d10bdb0023f4145cc2eba2fcd2ad3070cb2107b0b48170c46a9440e4cc3fe": "<private key as 32 hex bytes>"
+}'
+
+NOMYSQL = 1
+RUNSLOWTESTS =

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Report a bug or an issue you've found with `@bsv/sdk`.
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+## Bug Description
+
+Briefly describe the bug/issue you've encountered.
+
+## Steps to Reproduce
+
+1. Step 1
+2. Step 2
+3. ...
+
+## Expected Behavior
+
+What should have happened if the bug hadn't occurred?
+
+## Actual Behavior
+
+What actually happened?
+
+## Stack Traces or Screenshots
+
+If applicable, add screenshots or stack traces to help explain the issue.
+
+## Environment
+
+- OS: [e.g. MacOS, Windows]
+- Node version: [e.g. 12.20]
+- `@bsv/sdk` version: [e.g. 1.2.3]
+
+## Additional Information
+
+Provide any additional context or information about the bug.

package/.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,24 @@
+---
+name: Discussion
+about: Propose a discussion or seek clarification about a feature or topic.
+title: "[DISCUSSION]"
+labels: discussion
+assignees: ''
+
+---
+
+## Summary
+
+Briefly describe the topic you'd like to discuss.
+
+## Motivation
+
+Why do you believe this to be important?
+
+## Description
+
+Provide a detailed description or elaborate on your topic.
+
+## Additional References
+
+Provide any additional articles, links, or context that would help facilitate the discussion.

package/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Description of Changes
+
+Provide a brief description of the changes you've made.
+
+## Linked Issues / Tickets
+
+Reference any related issues or tickets, e.g. "Closes #123".
+
+## Testing Procedure
+
+Describe the tests you've added or any testing steps you've taken.
+
+- [ ] I have added new unit tests
+- [ ] All tests pass locally
+- [ ] I have tested manually in my local environment
+
+## Checklist:
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have run `npm run doc` and `npm run lint` one final time before requesting a review
+- [ ] I have run `npm version patch` so that my changes will trigger a new version to be released when they are merged

package/.github/workflows/push.yaml

@@ -0,0 +1,145 @@
+name: Test and Publish Package
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22, 24]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: test
+    # Only run on push to master/main, not on PRs
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main')
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+          always-auth: false
+
+      - run: npm ci
+      - run: npm run build --if-present
+
+      - name: Sync client version with root
+        run: |
+          ROOT_VERSION=$(node -p "require('./package.json').version")
+          cd client
+          npm version $ROOT_VERSION --no-git-tag-version --allow-same-version
+          cd ..
+
+      - name: Sync mobile version with root
+        run: |
+          ROOT_VERSION=$(node -p "require('./package.json').version")
+          cd mobile
+          npm version $ROOT_VERSION --no-git-tag-version --allow-same-version
+          cd ..
+
+      - name: Check if root version already published
+        id: check-root-version
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+
+          echo "Root Package: $PACKAGE_NAME@$PACKAGE_VERSION"
+
+          # Check if this version exists on npm
+          if npm view "$PACKAGE_NAME@$PACKAGE_VERSION" version 2>/dev/null; then
+            echo "Root version $PACKAGE_VERSION already published"
+            echo "should_publish_root=false" >> $GITHUB_OUTPUT
+          else
+            echo "Root version $PACKAGE_VERSION not yet published"
+            echo "should_publish_root=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish root to npm
+        if: steps.check-root-version.outputs.should_publish_root == 'true'
+        run: npm publish --access public
+
+      - name: Skip publishing root
+        if: steps.check-root-version.outputs.should_publish_root == 'false'
+        run: echo "Skipping publish root - version already exists on npm"
+
+      - name: Check if client version already published
+        id: check-client-version
+        run: |
+          cd client
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+
+          echo "Client Package: $PACKAGE_NAME@$PACKAGE_VERSION"
+
+          # Check if this version exists on npm
+          if npm view "$PACKAGE_NAME@$PACKAGE_VERSION" version 2>/dev/null; then
+            echo "Client version $PACKAGE_VERSION already published"
+            echo "should_publish_client=false" >> $GITHUB_OUTPUT
+          else
+            echo "Client version $PACKAGE_VERSION not yet published"
+            echo "should_publish_client=true" >> $GITHUB_OUTPUT
+          fi
+          cd ..
+
+      - name: Publish client to npm
+        if: steps.check-client-version.outputs.should_publish_client == 'true'
+        run: |
+          cd client
+          npm publish --access public
+          cd ..
+
+      - name: Skip publishing client
+        if: steps.check-client-version.outputs.should_publish_client == 'false'
+        run: echo "Skipping publish client - version already exists on npm"
+
+      - name: Check if mobile version already published
+        id: check-mobile-version
+        run: |
+          cd mobile
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+
+          echo "Mobile Package: $PACKAGE_NAME@$PACKAGE_VERSION"
+
+          # Check if this version exists on npm
+          if npm view "$PACKAGE_NAME@$PACKAGE_VERSION" version 2>/dev/null; then
+            echo "Mobile version $PACKAGE_VERSION already published"
+            echo "should_publish_mobile=false" >> $GITHUB_OUTPUT
+          else
+            echo "Mobile version $PACKAGE_VERSION not yet published"
+            echo "should_publish_mobile=true" >> $GITHUB_OUTPUT
+          fi
+          cd ..
+
+      - name: Publish mobile to npm
+        if: steps.check-mobile-version.outputs.should_publish_mobile == 'true'
+        run: |
+          cd mobile
+          npm publish --access public
+          cd ..
+
+      - name: Skip publishing mobile
+        if: steps.check-mobile-version.outputs.should_publish_mobile == 'false'
+        run: echo "Skipping publish mobile - version already exists on npm"

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid",
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf"
+}

package/CHANGELOG.md

@@ -0,0 +1,280 @@
+# wallet-toolbox Significant Changes History
+
+This document captures the history of significant changes to the wallet-toolbox repository.
+The git commit history contains the details but is unable to draw
+attention to changes that materially alter behavior or extend functionality.
+
+## wallet-toolbox 1.7.18
+
+- Fork published under @bopen-io scope as @bopen-io/wallet-toolbox
+- Also publishes @bopen-io/wallet-toolbox-client and @bopen-io/wallet-toolbox-mobile
+
+## wallet-toolbox 1.7.17
+
+- Fix push.yaml to sync versions, correct root package contents (no mobile), and publish client and mobile
+
+## wallet-toolbox 1.7.15
+
+- Fix specOpInvalidChange to always ignore unbasketted outputs.
+- Update dependency to bsv/sdk 1.9.24
+
+## wallet-toolbox 1.7.13
+
+- Fix moreSatoshisNeeded amount in WERR_INSUFFICIENT_FUNDS (was releasing allocated change before saving value).
+
+## wallet-toolbox 1.7.12
+
+- Add pluggable permissions module system (`PermissionsModule` interface) for custom P-basket and P-protocol handlers
+- Add `permissionModules` config option to `WalletPermissionsManager` for registering scheme-specific modules
+- Support request/response transformation chaining across multiple modules
+- Add comprehensive test suite covering P-module delegation, chaining, and error handling
+
+## wallet-toolbox 1.7.11
+
+- Change logging tweaks.
+
+## wallet-toolbox 1.7.6
+
+- Change `WalletLogger` json name from logs[0]
+
+## wallet-toolbox 1.7.5
+
+- Add `WalletLogger` flushFormat property.
+
+## wallet-toolbox 1.7.4
+
+- Really Add `WalletLogger` to package exports (client, and complete).
+
+(Still have to update top level index.all importing index.client importing index.mobile).
+
+## wallet-toolbox 1.7.3
+
+- Add `WalletLogger` to package exports (mobile, client, and complete).
+
+## wallet-toolbox 1.7.2
+
+- Add `WalletLogger` aggregate logger class for use by `Wallet`, `StorageClient` and `StorageServer`,
+  implementing the `WalletLoggerInterface` released in latest `@bsv/sdk`.
+- Delete `validationHelpers.ts` from `sdk` folder and update code to reference functions and types moved to
+  `Validation` namespace exported from `@bsv/sdk`.
+
+## wallet-toolbox 1.7.1
+
+- Add optional skipInvalidProofs to StorageGetBeefOptions
+
+## wallet-toolbox 1.7.0
+
+- Update dependency to @bsv/sdk 1.9.3, makinig this new version a minor bump as well
+- Add optional chaintracker to StorageGetBeefOptions
+- Add WERR_INVALID_MERKLE_ROOT exception (code 8).
+- Change add spendable value to WERR_INVALID_PARAMETER message thrown by createAction
+
+## wallet-toolbox 1.6.43
+
+- Change WERR toJson methods to add code property for HTTPWalletJSON rethrow support.
+
+## wallet-toolbox 1.6.42
+
+- Change WalletPermissionsManager changes
+
+## wallet-toolbox 1.6.41
+
+- Change WalletPermissionsManager changes
+
+## wallet-toolbox 1.6.40
+
+- Change correct import of WERR_REVIEW_ACTIONS in createActions.ts to wallet-toolbox package.
+
+## wallet-toolbox 1.6.39
+
+- Change WalletError unknownToJson error to resolve unknown toJson error.
+
+## wallet-toolbox 1.6.38
+
+- Update to @bsv/sdk 1.8.10
+
+## wallet-toolbox 1.6.37
+
+- Change validationHelpers validateBase64String now polynomial time, sync changes on bsv/sdk
+- Change log throw of dummy WERR_REVIEW_ACTIONS.
+
+## wallet-toolbox 1.6.35
+
+- Change specOp WERR_REVIEW_ACTIONS throw to storage layer.
+
+## wallet-toolbox 1.6.34
+
+- Change StorageServer / StorageClient to rethrow WERR errors including WERR_REVIEW_ACTIONS
+- Change ChaintracksChainTracker to default to new public services.
+- Add WalletError.test.ts and resolve issues related to WERR_errors
+- Add retry support to ChaintracksFetch download method to handle WoC rate limits.
+
+## wallet-toolbox 1.6.33
+
+- Add schema migration: outputs spendable index.
+
+## wallet-toolbox 1.6.31
+
+- Change throw WERR_REVIEW_ACTIONS if an input's spentBy is valid
+
+## wallet-toolbox 1.6.30
+
+- Add txid index to proven_tx_reqs table in storage knex schema
+
+## wallet-toolbox 1.6.29
+
+- Add txid index to transactions table in storage knex schema
+
+## wallet-toolbox 1.6.28
+
+- Fix The method `Services`.`getHeaderForHeight` must serialize four byte values LE
+
+## wallet-toolbox 1.6.27
+
+- Change internalizeAction Improve handling of atomic beefs containing transactions unknown to storage.
+
+## wallet-toolbox 1.6.26
+
+- Update to @bsv/sdk 1.8.2
+
+## wallet-toolbox 1.6.25
+
+- Change `WalletPermissionsManager` coalescePermissionTokens logic
+
+## wallet-toolbox 1.6.24
+
+- Add Monitor TaskReorg to handle Chaintracks reorg events, updating ProvenTxs with new merkle proofs.
+- Add deactivatedHeaders as optional 4th param to `ReorgListener` in `ChaintracksClientApi`
+- Add `ChaintracksStorageApi` `InsertHeaderResult` now includes deactivatedHeaders
+- Add `createKnexChaintracks` exported function.
+- Add `createNoDbChaintracks` exported function.
+- Add `index.mobile.ts` to Chaintracks
+
+- Change `validBulkHeaderFilesByFileHash` updated for 2025-10-06 Babbage CDN update.
+
+## wallet-toolbox 1.6.22
+
+- Change verifyTruthy => validateSatoshis during input validation for createAction.
+
+## wallet-toolbox 1.6.20
+
+- Add DevConsoleInteractor
+
+## wallet-toolbox 1.6.6
+
+- Add robots.txt to StorageServer
+
+## wallet-toolbox 1.6.5
+
+- Add ChaintracksStorageIdb to support in browser header storage.
+- Cleanup createDefaultWalletServicesOptions, add comments.
+- Some breaking API changes to Chaintracks storage and ingestors.
+
+## wallet-toolbox 1.6.4
+
+- Resolve client dependencies for metanet-desktop, exclude ChaintracksService and Ws ingestors.
+
+## wallet-toolbox 1.6.3
+
+- Resolve client dependencies for metanet-desktop
+
+## wallet-toolbox 1.6.2
+
+- Change defaul chaintracksUrl from npm-registry.babbage.systems to ${chain}net-chaintracks.babbage.systems
+
+## wallet-toolbox 1.6.1
+
+- Add initial port/re-implementation of Chaintracks
+
+## wallet-toolbox 1.5.21
+
+- Add support for listOutputs with negative offsets. (Sorts newest first, offset -1 is newest output).
+
+## wallet-toolbox 1.5.10
+
+- Add automatic request timeouts and deprioritization of postBeef services.
+
+## wallet-toolbox 1.5.7
+
+- One-off authorizations are no longer cached, ensuring they can only be used once.
+
+## wallet-toolbox 1.5.0
+
+- update to @bsv/sdk 1.6.8 and @bsv/auth-express-middleware 1.2.0 (Which include VarInt support for negative numbers, making it a breaking change)
+
+## wallet-toolbox 1.4.10
+
+- when spending non-change outputs, atomically tests spendable before setting to spent.
+- change unbasketted new outputs to spendable
+- updated WalletStorageManager to use lockQueues for read/write/sync/sp scheduling
+
+## wallet-toolbox 1.4.7
+
+- update to bsv/sdk 1.6.5
+- add BHSServiceClient which allows for leaning on BlockHeadersService for chain tracking.
+- add ARC callbackURL and callbackToken to createDefaultWalletServiceOptions
+
+## wallet-toolbox 1.4.?
+
+- Only check for proofs when TaskNewHeader sets checkNow, tightens up control of required delay.
+
+## wallet-toolbox 1.4.3
+
+- update monitor logging
+
+## wallet-toolbox 1.4.2
+
+- update monitor TaskNewHeader, TaskCheckForProofs to ignore bleeding edge new blocks and proofs.
+
+## wallet-toolbox 1.4.1
+
+- update to bsv/sdk 1.6.0 with reworked bignum and memory / performance improvements.
+
+## wallet-toolbox 1.3.32
+
+- add permissions caching (5 minutes)
+
+## wallet-toolbox 1.3.30
+
+- Enable gorillaPoolArc for postBeef Services
+- Switch Services postBeef multi-service mode from 'PromiseAll' to 'UntilSuccess'
+
+## wallet-toolbox 1.3.29
+
+- add verifyUnlockScripts to both createAction and signAction flows
+  
+## wallet-toolbox 1.3.28
+
+- adminStats now includes monitorStats and servicesStats of type ServicesCallHistory (wallet-toolbox/src/sdk/WalletServices.interfaces.ts)
+- both sets of stats break down service calls by providers including both recent calls and interval based statistics.
+- monitorStats correspond to service requests made by the active Monitor daemon. This includes “delayed” createActions. Intervals are currently 12 minutes.
+- servicesStats corresponds to the service requests made by the StorageProvider service. This includes “non-delayed” createActions. Intervals are determined by rate of calls to adminStats, each call starts a new interval.
+
+## wallet-toolbox 1.3.25
+
+- throws INVALID_PARAMETER if a createAction input is a change output.
+- logging and potential fix for internalizeAction bug.
+- adds gorillaPool to Services but leaves it disabled for now.
+- adds service call history logging to Monitor Events table, but not yet tied in to adminStats return value.
+- StorageProvider level “find” entity methods now support additional optional orderDescending boolean.
+
+## wallet-toolbox v1.3.4, 2025-04-24
+
+### Add StorageIdb
+
+Adds support for `indexedDB` based wallet storage via the new `StorageIdb` `StorageProvider` class and a new `SetupClient` class.
+
+## wallet-toolbox v1.3.0, 2025-04-23
+
+### Change in Handling of New Outputs NOT Assigned to a Basket
+
+New outputs created by `createAction` / `signAction` that are NOT assigned to a basket are considered immediately SPENT.
+
+Implications:
+
+- Outputs transferred to a second party, either through internalizeAction or custom means, MUST NOT be assigned to a basket
+as this allows them to be spent without your wallet being notified that they are no longer spendable. This is a usage guideline, it is not enforced.
+- These outputs will NOT be returned by `listOutputs`, as it only returns spendable outputs.
+- These outputs WILL be returned by `listActions` with the includeOutputs option set to true.
+- Your wallet will mark any output you include as inputs in your own transactions as spent at the time of transaction creation.
+- If a created transaction subsequently fails to be broadcast (abandoned or invalid), the outputs are reset to spendable. This may not happen immediately.

package/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# CONTRIBUTING to `@bsv/wallet-toolbox`
+
+Thank you for considering contributing to the BSV Blockchain Libraries Project! This document outlines the processes and practices we expect contributors to adhere to.
+
+## Table of Contents
+
+- [CONTRIBUTING to `@bsv/wallet-toolbox`](#contributing-to-bsvwallet-toolbox)
+  - [Table of Contents](#table-of-contents)
+  - [General Guidelines](#general-guidelines)
+  - [Code of Conduct](#code-of-conduct)
+    - [Posting Issues and Comments](#posting-issues-and-comments)
+    - [Coding and PRs](#coding-and-prs)
+  - [Getting Started](#getting-started)
+  - [Pull Request Process](#pull-request-process)
+  - [Coding Conventions](#coding-conventions)
+  - [Documentation and Testing](#documentation-and-testing)
+  - [Contact \& Support](#contact--support)
+
+## General Guidelines
+
+- **Issues First**: If you're planning to add a new feature or change existing behavior, please open an issue first. This allows us to avoid multiple people working on similar features and provides a place for discussion.
+  
+- **Stay Updated**: Always pull the latest changes from the main branch before creating a new branch or starting on new code.
+  
+- **Simplicity Over Complexity**: Your solution should be as simple as possible, given the requirements.
+
+## Code of Conduct
+
+### Posting Issues and Comments
+
+- **Be Respectful**: Everyone is here to help and grow. Avoid any language that might be considered rude or offensive.
+  
+- **Be Clear and Concise**: Always be clear about what you're suggesting or reporting. If an issue is related to a particular piece of code or a specific error message, include that in your comment.
+  
+- **Stay On Topic**: Keep the conversation relevant to the issue at hand. If you have a new idea or unrelated question, please open a new issue.
+
+### Coding and PRs
+
+- **Stay Professional**: Avoid including "fun" code, comments, or irrelevant file changes in your commits and pull requests.
+
+## Getting Started
+
+1. **Fork the Repository**: Click on the "Fork" button at the top-right corner of this repository.
+  
+2. **Clone the Forked Repository**: `git clone https://github.com/YOUR_USERNAME/wallet-toolbox.git`
+
+3. **Navigate to the Directory**: `cd wallet-toolbox`
+
+4. **Install Dependencies**: Since we maintain all code within this library, there shouldn't be any runtime dependencies. Nevertheless, always run `npm install` after pulling to ensure tooling is up to date.
+
+## Pull Request Process
+
+1. **Create a Branch**: For every new feature or bugfix, create a new branch.
+  
+2. **Commit Your Changes**: Make your changes and commit them. Commit messages should be clear and concise to explain what was done.
+  
+3. **Run Tests**: Ensure all tests pass using Jest: `npm test`.
+  
+4. **Documentation**: All code must be fully annotated with comments. Update the documentation by running `npm run doc` before creating a pull request.
+  
+5. **Push to Your Fork**: `git push origin your-new-branch`.
+  
+6. **Open a Pull Request**: Go to your fork on GitHub and click "New Pull Request". Fill out the PR template, explaining your changes.
+  
+7. **Code Review**: At least two maintainers must review and approve the PR before it's merged. Address any feedback or changes requested.
+  
+8. **Merge**: Once approved, the PR will be merged into the main branch.
+
+## Coding Conventions
+
+- **Code Style**: We use `ts-standard` for our TypeScript coding style. Run `npm run lint` to ensure your code adheres to this style.
+  
+- **No Runtime Dependencies**: All code should be maintained within this library. Do not introduce external dependencies.
+  
+- **Testing**: Always include tests for new code or changes. We aim for industry-standard levels of test coverage.
+  
+- **Documentation**: All functions, classes, and modules should be documented. Use annotation comments to describe the purpose, parameters, and return values.
+
+## Documentation and Testing
+
+- **Documentation**: Update the documentation whenever you add or modify the code. Run `npm run doc` to generate the latest docs.
+  
+- **Testing**: We use Jest for all tests. Write comprehensive tests, ensuring edge cases are covered. All PRs should maintain or improve the current test coverage.
+
+## Contact & Support
+
+If you have any questions or need assistance with your contributions, feel free to reach out. Remember, we're here to help each other grow and improve the `@bsv/wallet-toolbox`.
+
+Thank you for being a part of this journey. Your contributions help shape the future of the BSV Blockchain Libraries Project!

package/README.md

@@ -0,0 +1,43 @@
+# BSV WALLET TOOLBOX
+
+BSV BLOCKCHAIN | BRC100 Conforming Wallet, Wallet Storage and Wallet Signer Components
+
+## Objective
+
+The BSV Wallet Toolbox builds on the [SDK](https://bsv-blockchain.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://bsv-blockchain.github.io/wallet-toolbox) are available here on Github pages.  
+
+The Toolbox is richly documented with code-level annotations. This should show up well within editors like VSCode.  
+
+## 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.
+
+1. **Fork & Clone**: Fork this repository and clone it to your local machine.
+2. **Set Up**: Run `npm install` to install all dependencies.
+3. **Make Changes**: Create a new branch and make your changes.
+4. **Test**: Ensure all tests pass by running `npm test`.
+5. **Commit**: Commit your changes and push to your fork.
+6. **Pull Request**: Open a pull request from your fork to this repository.
+For more details, check the [contribution guidelines](./CONTRIBUTING.md).
+
+## Support & Contacts
+
+Project Owners: Thomas Giacomo and Darren Kellenschwiler
+
+Development Team Lead: Ty Everett
+
+For questions, bug reports, or feature requests, please open an issue on GitHub or contact us directly.
+
+## License
+
+The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
+
+Thank you for being a part of the BSV Blockchain Libraries Project. Let's build the future of BSV Blockchain together!