byzantine

Documentation

Index

• Constants
• func CreateBadEncodingProof(hash []byte, height uint64, errByzantine *ErrByzantine) fraud.Proof[*header.ExtendedHeader]
• func NewErrByzantine(ctx context.Context, bGetter blockservice.BlockGetter, ...) error
• func ProtoToProof(protoProof *nmt_pb.Proof) nmt.Proof
• type BadEncodingProof
  • func (p *BadEncodingProof) HeaderHash() []byte
  • func (p *BadEncodingProof) Height() uint64
  • func (p *BadEncodingProof) MarshalBinary() ([]byte, error)
  • func (p *BadEncodingProof) Type() fraud.ProofType
  • func (p *BadEncodingProof) UnmarshalBinary(data []byte) error
  • func (p *BadEncodingProof) Validate(hdr *header.ExtendedHeader) error
• type ErrByzantine
  • func (e *ErrByzantine) Error() string
• type ShareWithProof
  • func GetProofsForShares(ctx context.Context, bGetter blockservice.BlockGetter, root cid.Cid, ...) ([]*ShareWithProof, error)
  • func NewShareWithProof(index int, share share.Share, pathToLeaf []cid.Cid) *ShareWithProof
  • func ProtoToShare(protoShares []*pb.Share) []*ShareWithProof
  • func (s *ShareWithProof) ShareWithProofToProto() *pb.Share
  • func (s *ShareWithProof) Validate(root cid.Cid) bool

Constants

const (
	BadEncoding fraud.ProofType = "badencoding" + version
)

Functions

func CreateBadEncodingProof

func CreateBadEncodingProof(
	hash []byte,
	height uint64,
	errByzantine *ErrByzantine,
) fraud.Proof[*header.ExtendedHeader]

CreateBadEncodingProof creates a new Bad Encoding Fraud Proof that should be propagated through network. The fraud proof will contain shares that did not pass verification and their relevant Merkle proofs.

func NewErrByzantine

func NewErrByzantine(
	ctx context.Context,
	bGetter blockservice.BlockGetter,
	dah *da.DataAvailabilityHeader,
	errByz *rsmt2d.ErrByzantineData,
) error

NewErrByzantine creates new ErrByzantine from rsmt2d error. If error happens during proof collection, it terminates the process with os.Exit(1).

func ProtoToProof

func ProtoToProof(protoProof *nmt_pb.Proof) nmt.Proof

Types

type BadEncodingProof

type BadEncodingProof struct {
	BlockHeight uint64
	// ShareWithProof contains all shares from row or col.
	// Shares that did not pass verification in rsmt2d will be nil.
	// For non-nil shares MerkleProofs are computed.
	Shares []*ShareWithProof
	// Index represents the row/col index where ErrByzantineRow/ErrByzantineColl occurred.
	Index uint32
	// Axis represents the axis that verification failed on.
	Axis rsmt2d.Axis
	// contains filtered or unexported fields
}

func (*BadEncodingProof) HeaderHash

func (p *BadEncodingProof) HeaderHash() []byte

HeaderHash returns block hash.

func (*BadEncodingProof) Height

func (p *BadEncodingProof) Height() uint64

Height returns block height.

func (*BadEncodingProof) MarshalBinary

func (p *BadEncodingProof) MarshalBinary() ([]byte, error)

MarshalBinary converts BadEncodingProof to binary.

func (*BadEncodingProof) Type

func (p *BadEncodingProof) Type() fraud.ProofType

Type returns type of fraud proof.

func (*BadEncodingProof) UnmarshalBinary

func (p *BadEncodingProof) UnmarshalBinary(data []byte) error

UnmarshalBinary converts binary to BadEncodingProof.

func (*BadEncodingProof) Validate

func (p *BadEncodingProof) Validate(hdr *header.ExtendedHeader) error

Validate ensures that fraud proof is correct. Validate checks that provided Merkle Proofs correspond to the shares, rebuilds bad row or col from received shares, computes Merkle Root and compares it with block's Merkle Root.

type ErrByzantine

type ErrByzantine struct {
	Index  uint32
	Shares []*ShareWithProof
	Axis   rsmt2d.Axis
}

ErrByzantine is a thrown when recovered data square is not correct (merkle proofs do not match parity erasure-coding data).

It is converted from rsmt2d.ByzantineRow/Col + Merkle Proof for each share.

func (*ErrByzantine) Error

func (e *ErrByzantine) Error() string

type ShareWithProof

type ShareWithProof struct {
	// Share is a full data including namespace
	share.Share
	// Proof is a Merkle Proof of current share
	Proof *nmt.Proof
}

ShareWithProof contains data with corresponding Merkle Proof

func GetProofsForShares

func GetProofsForShares(
	ctx context.Context,
	bGetter blockservice.BlockGetter,
	root cid.Cid,
	shares [][]byte,
) ([]*ShareWithProof, error)

GetProofsForShares fetches Merkle proofs for the given shares and returns the result as an array of ShareWithProof.

func NewShareWithProof

func NewShareWithProof(index int, share share.Share, pathToLeaf []cid.Cid) *ShareWithProof

NewShareWithProof takes the given leaf and its path, starting from the tree root, and computes the nmt.Proof for it.

func ProtoToShare

func ProtoToShare(protoShares []*pb.Share) []*ShareWithProof

func (*ShareWithProof) ShareWithProofToProto

func (s *ShareWithProof) ShareWithProofToProto() *pb.Share

func (*ShareWithProof) Validate

func (s *ShareWithProof) Validate(root cid.Cid) bool

Validate validates inclusion of the share under the given root CID.