@psf/bch-js 7.1.12 → 7.1.13
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 +5 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,21 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|
[bch-js](https://www.npmjs.com/package/@psf/bch-js) is a JavaScript npm library for creating web and mobile apps that can interact with the Bitcoin Cash (BCH) blockchain. bch-js contains a toolbox of handy tools, and an easy API for talking with [psf-bch-api REST API](https://github.com/Permissionless-Software-Foundation/psf-bch-api). [FullStack.cash](https://fullstack.cash) offers paid cloud access to psf-bch-api. You can run your own infrastructure by following documentation on [CashStack.info](https://cashstack.info).
|
|
9
9
|
|
|
10
|
-
### Quick Start Videos:
|
|
11
|
-
|
|
12
|
-
YouTube walk-through videos to help you get started:
|
|
13
|
-
|
|
14
|
-
- [Introduction to bch-js and the bch-js-examples repository](https://youtu.be/GD2i1ZUiyrk)
|
|
15
|
-
|
|
16
10
|
### Quick Links
|
|
17
11
|
|
|
12
|
+
- [Code Examples](https://github.com/Permissionless-Software-Foundation/psf-js-examples) using bch-js
|
|
18
13
|
- [npm Library](https://www.npmjs.com/package/@psf/bch-js)
|
|
19
|
-
- [
|
|
20
|
-
- [Examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
|
|
14
|
+
- [API Reference](https://bchjs.fullstack.cash/)
|
|
21
15
|
- [x402-bch.fullstack.cash](https://x402-bch.fullstack.cash) - The REST API this library talks to by default.
|
|
22
16
|
- [FullStack.cash](https://fullstack.cash) - cloud-based infrastructure for application developers.
|
|
23
|
-
- [Permissionless Software Foundation](https://psfoundation.cash) - The organization that maintains this library.
|
|
24
17
|
- [CashStack.info](https://cashstack.info) - bch-js is part of the Cash Stack, a JavaScript framework for writing web 2 and web 3 business applications.
|
|
18
|
+
- [Permissionless Software Foundation](https://psfoundation.info) - The organization that maintains this library.
|
|
19
|
+
|
|
25
20
|
|
|
26
21
|
### Quick Notes
|
|
27
22
|
|
|
@@ -115,24 +110,11 @@ const bchjs2 = new BCHJS({
|
|
|
115
110
|
|
|
116
111
|
[bch-wallet-web3-spa](https://github.com/Permissionless-Software-Foundation/bch-wallet-web3-spa) is a React web app template using bch-js and minimal-slp-wallet.
|
|
117
112
|
|
|
118
|
-
## Features
|
|
119
|
-
|
|
120
|
-
- [ECMAScript 2017 standard JavaScript](https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017) used instead of TypeScript. Works
|
|
121
|
-
natively with node.js v10 or higher.
|
|
122
|
-
|
|
123
|
-
- Full SLP tokens support: bch-js has full support for all SLP token functionality, including send, mint, and genesis transactions. It also fully supports all aspects of [non-fugible tokans (NFTs)](https://www.youtube.com/watch?v=vvlpYUx6HRs).
|
|
124
|
-
|
|
125
|
-
- [Semantic Release](https://github.com/semantic-release/semantic-release) for
|
|
126
|
-
continuous delivery using semantic versioning.
|
|
127
|
-
|
|
128
|
-
- [IPFS](https://ipfs.io) and [Radicle](https://radicle.xyz) uploads of all files and dependencies, to backup
|
|
129
|
-
dependencies in case they are ever inaccessible from GitHub or npm.
|
|
130
|
-
|
|
131
113
|
## Documentation:
|
|
132
114
|
|
|
133
115
|
Full documentation for this library can be found here:
|
|
134
116
|
|
|
135
|
-
- [
|
|
117
|
+
- [API Reference](https://bchjs.fullstack.cash/)
|
|
136
118
|
|
|
137
119
|
bch-js uses [APIDOC](http://apidocjs.com/) so that documentation and working code
|
|
138
120
|
live in the same repository. To generate the documentation:
|
|
@@ -154,17 +136,6 @@ This open source software is developed and maintained by the [Permissionless Sof
|
|
|
154
136
|
<p>bitcoincash:qqsrke9lh257tqen99dkyy2emh4uty0vky9y0z0lsr</p>
|
|
155
137
|
</div>
|
|
156
138
|
|
|
157
|
-
|
|
158
|
-
## IPFS & Radicle Releases
|
|
159
|
-
|
|
160
|
-
Copies of this repository are also published on [IPFS](https://ipfs.io).
|
|
161
|
-
|
|
162
|
-
- v6.2.10: `bafybeifsioj3ba77u2763nsyuzq53gtbdxsnqpoipvdl4immj6ytznjaoy`
|
|
163
|
-
- (with dependencies, node v14.18.2 and npm v8.8.0): `bafybeihfendd4oj6uxvvecm7sluobwwhpb5wdcxhvhmx56e667nxdncd4a`
|
|
164
|
-
|
|
165
|
-
They are also posted to the Radicle:
|
|
166
|
-
- v6.2.10: `rad:git:hnrkkroqnbfwj6uxpfjuhspoxnfm4i8e6oqwy`
|
|
167
|
-
|
|
168
139
|
## License
|
|
169
140
|
|
|
170
141
|
[MIT](LICENSE.md)
|