Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 3.41 KB

README.md

File metadata and controls

77 lines (56 loc) · 3.41 KB
Raw

go-da

go-da defines a generic Data Availability interface for modular blockchains.

build-and-test golangci-lint Go Report Card codecov GoDoc

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:

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.