Skip to content

Commit a4d27b6

Browse files
committed
Document PublicKey vs AggregatePublicKey
1 parent 072c7bc commit a4d27b6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ const sig = sk.sign(msg);
2525
console.log(verify(msg, pk, sig)); // true
2626
```
2727

28+
This library exposes two types of classes for public keys and signatures: `PublicKey` & `AggregatePublicKey`, `Signature` & `AggregateSignature`
29+
30+
- `PublicKey`: Contains an affine point (x,y). It's the default representation of the point and what you need to serialize to and deserialize from.
31+
- `AggregatePublicKey`: Contains a jacobian point (x,y,z). It's optimal to perform aggregation operations.
32+
2833
## Spec versioning
2934

3035
This library has a hardcoded configuration compatible with Eth2.0 spec:

0 commit comments

Comments
 (0)