README
¶
go-da
go-da defines a generic Data Availability interface for modular blockchains.
DA Interface
| Method | Params | Return |
|---|---|---|
MaxBlobSize |
uint64 |
|
Get |
ids []ID, namespace Namespace |
[]Blobs |
GetIDs |
height uint64, namespace Namespace |
[]ID |
GetProofs |
ids []id, namespace Namespace |
[]Proof |
Commit |
blobs []Blob, namespace Namespace |
[]Commitment |
Validate |
ids []Blob, proofs []Proof, namespace Namespace |
[]bool |
Submit |
blobs []Blob, gasPrice float64, namespace Namespace |
[]ID |
NOTE: The Namespace parameter in the interface methods is optional and used
only on DA layers that support the functionality, for example Celestia
namespaces and Avail AppIDs.
Implementations
The following implementations are available:
- celestia-da implements Celestia as DA.
- avail-da implements Polygon Avail as DA.
In addition the following helper implementations are available:
- DummyDA implements a Mock DA useful for testing.
- Proxy implements a proxy server that forwards requests to a gRPC server. The proxy client can be used directly to interact with the DA service.
Helpful commands
# Generate protobuf files. Requires docker.
make proto-gen
# Lint protobuf files. Requires docker.
make proto-lint
# Run tests.
make test
# Run linters (requires golangci-lint, markdownlint, hadolint, and yamllint)
make lint
Contributing
We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code, documentation, bug reports, feature requests, or anything else.
If you're looking for issues to work on, try looking at the good first issue list. Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!
Please join our Community Discord to ask questions, discuss your ideas, and connect with other contributors.
Code of Conduct
See our Code of Conduct here.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Commitment ¶
type Commitment = []byte
Commitment should contain serialized cryptographic commitment to Blob value.
type DA ¶
type DA interface {
// MaxBlobSize returns the max blob size
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).
Get(ctx context.Context, ids []ID, namespace Namespace) ([]Blob, error)
// GetIDs returns IDs of all Blobs located in DA at given height.
GetIDs(ctx context.Context, height uint64, namespace Namespace) ([]ID, error)
// GetProofs returns inclusion Proofs for Blobs specified by their IDs.
GetProofs(ctx context.Context, ids []ID, namespace Namespace) ([]Proof, error)
// Commit creates a Commitment for each given Blob.
Commit(ctx context.Context, blobs []Blob, namespace Namespace) ([]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.
Submit(ctx context.Context, blobs []Blob, gasPrice float64, namespace Namespace) ([]ID, error)
// Validate validates Commitments against the corresponding Proofs. This should be possible without retrieving the Blobs.
Validate(ctx context.Context, ids []ID, proofs []Proof, namespace Namespace) ([]bool, error)
}
DA defines very generic interface for interaction with Data Availability layers.
type ID ¶
type ID = []byte
ID should contain serialized data required by the implementation to find blob in Data Availability layer.
Source Files
Directories