This commit is contained in:
Paul Miller 2023-10-07 12:48:25 +00:00
parent 30763066ac
commit b36bf44f4b
No known key found for this signature in database
GPG Key ID: 697079DA6878B89B

@ -57,8 +57,9 @@ If you don't like NPM, a standalone [noble-curves.js](https://github.com/paulmil
- [utils: Useful utilities](#abstractutils-useful-utilities) - [utils: Useful utilities](#abstractutils-useful-utilities)
- [Security](#security) - [Security](#security)
- [Speed](#speed) - [Speed](#speed)
- [Contributing & testing](#contributing--testing)
- [Upgrading](#upgrading) - [Upgrading](#upgrading)
- [Contributing & testing](#contributing--testing)
- [Resources](#resources)
### Implementations ### Implementations
@ -829,9 +830,9 @@ Use low-level libraries & languages. Nonetheless we're targetting algorithmic co
- scure-base, scure-bip32, scure-bip39, micro-bmark and micro-should are developed by the same author and follow identical security practices - scure-base, scure-bip32, scure-bip39, micro-bmark and micro-should are developed by the same author and follow identical security practices
- prettier (linter), fast-check (property-based testing) and typescript are used for code quality, vector generation and ts compilation. The packages are big, which makes it hard to audit their source code thoroughly and fully - prettier (linter), fast-check (property-based testing) and typescript are used for code quality, vector generation and ts compilation. The packages are big, which makes it hard to audit their source code thoroughly and fully
It's crucial to minimize the amount of 3rd-party dependencies & native bindings. Our goal is to minimize the amount of 3rd-party dependencies & native bindings.
If your app uses 500 dependencies, any dep could get hacked and you'll be If your app uses 500 dependencies, any dep could get hacked and you'll be
downloading malware with every install. Our goal is to minimize this attack vector. downloading malware with every install.
### Randomness ### Randomness
@ -921,13 +922,6 @@ ed25519 x 3,088 ops/sec @ 323μs/op
ed448 x 1,247 ops/sec @ 801μs/op ed448 x 1,247 ops/sec @ 801μs/op
``` ```
## Contributing & testing
1. Clone the repository
2. `npm install` to install build dependencies like TypeScript
3. `npm run build` to compile TypeScript code
4. `npm run test` will execute all main tests
## Upgrading ## Upgrading
Previously, the library was split into single-feature packages Previously, the library was split into single-feature packages
@ -987,6 +981,13 @@ Upgrading from [@noble/bls12-381](https://github.com/paulmillr/noble-bls12-381):
- PointG2.fromSignature -> Signature.decode, PointG2.toSignature -> Signature.encode - PointG2.fromSignature -> Signature.decode, PointG2.toSignature -> Signature.encode
- Fp2 ORDER was corrected - Fp2 ORDER was corrected
## Contributing & testing
1. Clone the repository
2. `npm install` to install build dependencies like TypeScript
3. `npm run build` to compile TypeScript code
4. `npm run test` will execute all main tests
## Resources ## Resources
Check out [paulmillr.com/noble](https://paulmillr.com/noble/) Check out [paulmillr.com/noble](https://paulmillr.com/noble/)