README
¶
mao-bft
mao-bft is an efficient byzantine fault tolerance protocol without leader reelection
Consensus layer
We design consensus layer independent from upper application layer, this mean that our BFT algorithm should be able to carry any message. To achieve this, we define the message to be any protobuf payload. In the mean time, each node in the cluster should be http server based on gRPC, we define RPC as below:
Message Flow
We use RBC(Reliable Broadcast) as a building block. Optional: use threshold signature instead of "echo and prepare"
Message Types
- Common Types This message defines common messages shared by RPC.
message Payload {
string merkel_root;
repeated string merkel_branch;
bytes data;
}
- PrepareValue This message is sent by leader and makes value known to every follower.
rpc PrepareValue (PrepareValueRequest) returns (PrepareValueResponse) {}
message PrepareValueRequest {
Payload payload;
}
message PrepareValueResponse {}
- EchoValue This message is send from everyone uppon receiving PrepareValue
rpc EchoValue (EchoValueRequest) returns (EchoValueResponse) {}
message EchoValueRequest {
Payload payload;
}
message EchoValueResponse {}
- ReadyValue This message is send from everyone uppon receiving enough EchoValue
rpc EchoValue (EchoValueRequest) returns (EchoValueResponse) {}
message ReadyValueRequest {
string merkel_root;
}
message ReadyValueResponse {}
Application layer
- GetTransactionStatus This message is used by client to get TX status in the system.
define RPC here
Applications
We can utilize this protocal to implement different type of applications, in example folder we have a blockchain for demo
Documentation
¶
Index ¶
- type Common
- type Follower
- func (c *Follower) Echo(ctx context.Context, req *pb.Payload) (*pb.EchoResponse, error)
- func (c *Follower) Name() string
- func (s *Follower) Prepare(ctx context.Context, req *pb.Payload) (*pb.PrepareResponse, error)
- func (c *Follower) Ready(ctx context.Context, req *pb.ReadyRequest) (*pb.ReadyResponse, error)
- type Leader
- type Mao
- type MaoFollower
- type Message
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Common ¶
type Common interface {
Name() string
SendEcho(conn *grpc.ClientConn, merkleProof *pb.MerkleProof, data []byte) error
SendReady(conn *grpc.ClientConn, merkleRoot []byte) error
pb.ReadyServer
pb.EchoServer
}
type Follower ¶
type Follower struct {
pb.UnimplementedPrepareServer
// contains filtered or unexported fields
}
func NewFollower ¶
func (*Follower) Ready ¶
func (c *Follower) Ready(ctx context.Context, req *pb.ReadyRequest) (*pb.ReadyResponse, error)
Ready serves ready messages from other nodes
type Leader ¶
type Leader struct {
rbc.PrepareClientWrapper
// contains filtered or unexported fields
}
func (*Leader) Ready ¶
func (c *Leader) Ready(ctx context.Context, req *pb.ReadyRequest) (*pb.ReadyResponse, error)
Ready serves ready messages from other nodes
type Mao ¶
type Mao interface {
SendPrepare(conn *grpc.ClientConn, merkleProof *pb.MerkleProof, data []byte) error
Common
}
type MaoFollower ¶
type MaoFollower interface {
pb.PrepareServer
Common
}
type Message ¶
type Message interface {
encoding.BinaryMarshaler
}
Source Files
Directories