ZenGo-X / multi-party-ecdsa

Rust implementation of {t,n}-threshold ECDSA (elliptic curve digital signature algorithm).
GNU General Public License v3.0
992 stars 313 forks source link

Write Rust doc for party one and party two messages #8

Open gbenattar opened 6 years ago

gbenattar commented 6 years ago

Write Rust doc for Lindell 2017 2P-ECDSA (https://doc.rust-lang.org/book/first-edition/documentation.html). Mention in the doc papers, math formula and plain english description.

See: https://github.com/KZen-networks/multi-party-ecdsa/blob/master/src/protocols/two_party_ecdsa/lindell_2017/party_one.rs#L51

gbenattar commented 6 years ago

Adding more doc, see: https://github.com/KZen-networks/multi-party-ecdsa/issues/11 for references.

jeamick commented 5 years ago

hey @gbenattar,

this link (See: https://github.com/KZen-networks/multi-party-ecdsa/blob/master/src/protocols/two_party_ecdsa/lindell_2017_keygen/party_one.rs#L51) is not working...

Here is the link : https://github.com/KZen-networks/multi-party-ecdsa/blob/master/src/protocols/two_party_ecdsa/lindell_2017/party_one.rs#L51

I'll start dig into this issue if it is ok ?

Thanks

JM

omershlo commented 5 years ago

awesome

gbenattar commented 5 years ago

@jeamick Yes that would be great, I updated slightly the task description. At the end the outcome of it should be a proper Rust doc for this crate. Feel free to split it into small chunk if you want early review from @omershlo.

Let us know if you need any help, I suppose that you are very familiar with 2P-ECDSA, we have many tasks as a follow up.

Thanks.