Skip to content

Commit 7e3ac12

Browse files
author
bob@babbageproject.com
committed
Merge remote-tracking branch 'origin/nextVersion' into bobtestNV
2 parents c9127c6 + 631e7ea commit 7e3ac12

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2470
-555
lines changed

LICENSE.txt

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -9,93 +9,32 @@ The BSV Wallet Toolbox builds on the [SDK](https://bitcoin-sv.github.io/ts-sdk)
99

1010
# Table of Contents
1111

12-
- [Objective](#objective)
13-
- [Getting Started](#getting-started)
14-
- [Features \& Deliverables](#features--deliverables)
15-
- [Documentation](#documentation)
16-
- [Contribution Guidelines](#contribution-guidelines)
17-
- [Support \& Contacts](#support--contacts)
18-
- [License](#license)
12+
- [Objective](#objective)
13+
- [Getting Started](#getting-started)
14+
- [Features \& Deliverables](#features--deliverables)
15+
- [Documentation](#documentation)
16+
- [Contribution Guidelines](#contribution-guidelines)
17+
- [Support \& Contacts](#support--contacts)
18+
- [License](#license)
1919

2020
## Objective
2121

2222
The BSV Wallet Toolbox Project aims to support building sophisticated applications and services on the BSV Blockchain technology stack.
2323

2424
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.
2525

26-
## Getting Started
27-
28-
### Installation
29-
30-
To install the toolbox, run:
31-
32-
```bash
33-
npm install @bsv/wallet-toolbox
34-
```
35-
36-
### Basic Usage
37-
38-
Here's a simple example of using the toolbox to create and fund a testnet wallet using SQLite for persistent storage:
39-
40-
```javascript
41-
import { InternalizeActionArgs, PrivateKey, Utils } from '@bsv/sdk'
42-
import { test } from '@bsv/wallet-toolbox'
43-
44-
const rootKeyHex = PrivateKey.fromRandom().toString()
45-
console.log(`MAKE A SECURE COPY OF YOUR WALLET PRIVATE ROOT KEY: ${rootKeyHex}`)
46-
47-
const { wallet } = await test._tu.createSQLiteTestWallet({
48-
filePath: './myTestWallet.sqlite',
49-
databaseName: 'myTestWallet',
50-
chain: 'test',
51-
rootKeyHex
52-
})
53-
54-
// Obtain a Wallet Payment for your new wallet from a testnet funding faucet.
55-
// Update or replace the values in the following example object with your actual funding payment.
56-
// Note that the values below will not be accepted as they are not intended for your new wallet.
57-
const r = {
58-
senderIdentityKey: '03ac2d10bdb0023f4145cc2eba2fcd2ad3070cb2107b0b48170c46a9440e4cc3fe',
59-
vout: 0,
60-
txid: '942f094cee517276182e5857369ea53d64763a327d433489312a9606db188dfb',
61-
derivationPrefix: 'jSlU588BWkw=',
62-
derivationSuffix: 'l37vv/Bn4Lw=',
63-
atomicBEEF: '01010101942f094cee517...a914b29d56273f6c1df90cd8f383c8117680f2bdd05188ac00000000'
64-
}
65-
66-
const args: InternalizeActionArgs = {
67-
tx: Utils.toArray(r.atomicBEEF, 'hex'),
68-
outputs: [
69-
{
70-
outputIndex: r.vout,
71-
protocol: 'wallet payment',
72-
paymentRemittance: {
73-
derivationPrefix: r.derivationPrefix,
74-
derivationSuffix: r.derivationSuffix,
75-
senderIdentityKey: r.senderIdentityKey
76-
}
77-
}
78-
],
79-
description: 'from faucet'
80-
}
81-
82-
const rw = await wallet.internalizeAction(args)
83-
console.log(rw.accepted)
84-
```
85-
86-
For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).
87-
88-
## Features & Deliverables
89-
90-
- **Feature1**: Summary of feature1.
91-
9226
## Documentation
9327

9428
[The Docs](https://bitcoin-sv.github.io/wallet-toolbox) are available here on Github pages.
9529
[Example code](https://docs.bsvblockchain.org/guides/sdks/ts/examples) is available over on our gitbook.
9630

9731
The Toolbox is richly documented with code-level annotations. This should show up well within editors like VSCode.
9832

33+
34+
## Features & Deliverables
35+
36+
- **Feature1**: Summary of feature1.
37+
9938
## Contribution Guidelines
10039

10140
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
12160
The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
12261

12362
Thank you for being a part of the BSV Blockchain Libraries Project. Let's build the future of BSV Blockchain together!
124-

client/package-lock.json

Lines changed: 94 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

client/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@bsv/wallet-toolbox-client",
3-
"version": "1.1.1",
3+
"version": "1.1.5",
44
"description": "Client only Wallet Storage",
55
"main": "./out/src/index.client.js",
66
"types": "./out/src/index.client.d.ts",
@@ -20,8 +20,8 @@
2020
},
2121
"homepage": "https://github.com/bitcoin-sv/wallet-toolbox#readme",
2222
"dependencies": {
23-
"@bsv/sdk": "^1.3.8",
24-
"axios": "^0.21.1",
23+
"@bsv/sdk": "^1.3.12",
24+
"axios": "^0.29.0",
2525
"whatsonchain": "^0.2.0"
2626
}
2727
}

dev.sqlite3

Whitespace-only changes.

0 commit comments

Comments
 (0)