de-labtory/cleisthenes

HoneyBadgerBFT, the first practical asynchronous BFT protocol without timing assuption

cleisthenes's Issues

[env] setup test coverage

[env] add badges for language, license, coverage and travis

[docs] HoneyBadger BFT protocol

[env] setup travis ci

[HB] implement member, member map

Subject

Detail
implement member_map.go skel function with test case

awesome pbft + swim resource

PBFT

youtube

• easy: https://www.youtube.com/watch?v=_e4wNoTV3Gw
• easy: https://www.youtube.com/watch?v=IafgKJN3nwU
• easy: https://www.youtube.com/watch?v=3wUp5V-4s8Y
• implementation: https://www.youtube.com/watch?v=Q0xYCN-rvUs - algorithm (15분)부분만 봐도 될듯

paper

• hard: www.pmg.csail.mit.edu/papers/bft-tocs.pdf

SWIM

youtube

• https://www.youtube.com/watch?v=u-a7rVJ6jZY

paper

• http://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf

PBFT Code

it-chain

• https://github.com/DE-labtory/engine/tree/develop/consensus

BigPictureLabs

• https://github.com/bigpicturelabs/consensusPBFT

[rbc] define interface

Subject
write here

Detail
write here

Reference
write here

[honeybadger] define member structure

Subject

Detail

Reference

[honeybadger] define transport (grpc) interface

Subject

Detail

Reference

[rbc] impl ReadyReqRepository

Subject
write here

Detail
impl rbc ReadyReqRepository

[honeybadger] impl AddTransaction

Subject

Detail
implement AddTransaction() at honeybadger.go with test case.

[HB] implement Connection

Subject

Detail
implement conn.go with test case

golang best practices

Twelve Go Best Practices - Francesc Campoy

• https://www.youtube.com/watch?v=8D3Vmm1BGoY

7 common mistakes in Go and when to avoid them by Steve Francia

• https://www.youtube.com/watch?v=29LLRKIL_TI

[feat] set up proto buffer

[HB] implement Stream

Subject

Detail
implement stream.go with test case

repository name should be changed

In golang, packages are given lower case, single-word names.
(ref: https://golang.org/doc/effective_go.html#names)

So, Cleisthenes should be change to cleisthenes.

[docs] documentation for contribution guide

[grpc] server & client skel

Subject
@zeroFruit

Detail
Skeleton the grpc server, grpc client which would use Connection to communicate with other nodes

[rbc] writing docs

Subject
write here

Detail
write here

Reference
write here

[docs] writing HB

[template] update some templates

Bug detail
In issue templates, there are some typing errors.

Fix plan
Correct typing errors!

[pb] pb has no epoch and round

Where
message.proto

Bug detail
pb has no epoch and round at RBC, BBA

[log] suggest logging system

Subject
logging system

Proposal Detail
How about use logging library? I think it is important to log when use network (Especially, in p2p system!)
Maybe it is future work... i suggest some logging library!

Reference

• https://github.com/sirupsen/logrus

• https://github.com/uber-go/zap

• https://github.com/gogap/aop
  This is one of concept of spring : AOP (Aspect-Oriented Programming). I used this usefully when debug. just suggestion :)

[env] issue, pull request template

[docs] writing ACS

[honeybadger] impl createBatch

Subject

Detail
implement createBatch() at honeybadger.go with test case.

[acs] define component interface

Subject
write here

Detail
write here

Reference
write here

[docs] wiring up docs to README.md and fix bba docs

Subject
@zeroFruit

Detail

1. unify docs name
2. wiring up docs to README.md
3. fix BBA

[threshold encryption] implementation

[ci] remove 80 threshold

Subject
@zeroFruit

Proposal Detail
remove travis ci 80 threshold

[rbc] impl EchoReqRepository

Subject
@hyolin97

Proposal Detail
impl rbc EchoReqRepository

[docs] PBFT documentations

Based on this youtube plz think about how to implement PBFT protocol.

Write DOCUMENTATION.md based on this page

Plz write down your name before doing your job

• page 12 >> @zeroFruit
• page 13 >> @zeroFruit
• page 14
• page 15
• page 16
• page 17
• page 18
• page 19
• page 20
• page 21
• page 22
• page 23
• page 24
• page 29
• page 30

[docs] update README.md

Subject
There are error in bba docs link.

Detail
Fix bba docs link!

[Proposal] issue policy

We had set a policy to put issue number on the branch name, but it is pretty ambiguous.
If I switch branch, I have to find issues in github.
so I propose to put issue number in commit message, like,
fix: blah blah [ISSUE-39]

[comm] impl grpc server/client

Subject
@zeroFruit

Proposal Detail

Reference

[bba] writing docs

Subject
write here

Proposal Detail
write here

Reference
write here

[comm] impl broadcaster

Subject

Proposal Detail

Reference

[docs] Threshold encryption

reference

• http://www.tcs.hut.fi/Studies/T-79.159/2004/slides/L9.pdf
• https://www.iacr.org/archive/eurocrypt2000/1807/18070209-new.pdf

code

• https://github.com/niclabs/tcrsa

[docs] documentation for commit guide

[rbc] impl ValReqRepository

Subject
@hyolin97

Detail
implement rbc ValReqRepository

Reference

[env] register CLA hub

[bba] define interface

Subject
write here

Detail
write here

Reference
write here

[HB] implements skel code

[honeybadger] research threshold_encryption module

[bba] handle bval

Subject
@zeroFruit

Proposal Detail
impl bval handler

[docs] add architecture documentations

Subject
everyone!

Detail
add architecture documentations to README.md to communicate everyone who participate in this project

[docs] gossip documentation

I am going to write documentation about gossip protocol.

[honeybadger] define queue interface

Subject

Detail

Reference

[docs] background description docs

Subject
docs for basic concept to understand this project

Detail
docs for about membership protocol, gossip style protocol, etc
I want to write about below subject for background
if anyone want to write docs about basic docs, plz comment in this issue.
Then i'll assign you to that item

• Membership protocol - @hea9549
• Gossip style protocol - @boohyunsik
• Swim protocol

[te] encryption & decryption

Subject
write here

Detail
write here

Reference
write here