Skip to content

Commit 4473b6a

Browse files
committed
README
1 parent 17db396 commit 4473b6a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
All pure-js cryptographic primitives normally used when
66
developing Javascript / TypeScript applications and tools for Ethereum.
77

8+
April 2023 update: v2.0 is out, switching
9+
[noble-secp256k1](https://github.com/paulmillr/noble-secp256k1) to
10+
[noble-curves](https://github.com/paulmillr/noble-curves),
11+
which changes re-exported api of `secp256k1` submodule.
12+
There have been no other changes. Check out [Upgrading](#upgrading).
13+
814
**January 2022 update:** We've released v1.0 of the package, a complete rewrite:
915

1016
- **6x smaller:** ~5,000 lines of code instead of ~24,000 (with all deps); 650KB instead of 10.2MB
@@ -452,6 +458,8 @@ Upgrading from 1.0 to 2.0:
452458
before, it was using [noble-secp256k1 1.7](https://github.com/paulmillr/noble-secp256k1);
453459
now it uses safer [noble-curves](https://github.com/paulmillr/noble-curves). Please refer
454460
to [upgrading section from curves README](https://github.com/paulmillr/noble-curves#upgrading).
461+
Main changes to keep in mind: a) `sign` now returns `Signature` instance
462+
b) `recoverPublicKey` got moved onto a `Signature` instance
455463
2. node.js 14 and older support was dropped. Upgrade to node.js 16 or later.
456464

457465
Upgrading from 0.1 to 1.0: **Same functionality**, all old APIs remain the same except for the breaking changes:

0 commit comments

Comments
 (0)