@bsv/wallet-toolbox 1.1.2 → 1.1.4

package/README.md

@@ -9,13 +9,13 @@ The BSV Wallet Toolbox builds on the [SDK](https://bitcoin-sv.github.io/ts-sdk)
 
 # 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](#objective)
+- [Getting Started](#getting-started)
+- [Features \& Deliverables](#features--deliverables)
+- [Documentation](#documentation)
+- [Contribution Guidelines](#contribution-guidelines)
+- [Support \& Contacts](#support--contacts)
+- [License](#license)
 
 ## Objective
 
@@ -23,72 +23,6 @@ The BSV Wallet Toolbox Project aims to support building sophisticated applicatio
 
 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.
 
-## Getting Started
-
-### Installation
-
-To install the toolbox, run:
-
-```bash
-npm install @bsv/wallet-toolbox
-```
-
-### Basic Usage
-
-Here's a simple example of using the toolbox to create and fund a testnet wallet using SQLite for persistent storage:
-
-```javascript
-import { InternalizeActionArgs, PrivateKey, Utils } from '@bsv/sdk'
-import { test } from '@bsv/wallet-toolbox'
-
-const rootKeyHex = PrivateKey.fromRandom().toString()
-console.log(`MAKE A SECURE COPY OF YOUR WALLET PRIVATE ROOT KEY: ${rootKeyHex}`)
-
-const { wallet } = await test._tu.createSQLiteTestWallet({
-    filePath: './myTestWallet.sqlite',
-    databaseName: 'myTestWallet',
-    chain: 'test',
-    rootKeyHex
-})
-
-// Obtain a Wallet Payment for your new wallet from a testnet funding faucet.
-// Update or replace the values in the following example object with your actual funding payment.
-// Note that the values below will not be accepted as they are not intended for your new wallet.
-const r = {
-    senderIdentityKey: '03ac2d10bdb0023f4145cc2eba2fcd2ad3070cb2107b0b48170c46a9440e4cc3fe',
-    vout: 0,
-    txid: '942f094cee517276182e5857369ea53d64763a327d433489312a9606db188dfb',
-    derivationPrefix: 'jSlU588BWkw=',
-    derivationSuffix: 'l37vv/Bn4Lw=',
-    atomicBEEF: '01010101942f094cee517...a914b29d56273f6c1df90cd8f383c8117680f2bdd05188ac00000000'
-}
-
-const args: InternalizeActionArgs = {
-    tx: Utils.toArray(r.atomicBEEF, 'hex'),
-    outputs: [
-        {
-            outputIndex: r.vout,
-            protocol: 'wallet payment',
-            paymentRemittance: {
-                derivationPrefix: r.derivationPrefix,
-                derivationSuffix: r.derivationSuffix,
-                senderIdentityKey: r.senderIdentityKey
-            }
-        }
-    ],
-    description: 'from faucet'
-}
-
-const rw = await wallet.internalizeAction(args)
-console.log(rw.accepted)
-```
-
-For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).
-
-## Features & Deliverables
-
-- **Feature1**: Summary of feature1.
-
 ## Documentation
 
 [The Docs](https://bitcoin-sv.github.io/wallet-toolbox) are available here on Github pages.  
@@ -96,6 +30,11 @@ For a more detailed tutorial and advanced examples, check our [Documentation](#d
 
 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.
@@ -121,4 +60,3 @@ For questions, bug reports, or feature requests, please open an issue on GitHub
 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!
-

package/docs/README.md

@@ -2,14 +2,78 @@
 
 The documentation is split into various pages, each covering a set of related functionality. The pages are as follows:
 
-- [Wallet](./wallet.md) — 
-- [Client](./client.md) — 
-- [Storage](./storage.md) — 
-- [Services](./services.md) — 
-- [Monitor](./monitor.md) — 
+- [Getting Started](#getting-started) -
+- [Setup](./setup.md) —
+- [Wallet](./wallet.md) —
+- [Client](./client.md) —
+- [Storage](./storage.md) —
+- [Services](./services.md) —
+- [Monitor](./monitor.md) —
 
 ## Swagger
 
 [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 JSON API Swagger](https://bitcoin-sv.github.io/ts-sdk/swagger)
+
+## Getting Started
+
+### Installation
+
+To install the toolbox, run:
+
+```bash
+npm install @bsv/wallet-toolbox
+```
+
+### Basic Usage
+
+Here's a simple example of using the toolbox to create and fund a testnet wallet using SQLite for persistent storage:
+
+```ts
+import { InternalizeActionArgs, PrivateKey, Utils } from '@bsv/sdk'
+import { Setup } from '@bsv/wallet-toolbox'
+
+const rootKeyHex = PrivateKey.fromRandom().toString()
+console.log(`MAKE A SECURE COPY OF YOUR WALLET PRIVATE ROOT KEY: ${rootKeyHex}`)
+
+const { wallet } = await Setup.createSQLiteWallet({
+    filePath: './myTestWallet.sqlite',
+    databaseName: 'myTestWallet',
+    chain: 'test',
+    rootKeyHex
+})
+
+// Obtain a Wallet Payment for your new wallet from a testnet funding faucet.
+// Update or replace the values in the following example object with your actual funding payment.
+// Note that the values below will not be accepted as they are not intended for your new wallet.
+const r = {
+    senderIdentityKey: '03ac2d10bdb0023f4145cc2eba2fcd2ad3070cb2107b0b48170c46a9440e4cc3fe',
+    vout: 0,
+    txid: '942f094cee517276182e5857369ea53d64763a327d433489312a9606db188dfb',
+    derivationPrefix: 'jSlU588BWkw=',
+    derivationSuffix: 'l37vv/Bn4Lw=',
+    atomicBEEF: '01010101942f094cee517...a914b29d56273f6c1df90cd8f383c8117680f2bdd05188ac00000000'
+}
+
+const args: InternalizeActionArgs = {
+    tx: Utils.toArray(r.atomicBEEF, 'hex'),
+    outputs: [
+        {
+            outputIndex: r.vout,
+            protocol: 'wallet payment',
+            paymentRemittance: {
+                derivationPrefix: r.derivationPrefix,
+                derivationSuffix: r.derivationSuffix,
+                senderIdentityKey: r.senderIdentityKey
+            }
+        }
+    ],
+    description: 'from faucet'
+}
+
+const rw = await wallet.internalizeAction(args)
+console.log(rw.accepted)
+```
+
+For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).