bgls icon indicating copy to clipboard operation
bgls copied to clipboard

Write Documentation

Open UnitylChaos opened this issue 6 years ago • 2 comments

  • 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)

UnitylChaos avatar Mar 09 '18 06:03 UnitylChaos

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 avatar Apr 06 '18 03:04 ValarDragon

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.

ValarDragon avatar Apr 06 '18 18:04 ValarDragon