client

Documentation

Index

• Constants
• Variables
• type Height
  • func NewHeightFromBN(n *big.Int) Height
  • func (*Height) Descriptor() ([]byte, []int)
  • func (m *Height) GetRevisionHeight() uint64
  • func (m *Height) GetRevisionNumber() uint64
  • func (m *Height) Marshal() (dAtA []byte, err error)
  • func (m *Height) MarshalTo(dAtA []byte) (int, error)
  • func (m *Height) MarshalToSizedBuffer(dAtA []byte) (int, error)
  • func (*Height) ProtoMessage()
  • func (m *Height) Reset()
  • func (m *Height) Size() (n int)
  • func (m *Height) String() string
  • func (h *Height) ToBN() *big.Int
  • func (h *Height) ToCallData() ibchandler.HeightData
  • func (m *Height) Unmarshal(dAtA []byte) error
  • func (m *Height) XXX_DiscardUnknown()
  • func (m *Height) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Height) XXX_Merge(src proto.Message)
  • func (m *Height) XXX_Size() int
  • func (m *Height) XXX_Unmarshal(b []byte) error

Constants

const (
	// IBFT2 Client
	BesuIBFT2Client = "hyperledger-besu-ibft2"
	// NOTE: The mock client is only intended for use in development such as ganache.
	MockClient = "mock-client"
)

client type

Variables

var (
	ErrInvalidLengthClient        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowClient          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupClient = fmt.Errorf("proto: unexpected end of group")
)

Types

type Height

type Height struct {
	// the revision that the client is currently on
	RevisionNumber uint64 `protobuf:"varint,1,opt,name=revision_number,json=revisionNumber,proto3" json:"revision_number,omitempty"`
	// the height within the given revision
	RevisionHeight uint64 `protobuf:"varint,2,opt,name=revision_height,json=revisionHeight,proto3" json:"revision_height,omitempty"`
}

Height is a monotonically increasing data type that can be compared against another Height for the purposes of updating and freezing clients

Normally the RevisionHeight is incremented at each height while keeping RevisionNumber the same. However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the RevisionNumber is incremented so that height continues to be monitonically increasing even as the RevisionHeight gets reset

func NewHeightFromBN

func NewHeightFromBN(n *big.Int) Height

func (*Height) Descriptor

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

func (*Height) GetRevisionHeight

func (m *Height) GetRevisionHeight() uint64

func (*Height) GetRevisionNumber

func (m *Height) GetRevisionNumber() uint64

func (*Height) Marshal

func (m *Height) Marshal() (dAtA []byte, err error)

func (*Height) MarshalTo

func (m *Height) MarshalTo(dAtA []byte) (int, error)

func (*Height) MarshalToSizedBuffer

func (m *Height) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Height) ProtoMessage

func (*Height) ProtoMessage()

func (*Height) Reset

func (m *Height) Reset()

func (*Height) Size

func (m *Height) Size() (n int)

func (*Height) String

func (m *Height) String() string

func (*Height) ToBN

func (h *Height) ToBN() *big.Int

func (*Height) ToCallData

func (h *Height) ToCallData() ibchandler.HeightData

func (*Height) Unmarshal

func (m *Height) Unmarshal(dAtA []byte) error

func (*Height) XXX_DiscardUnknown

func (m *Height) XXX_DiscardUnknown()

func (*Height) XXX_Marshal

func (m *Height) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Height) XXX_Merge

func (m *Height) XXX_Merge(src proto.Message)

func (*Height) XXX_Size

func (m *Height) XXX_Size() int

func (*Height) XXX_Unmarshal

func (m *Height) XXX_Unmarshal(b []byte) error