Skip to content

Commit

Permalink
ts-web/core: add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
pro-wh committed Oct 15, 2024
1 parent a16bd0c commit b1e2eae
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions client-sdk/ts-web/core/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

## Unreleased changes

Breaking changes:

- `signature.NaclSigner` is moved out to a new
`@oasisprotocol/signer-tweetnacl` package.
- `hdkey.HDKey.getAccountSigner` now returns a `signature.Signer` instead of
a tweetnacl `SignKeyPair`.
To get the private key, use the new `hdkey.HDKey.seedFromMnemonic` and
`hdkey.HDKey.privateKeyFromSeed` functions.

New features:

- Hashing and many related functions that internally need to compute a hash,
Expand All @@ -10,11 +19,18 @@ New features:
We had implementations that used synchronous hashing libraries all along,
but this is us giving up on eventually using the Web Crypto API for
SHA-512/256.
- For Ed25519 signing, there's a new `signature.WebCryptoSigner` taking the
place of `signature.NaclSigner`.
`await signature.WebCryptoSigner.generate(extractable)` is equivalent to
`signature.NaclSigner.fromRandom(note)`, and
`await signature.WebCryptoSigner.fromPrivateKey(priv)` is equivalent to
`signature.NaclSigner.fromSeed(priv, note)`.

Little things:

- We're switching lots of cryptography dependencies to noble cryptography
libraries.
- Ed25519 verification now uses the Web Crypto API.

## v1.1.0

Expand Down

0 comments on commit b1e2eae

Please sign in to comment.