Update readme #2109
Update readme #2109
Conversation
|
unexpected test failed of audit, please have a look @junderw |
|
Change |
Since it did not fix the audit, that means there is no fix out yet and/or the chain of dependencies hasn't upgraded yet. We can't do anything, but check the content of the vulnerability and see if we can ignore it. I think we can ignore it. |
|
I think instead of modifying the audit script in package.json we should just modify the invocation in CI. If some other user wants to run audit, we shouldn't mess with it. ... maybe |
README.md
Outdated
| If you encounter the following error: | ||
|
|
||
| ``` | ||
| Uncaught TypeError: (0 , fs_1.readFileSync) is not a function | ||
| ``` | ||
| This indicates that tiny-secp256k1's WASM implementation is not fully compatible with your browser environment. |
There was a problem hiding this comment.
I don't think we need to mention the errors.
README.md
Outdated
| @@ -102,6 +102,22 @@ 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). | |||
There was a problem hiding this comment.
Backticks around tiny-secp256k1 so it's monospaced and stands out.
|
Which part needs to be optimized? |
In case of #2106
1. Documented Error:
Added details about the Uncaught TypeError: (0 , fs_1.readFileSync) is not a function error with tiny-secp256k1 due to WASM issues in browsers.
2. ECC Library Alternatives:
Introduced @bitcoinjs-lib/tiny-secp256k1-asmjs and @bitcoinerlab/secp256k1 as alternatives for improved browser support.