Skip to content

Commit

Permalink
docs: new features
Browse files Browse the repository at this point in the history
  • Loading branch information
blake-regalia committed Nov 25, 2024
1 parent 9ae5c33 commit 979cabd
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

The [libsecp256k1 C library](https://github.com/bitcoin-core/secp256k1) compiled to WASM and wrapped with an ultralight TypeScript API.

Supports four basic operations:
- Computing the corresponding public key for a given private key
- Signing
Supports the following operations:
- Computing the corresponding public key for a given secret key
- Signing (with recovery ID)
- Verifying
- Recovering public key
- ECDH
- Tweaking secret/public key via addition/multiplication

This module offers *substantially* greater security than pure JavaScript implementations of Secp256k1 due to the fact that JS runtimes simply make it impossible for JS developers to effectively mitigate side-channel attacks. Anyone who says otherwise doesn't know what they're talking about.

In addition to zero-ing out private keys after use, the wrapper also randomizes the lib context every time a public key is computed or a message is signed.

Signature recovery is not currently enabled, but is easy to add. If you meed it, please open an issue.

### [Demo webapp](https://starshell.net/wasm-secp256k1/) and its [source](https://github.com/SolarRepublic/wasm-secp256k1/blob/main/src/demo/webapp.ts)


Expand Down
13 changes: 12 additions & 1 deletion docs/assets/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/index.js.map

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ <h3>
</td>
</tr>

<tr>
<td>
<label for="pkr">Recovered:</label>
</td>
<td>
<input type="text" size="68" id="pkr" name="pkr" readonly>
</td>
</td>
</tr>

<tr>
<td>
<label for="v">Recovery ID:</label>
Expand Down

0 comments on commit 979cabd

Please sign in to comment.