Write Documentation - Githubissues

Project-Arda / bgls

Aggregate and Multi Signatures based on BGLS over BN256 and BLS12-381

Apache License 2.0

60 stars 17 forks source link

Write Documentation #16

Open UnitylChaos opened 6 years ago

UnitylChaos commented 6 years ago

What are BGLS signatures
How our Authentication scheme works, and why this is correct
Multi Signature vs Aggregate Signature
Our API - subtleties include allowance of duplicates in AggSig / when to authenticate
Describe our point compression format, and that we use the leading bit of each field in G1 / G2
Describe the type of pairing in alt bn128 (type 3, optimal ate)

ValarDragon commented 6 years ago

The various authentication schemes have been explained in https://github.com/Project-Arda/bgls/commit/0e87e8820c6d0daec9354a440d8cdc8477cefffc. The API explanation has some explanation from the godocs also. (Not sure if more may or may not be needed)

ValarDragon commented 6 years ago

I added an explanation of multi signatures vs aggregate signatures in https://github.com/Project-Arda/bgls/commit/c61bcd60cbfce6bc466ee41804e1a4f7e1c38f8b .

Also, the readme needs to be split up between bgls, and the curve implementation details, and placed into the respective packages. Also, the repository name should be renamed, since our intention is to include more pairing based cryptography applications here.