Documentation
¶
Index ¶
- func ConstructModule() fx.Option
- type API
- func (api *API) Get(ctx context.Context, height uint64, namespace share.Namespace, ...) (*blob.Blob, error)
- func (api *API) GetAll(ctx context.Context, height uint64, namespaces []share.Namespace) ([]*blob.Blob, error)
- func (api *API) GetProof(ctx context.Context, height uint64, namespace share.Namespace, ...) (*blob.Proof, error)
- func (api *API) Included(ctx context.Context, height uint64, namespace share.Namespace, ...) (bool, error)
- func (api *API) Submit(ctx context.Context, blobs []*blob.Blob) (uint64, error)
- type Module
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConstructModule ¶
Types ¶
type API ¶
type API struct {
Internal struct {
Submit func(context.Context, []*blob.Blob) (uint64, error) `perm:"write"`
Get func(context.Context, uint64, share.Namespace, blob.Commitment) (*blob.Blob, error) `perm:"read"`
GetAll func(context.Context, uint64, []share.Namespace) ([]*blob.Blob, error) `perm:"read"`
GetProof func(context.Context, uint64, share.Namespace, blob.Commitment) (*blob.Proof, error) `perm:"read"`
Included func(context.Context, uint64, share.Namespace, *blob.Proof, blob.Commitment) (bool, error) `perm:"read"`
}
}
type Module ¶
type Module interface {
// Submit sends Blobs and reports the height in which they were included.
// Allows sending multiple Blobs atomically synchronously.
// Uses default wallet registered on the Node.
Submit(_ context.Context, _ []*blob.Blob) (height uint64, _ error)
// Get retrieves the blob by commitment under the given namespace and height.
Get(_ context.Context, height uint64, _ share.Namespace, _ blob.Commitment) (*blob.Blob, error)
// GetAll returns all blobs under the given namespaces and height.
GetAll(_ context.Context, height uint64, _ []share.Namespace) ([]*blob.Blob, error)
// GetProof retrieves proofs in the given namespaces at the given height by commitment.
GetProof(_ context.Context, height uint64, _ share.Namespace, _ blob.Commitment) (*blob.Proof, error)
// Included checks whether a blob's given commitment(Merkle subtree root) is included at
// given height and under the namespace.
Included(_ context.Context, height uint64, _ share.Namespace, _ *blob.Proof, _ blob.Commitment) (bool, error)
}
Module defines the API related to interacting with the blobs
Click to show internal directories.
Click to hide internal directories.