blob

func (*Blob) Index ¶ added in v0.13.1

func (b *Blob) Index() int

Index returns the blob's first share index in the EDS. Only retrieved, on-chain blobs will have the index set. Default is -1.

func (*Blob) MarshalJSON ¶

func (b *Blob) MarshalJSON() ([]byte, error)

func (*Blob) Namespace ¶

func (b *Blob) Namespace() share.Namespace

Namespace returns blob's namespace.

func (*Blob) UnmarshalJSON ¶

func (b *Blob) UnmarshalJSON(data []byte) error

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

func (Proof) Len ¶

func (p Proof) Len() int

func (*Service) Get ¶

func (s *Service) Get(
	ctx context.Context,
	height uint64,
	namespace share.Namespace,
	commitment Commitment,
) (blob *Blob, err error)

Get retrieves a blob in a given namespace at the given height by commitment. Get collects all namespaced data from the EDS, construct the blob and compares the commitment argument. `ErrBlobNotFound` can be returned in case blob was not found.

func (*Service) GetAll ¶

func (s *Service) GetAll(ctx context.Context, height uint64, namespaces []share.Namespace) ([]*Blob, error)

GetAll returns all blobs under the given namespaces at the given height. If all blobs were found without any errors, the user will receive a list of blobs. If the BlobService couldn't find any blobs under the requested namespaces, the user will receive an empty list of blobs along with an empty error. If some of the requested namespaces were not found, the user will receive all the found blobs and an empty error. If there were internal errors during some of the requests, the user will receive all found blobs along with a combined error message.

All blobs will preserve the order of the namespaces that were requested.

func (*Service) GetProof ¶

func (s *Service) GetProof(
	ctx context.Context,
	height uint64,
	namespace share.Namespace,
	commitment Commitment,
) (proof *Proof, err error)

GetProof returns an NMT inclusion proof for a specified namespace to the respective row roots on which the blob spans on at the given height, using the given commitment. It employs the same algorithm as service.Get() internally.

func (*Service) Included ¶

func (s *Service) Included(
	ctx context.Context,
	height uint64,
	namespace share.Namespace,
	proof *Proof,
	commitment Commitment,
) (_ bool, err 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, txConfig *SubmitOptions) (uint64, error)

Submit sends PFB transaction and reports the height at which it was included. Allows sending multiple Blobs atomically synchronously. Uses default wallet registered on the Node. Handles gas estimation and fee calculation.