blob

Documentation

Index

• Variables
• func BlobsToShares(blobs ...*Blob) ([]share.Share, error)
• type Blob
  • func NewBlob(shareVersion uint8, namespace namespace.ID, data []byte) (*Blob, error)
  • func SharesToBlobs(rawShares []share.Share) ([]*Blob, error)
  • func (b *Blob) Namespace() namespace.ID
• type Commitment
  • func (com Commitment) Equal(c Commitment) bool
  • func (com Commitment) String() string
• type Proof
  • func (p Proof) Len() int
• type Service
  • func NewService(state *state.CoreAccessor, getter share.Getter, ...) *Service
  • func (s *Service) Get(ctx context.Context, height uint64, nID namespace.ID, commitment Commitment) (*Blob, error)
  • func (s *Service) GetAll(ctx context.Context, height uint64, nIDs ...namespace.ID) ([]*Blob, error)
  • func (s *Service) GetProof(ctx context.Context, height uint64, nID namespace.ID, commitment Commitment) (*Proof, error)
  • func (s *Service) Included(ctx context.Context, height uint64, nID namespace.ID, proof *Proof, ...) (bool, error)
  • func (s *Service) Submit(ctx context.Context, blobs ...*Blob) (uint64, error)

Variables

var (
	ErrBlobNotFound = errors.New("blob: not found")
	ErrInvalidProof = errors.New("blob: invalid proof")
)

Functions

func BlobsToShares

func BlobsToShares(blobs ...*Blob) ([]share.Share, error)

BlobsToShares accepts blobs and convert them to the Shares.

Types

type Blob

type Blob struct {
	types.Blob

	Commitment Commitment
}

Blob represents any application-specific binary data that anyone can submit to Celestia.

func NewBlob

func NewBlob(shareVersion uint8, namespace namespace.ID, data []byte) (*Blob, error)

NewBlob constructs a new blob from the provided namespace.ID and data.

func SharesToBlobs

func SharesToBlobs(rawShares []share.Share) ([]*Blob, error)

SharesToBlobs takes raw shares and converts them to the blobs.

func (*Blob) Namespace

func (b *Blob) Namespace() namespace.ID

Namespace returns blob's namespace.

type Commitment

type Commitment []byte

Commitment is a Merkle Root of the subtree built from shares of the Blob. It is computed by splitting the blob into shares and building the Merkle subtree to be included after Submit.

func (Commitment) Equal

func (com Commitment) Equal(c Commitment) bool

Equal ensures that commitments are the same

func (Commitment) String

func (com Commitment) String() string

type Proof

type Proof []*nmt.Proof

Proof is a collection of nmt.Proofs that verifies the inclusion of the data.

func (Proof) Len

func (p Proof) Len() int

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(
	state *state.CoreAccessor,
	getter share.Getter,
	headerGetter func(context.Context, uint64) (*header.ExtendedHeader, error),
) *Service

func (*Service) Get

func (s *Service) Get(ctx context.Context, height uint64, nID namespace.ID, commitment Commitment) (*Blob, error)

Get retrieves all the blobs for given namespaces at the given height by commitment.

func (*Service) GetAll

func (s *Service) GetAll(ctx context.Context, height uint64, nIDs ...namespace.ID) ([]*Blob, error)

GetAll returns all blobs under the given namespaces at the given height. GetAll can return blobs and an error in case if some requests failed.

func (*Service) GetProof

func (s *Service) GetProof(
	ctx context.Context,
	height uint64,
	nID namespace.ID,
	commitment Commitment,
) (*Proof, error)

GetProof retrieves all blobs in the given namespaces at the given height by commitment and returns their Proof.

func (*Service) Included

func (s *Service) Included(
	ctx context.Context,
	height uint64,
	nID namespace.ID,
	proof *Proof,
	com Commitment,
) (bool, error)

Included verifies that the blob was included in a specific height. To ensure that blob was included in a specific height, we need: 1. verify the provided commitment by recomputing it; 2. verify the provided Proof against subtree roots that were used in 1.;

func (*Service) Submit

func (s *Service) Submit(ctx context.Context, blobs ...*Blob) (uint64, error)

Submit sends PFB transaction and reports the height in which it was included. Allows sending multiple Blobs atomically synchronously. Uses default wallet registered on the Node.