@btc-vision/wallet-sdk 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -12
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +12 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,24 +1,79 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OP_NET - Wallet SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
4
9
|
|
|
5
|
-
|
|
10
|
+
[](https://github.com/prettier/prettier)
|
|
11
|
+
|
|
12
|
+
## Introduction
|
|
13
|
+
|
|
14
|
+
The OP_NET Wallet SDK provides a complete, type-safe foundation for building Bitcoin wallet applications and browser
|
|
15
|
+
extensions. Written in TypeScript from the ground up, this library delivers modern key management with BIP32
|
|
16
|
+
hierarchical deterministic derivation, quantum-resistant signer support ready for BIP360, and seamless integration with
|
|
17
|
+
the OP_NET ecosystem.
|
|
18
|
+
|
|
19
|
+
Built by developers who understand how Bitcoin actually works. No outdated dependencies, no bitcore bloat, just clean
|
|
20
|
+
architecture powered by @btc-vision/bitcoin and @btc-vision/transaction.
|
|
21
|
+
|
|
22
|
+
## Getting Started
|
|
23
|
+
|
|
24
|
+
### Prerequisites
|
|
25
|
+
|
|
26
|
+
- Node.js version 22.x or higher
|
|
27
|
+
- npm (Node Package Manager)
|
|
28
|
+
|
|
29
|
+
### Installation
|
|
6
30
|
|
|
7
31
|
```shell
|
|
8
|
-
|
|
9
|
-
|
|
32
|
+
npm i @btc-vision/wallet-sdk
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Documentation
|
|
10
36
|
|
|
11
|
-
|
|
12
|
-
yarn build
|
|
37
|
+
Documentation is available at [docs.opnet.org](https://docs.opnet.org)
|
|
13
38
|
|
|
14
|
-
|
|
15
|
-
|
|
39
|
+
#### Development
|
|
40
|
+
|
|
41
|
+
1. Clone the repository:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
git clone https://github.com/btc-vision/wallet-sdk.git
|
|
16
45
|
```
|
|
17
46
|
|
|
18
|
-
|
|
47
|
+
2. Navigate to the repository directory:
|
|
19
48
|
|
|
20
|
-
```
|
|
49
|
+
```bash
|
|
50
|
+
cd wallet-sdk
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
3. Install the required dependencies:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm i
|
|
57
|
+
```
|
|
21
58
|
|
|
22
|
-
|
|
59
|
+
4. Build the project:
|
|
23
60
|
|
|
61
|
+
```bash
|
|
62
|
+
npm run build
|
|
24
63
|
```
|
|
64
|
+
|
|
65
|
+
5. Run tests:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm test
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Contribution
|
|
72
|
+
|
|
73
|
+
Contributions are welcome! Please read through the `CONTRIBUTING.md` file for guidelines on how to submit issues,
|
|
74
|
+
feature requests, and pull requests. We appreciate your input and encourage you to help us improve OP_NET.
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
This project is open source and available under the [MIT License](LICENSE). If you have any suggestions or
|
|
79
|
+
contributions, please feel free to submit a pull request.
|