dkg

Documentation

Overview

Package dkg is a generated protocol buffer package.

It is generated from these files:

dkg/dkg.proto

It has these top-level messages:

ResharePacket
ReshareResponse
DKGPacket
DKGResponse
Deal
Response
Justification

Index

• func RegisterDkgServer(s *grpc.Server, srv DkgServer)
• type DKGPacket
  • func (*DKGPacket) Descriptor() ([]byte, []int)
  • func (m *DKGPacket) GetDeal() *Deal
  • func (m *DKGPacket) GetJustification() *Justification
  • func (m *DKGPacket) GetResponse() *Response
  • func (*DKGPacket) ProtoMessage()
  • func (m *DKGPacket) Reset()
  • func (m *DKGPacket) String() string
• type DKGResponse
  • func (*DKGResponse) Descriptor() ([]byte, []int)
  • func (*DKGResponse) ProtoMessage()
  • func (m *DKGResponse) Reset()
  • func (m *DKGResponse) String() string
• type Deal
  • func (*Deal) Descriptor() ([]byte, []int)
  • func (m *Deal) GetDeal() *vss.EncryptedDeal
  • func (m *Deal) GetIndex() uint32
  • func (m *Deal) GetSignature() []byte
  • func (*Deal) ProtoMessage()
  • func (m *Deal) Reset()
  • func (m *Deal) String() string
• type DkgClient
  • func NewDkgClient(cc *grpc.ClientConn) DkgClient
• type DkgServer
• type Justification
  • func (*Justification) Descriptor() ([]byte, []int)
  • func (m *Justification) GetIndex() uint32
  • func (m *Justification) GetJustification() *vss.Justification
  • func (*Justification) ProtoMessage()
  • func (m *Justification) Reset()
  • func (m *Justification) String() string
• type ResharePacket
  • func (*ResharePacket) Descriptor() ([]byte, []int)
  • func (m *ResharePacket) GetGroupHash() string
  • func (m *ResharePacket) GetPacket() *DKGPacket
  • func (*ResharePacket) ProtoMessage()
  • func (m *ResharePacket) Reset()
  • func (m *ResharePacket) String() string
• type ReshareResponse
  • func (*ReshareResponse) Descriptor() ([]byte, []int)
  • func (*ReshareResponse) ProtoMessage()
  • func (m *ReshareResponse) Reset()
  • func (m *ReshareResponse) String() string
• type Response
  • func (*Response) Descriptor() ([]byte, []int)
  • func (m *Response) GetIndex() uint32
  • func (m *Response) GetResponse() *vss.Response
  • func (*Response) ProtoMessage()
  • func (m *Response) Reset()
  • func (m *Response) String() string

Functions

func RegisterDkgServer

func RegisterDkgServer(s *grpc.Server, srv DkgServer)

Types

type DKGPacket

type DKGPacket struct {
	Deal          *Deal          `protobuf:"bytes,1,opt,name=deal" json:"deal,omitempty"`
	Response      *Response      `protobuf:"bytes,2,opt,name=response" json:"response,omitempty"`
	Justification *Justification `protobuf:"bytes,3,opt,name=justification" json:"justification,omitempty"`
}

DKGPacket is used by the nodes to run the dkg protocol before being able to generate randomness beacons.

func (*DKGPacket) Descriptor

func (*DKGPacket) Descriptor() ([]byte, []int)

func (*DKGPacket) GetDeal

func (m *DKGPacket) GetDeal() *Deal

func (*DKGPacket) GetJustification

func (m *DKGPacket) GetJustification() *Justification

func (*DKGPacket) GetResponse

func (m *DKGPacket) GetResponse() *Response

func (*DKGPacket) ProtoMessage

func (*DKGPacket) ProtoMessage()

func (*DKGPacket) Reset

func (m *DKGPacket) Reset()

func (*DKGPacket) String

func (m *DKGPacket) String() string

type DKGResponse

type DKGResponse struct {
}

func (*DKGResponse) Descriptor

func (*DKGResponse) Descriptor() ([]byte, []int)

func (*DKGResponse) ProtoMessage

func (*DKGResponse) ProtoMessage()

func (*DKGResponse) Reset

func (m *DKGResponse) Reset()

func (*DKGResponse) String

func (m *DKGResponse) String() string

type Deal

type Deal struct {
	// index of the dealer, the issuer of the share
	Index uint32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
	// encrypted version of the deal
	Deal *vss.EncryptedDeal `protobuf:"bytes,2,opt,name=deal" json:"deal,omitempty"`
	// signature of the whole deal
	// NOTE: this is almost duplicated data, since the vss deal already includes
	// a signature. However it does not include the index of the dealer that
	// issue this deal, so another one is required. Best would be to merge vss
	// and dkg so we could use only one field of signature. For future work...
	// :)
	Signature []byte `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`
}

Deal contains a share for a participant.

func (*Deal) Descriptor

func (*Deal) Descriptor() ([]byte, []int)

func (*Deal) GetDeal

func (m *Deal) GetDeal() *vss.EncryptedDeal

func (*Deal) GetIndex

func (m *Deal) GetIndex() uint32

func (*Deal) GetSignature

func (m *Deal) GetSignature() []byte

func (*Deal) ProtoMessage

func (*Deal) ProtoMessage()

func (*Deal) Reset

func (m *Deal) Reset()

func (*Deal) String

func (m *Deal) String() string

type DkgClient

type DkgClient interface {
	Setup(ctx context.Context, in *DKGPacket, opts ...grpc.CallOption) (*DKGResponse, error)
	Reshare(ctx context.Context, in *ResharePacket, opts ...grpc.CallOption) (*ReshareResponse, error)
}

func NewDkgClient

func NewDkgClient(cc *grpc.ClientConn) DkgClient

type DkgServer

type DkgServer interface {
	Setup(context.Context, *DKGPacket) (*DKGResponse, error)
	Reshare(context.Context, *ResharePacket) (*ReshareResponse, error)
}

type Justification

type Justification struct {
	// index of the dealer who is issuing this justification
	Index uint32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
	// justification from the dealer
	Justification *vss.Justification `protobuf:"bytes,2,opt,name=justification" json:"justification,omitempty"`
}

Justification holds the justification from a dealer after a participant issued a complaint response because of a supposedly invalid deal.

func (*Justification) Descriptor

func (*Justification) Descriptor() ([]byte, []int)

func (*Justification) GetIndex

func (m *Justification) GetIndex() uint32

func (*Justification) GetJustification

func (m *Justification) GetJustification() *vss.Justification

func (*Justification) ProtoMessage

func (*Justification) ProtoMessage()

func (*Justification) Reset

func (m *Justification) Reset()

func (*Justification) String

func (m *Justification) String() string

type ResharePacket

type ResharePacket struct {
	GroupHash string     `protobuf:"bytes,1,opt,name=group_hash,json=groupHash" json:"group_hash,omitempty"`
	Packet    *DKGPacket `protobuf:"bytes,2,opt,name=packet" json:"packet,omitempty"`
}

special wrapper for resharing operation that serves two purposes: - indicate to non-leader old nodes that they should generate and send their deals - indicate to which new group are we resharing. drand should keep a list of new ready-to-operate groups allowed.

func (*ResharePacket) Descriptor

func (*ResharePacket) Descriptor() ([]byte, []int)

func (*ResharePacket) GetGroupHash

func (m *ResharePacket) GetGroupHash() string

func (*ResharePacket) GetPacket

func (m *ResharePacket) GetPacket() *DKGPacket

func (*ResharePacket) ProtoMessage

func (*ResharePacket) ProtoMessage()

func (*ResharePacket) Reset

func (m *ResharePacket) Reset()

func (*ResharePacket) String

func (m *ResharePacket) String() string

type ReshareResponse

type ReshareResponse struct {
}

empty return response

func (*ReshareResponse) Descriptor

func (*ReshareResponse) Descriptor() ([]byte, []int)

func (*ReshareResponse) ProtoMessage

func (*ReshareResponse) ProtoMessage()

func (*ReshareResponse) Reset

func (m *ReshareResponse) Reset()

func (*ReshareResponse) String

func (m *ReshareResponse) String() string

type Response

type Response struct {
	// index of the dealer for which this response is for
	Index uint32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
	// response from the participant which received a deal
	Response *vss.Response `protobuf:"bytes,2,opt,name=response" json:"response,omitempty"`
}

Response holds the response that a participant broadcast after having received a deal.

func (*Response) Descriptor

func (*Response) Descriptor() ([]byte, []int)

func (*Response) GetIndex

func (m *Response) GetIndex() uint32

func (*Response) GetResponse

func (m *Response) GetResponse() *vss.Response

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) Reset

func (m *Response) Reset()

func (*Response) String

func (m *Response) String() string