Documentation
¶
Index ¶
- func ConstructModule() fx.Option
- func MakeID(height uint64, commitment da.Commitment) da.ID
- func SplitID(id da.ID) (uint64, da.Commitment)
- type API
- func (api *API) Commit(ctx context.Context, blobs []da.Blob, ns da.Namespace) ([]da.Commitment, error)
- func (api *API) Get(ctx context.Context, ids []da.ID, ns da.Namespace) ([]da.Blob, error)
- func (api *API) GetIDs(ctx context.Context, height uint64, ns da.Namespace) (*da.GetIDsResult, error)
- func (api *API) GetProofs(ctx context.Context, ids []da.ID, ns da.Namespace) ([]da.Proof, error)
- func (api *API) MaxBlobSize(ctx context.Context) (uint64, error)
- func (api *API) Submit(ctx context.Context, blobs []da.Blob, gasPrice float64, ns da.Namespace) ([]da.ID, error)
- func (api *API) SubmitWithOptions(ctx context.Context, blobs []da.Blob, gasPrice float64, ns da.Namespace, ...) ([]da.ID, error)
- func (api *API) Validate(ctx context.Context, ids []da.ID, proofs []da.Proof, ns da.Namespace) ([]bool, error)
- type Moduledeprecated
- type Service
- func (s *Service) Commit(_ context.Context, daBlobs []da.Blob, namespace da.Namespace) ([]da.Commitment, error)deprecated
- func (s *Service) Get(ctx context.Context, ids []da.ID, ns da.Namespace) ([]da.Blob, error)deprecated
- func (s *Service) GetIDs(ctx context.Context, height uint64, namespace da.Namespace) (*da.GetIDsResult, error)deprecated
- func (s *Service) GetProofs(ctx context.Context, ids []da.ID, namespace da.Namespace) ([]da.Proof, error)deprecated
- func (s *Service) MaxBlobSize(context.Context) (uint64, error)
- func (s *Service) Submit(ctx context.Context, daBlobs []da.Blob, gasPrice float64, ...) ([]da.ID, error)deprecated
- func (s *Service) SubmitWithOptions(ctx context.Context, daBlobs []da.Blob, gasPrice float64, ...) ([]da.ID, error)deprecated
- func (s *Service) Validate(ctx context.Context, ids []da.ID, daProofs []da.Proof, namespace da.Namespace) ([]bool, error)
- type SubmitOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConstructModule ¶
Types ¶
type API ¶
type API struct {
Internal struct {
MaxBlobSize func(ctx context.Context) (uint64, error) `perm:"read"`
Get func(ctx context.Context, ids []da.ID, ns da.Namespace) ([]da.Blob, error) `perm:"read"`
GetIDs func(ctx context.Context, height uint64, ns da.Namespace) (*da.GetIDsResult, error) `perm:"read"`
GetProofs func(ctx context.Context, ids []da.ID, ns da.Namespace) ([]da.Proof, error) `perm:"read"`
Commit func(ctx context.Context, blobs []da.Blob, ns da.Namespace) ([]da.Commitment, error) `perm:"read"`
Validate func(context.Context, []da.ID, []da.Proof, da.Namespace) ([]bool, error) `perm:"read"`
Submit func(context.Context, []da.Blob, float64, da.Namespace) ([]da.ID, error) `perm:"write"`
SubmitWithOptions func(context.Context, []da.Blob, float64, da.Namespace, []byte) ([]da.ID, error) `perm:"write"`
}
}
API is a wrapper around Module for the RPC.
func (*API) SubmitWithOptions ¶ added in v0.17.1
type Module
deprecated
type Module interface {
// MaxBlobSize returns the max blob size
//
// Deprecated: This method is deprecated and will be removed in the future.
MaxBlobSize(ctx context.Context) (uint64, error)
// Get returns Blob for each given ID, or an error.
//
// Error should be returned if ID is not formatted properly, there is no Blob for given ID or any other client-level
// error occurred (dropped connection, timeout, etc).
//
// Deprecated: This method is deprecated and will be removed in the future.
Get(ctx context.Context, ids []da.ID, namespace da.Namespace) ([]da.Blob, error)
// GetIDs returns IDs of all Blobs located in DA at given height.
//
// Deprecated: This method is deprecated and will be removed in the future.
GetIDs(ctx context.Context, height uint64, namespace da.Namespace) (*da.GetIDsResult, error)
// GetProofs returns inclusion Proofs for Blobs specified by their IDs.
//
// Deprecated: This method is deprecated and will be removed in the future.
GetProofs(ctx context.Context, ids []da.ID, namespace da.Namespace) ([]da.Proof, error)
// Commit creates a Commitment for each given Blob.
//
// Deprecated: This method is deprecated and will be removed in the future.
Commit(ctx context.Context, blobs []da.Blob, namespace da.Namespace) ([]da.Commitment, error)
// Submit submits the Blobs to Data Availability layer.
//
// This method is synchronous. Upon successful submission to Data Availability layer, it returns the IDs identifying
// blobs in DA.
//
// Deprecated: This method is deprecated and will be removed in the future.
Submit(ctx context.Context, blobs []da.Blob, gasPrice float64, namespace da.Namespace) ([]da.ID, error)
// SubmitWithOptions submits the Blobs to Data Availability layer.
//
// This method is synchronous. Upon successful submission to Data Availability layer, it returns the IDs identifying
// blobs in DA.
//
// Deprecated: This method is deprecated and will be removed in the future.
SubmitWithOptions(
ctx context.Context, blobs []da.Blob, gasPrice float64, namespace da.Namespace, options []byte) ([]da.ID, error)
// Validate validates Commitments against the corresponding Proofs. This should be possible without retrieving the
// Blobs.
//
// Deprecated: This method is deprecated and will be removed in the future.
Validate(ctx context.Context, ids []da.ID, proofs []da.Proof, namespace da.Namespace) ([]bool, error)
}
Deprecated: The DA API is experimental and deprecated. It is no longer supported and will be removed in the future.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) Commit
deprecated
func (*Service) GetIDs
deprecated
func (*Service) GetProofs
deprecated
func (s *Service) GetProofs(ctx context.Context, ids []da.ID, namespace da.Namespace) ([]da.Proof, error)
GetProofs returns inclusion Proofs for all Blobs located in DA at given height.
Deprecated: The DA API is experimental and deprecated. It is no longer supported and will be removed in the future.
func (*Service) MaxBlobSize ¶
MaxBlobSize returns the max blob size
func (*Service) Submit
deprecated
func (*Service) SubmitWithOptions
deprecated
added in
v0.17.1
func (s *Service) SubmitWithOptions( ctx context.Context, daBlobs []da.Blob, gasPrice float64, namespace da.Namespace, options []byte, ) ([]da.ID, error)
SubmitWithOptions submits the Blobs to Data Availability layer.
Deprecated: The DA API is experimental and deprecated. It is no longer supported and will be removed in the future.
type SubmitOptions ¶ added in v0.17.1
type SubmitOptions struct {
// KeyName is the name of key from the keystore used to sign transactions.
KeyName string `json:"key_name,omitempty"`
// SignerAddress is the address that signs the transaction.
// This address must be stored locally in the key store.
SignerAddress string `json:"signer_address,omitempty"`
// FeeGranterAddress specifies the account that will pay for the transaction fee.
FeeGranterAddress string `json:"fee_granter_address,omitempty"`
}
SubmitOptions defines options for blob submission using SubmitWithOptions.
SubmitWithOptions expects JSON serialized version of this struct; all fields are optional.