Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #2109

Merged
merged 6 commits into from
Jun 15, 2024
Merged

Update readme #2109

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
01427ee
Merge branch 'master' of https://github.com/bitcoinjs/bitcoinjs-lib i…
jasonandjay Jun 13, 2024
cfd61e6
docs: update README with alternatives for ECC Library
jasonandjay Jun 13, 2024
1a868e8
🔵 other: update audit ci to ignore 1097496
jasonandjay Jun 14, 2024
24e13b4
docs: backticks around tiny-secp256k1
jasonandjay Jun 14, 2024
72d58b2
Merge branch 'master' into ecc-alternative
jasonandjay Jun 15, 2024
96cb427
Minor fixes to README
junderw Jun 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,16 @@ Which you can then import as an ESM module:
<script type="module">import "/scripts/bitcoinjs-lib.js"</script>
````

#### Using Taproot:
When utilizing Taproot features with bitcoinjs-lib, you may need to include an additional ECC (Elliptic Curve Cryptography) library. The commonly used `tiny-secp256k1` library, however, might lead to compatibility issues due to its reliance on WASM (WebAssembly). The following alternatives may be used instead, though they may be significantly slower for high volume of signing and pubkey deriving operations.

#### Alternatives for ECC Library:
1. `@bitcoinjs-lib/tiny-secp256k1-asmjs`
A version of `tiny-secp256k1` compiled to ASM.js directly from the WASM version, potentially better supported in browsers. This is the slowest option.
2. `@bitcoinerlab/secp256k1`
Another alternative library for ECC functionality. This requires access to the global `BigInt` primitive.
For advantages and detailed comparison of these libraries, visit: [tiny-secp256k1 GitHub page](https://github.com/bitcoinjs/tiny-secp256k1).

**NOTE**: We use Node Maintenance LTS features, if you need strict ES5, use [`--transform babelify`](https://github.com/babel/babelify) in conjunction with your `browserify` step (using an [`es2015`](https://babeljs.io/docs/plugins/preset-es2015/) preset).

**WARNING**: iOS devices have [problems](https://github.com/feross/buffer/issues/136), use at least [[email protected]](https://github.com/feross/buffer/pull/155) or greater, and enforce the test suites (for `Buffer`, and any other dependency) pass before use.
Expand Down
Loading