The highest tagged major version is
README
¶
go-square
go-square is a Go module that provides data structures and utilities for interacting with data squares in the Celestia network. The data square is a special form of block serialization in the Celestia blockchain. This repo deals with the original data square which is distinct from the extended data square. Operations on the extended data square are handled by rsmt2d.
| Package | Description |
|---|---|
| blob | Package blob provides types and functions for working with blobs, blob transactions, and index wrapper transactions. |
| inclusion | Package inclusion contains functions to generate the blob share commitment from a given blob. |
| merkle | Package merkle computes a deterministic minimal height Merkle tree hash. |
| namespace | Package namespace contains the Namespace data structure. |
| shares | Package shares contains the Share data structure. |
| square | Package square implements the logic to construct the original data square based on a list of transactions. |
Installation
To use go-square as a dependency in your Go project, you can use go get:
go get github.com/celestiaorg/go-square
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
This repo attempts to conform to conventional commits so PR titles should ideally start with fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, or test: because this helps with semantic versioning and changelog generation. It is especially important to include an ! (e.g. feat!:) if the PR includes a breaking change.
Tools
- Install Go 1.21.5
- Install golangci-lint
- Fork this repo
- Make your changes
- Submit a pull request
Helpful Commands
# Display all available make commands
make help
# Run tests
make test
# Run linter
make lint
# Perform benchmarking
make bench
Directories
¶
| Path | Synopsis |
|---|---|
|
Package blob provides types and functions for working with blobs, blob transactions, and index wrapper transactions.
|
Package blob provides types and functions for working with blobs, blob transactions, and index wrapper transactions. |
|
Package inclusion contains functions to generate the blob share commitment from a given blob.
|
Package inclusion contains functions to generate the blob share commitment from a given blob. |
|
internal
|
|
|
merkle
module
|
|
|
Package namespace contains the Namespace data structure.
|
Package namespace contains the Namespace data structure. |
|
Package shares contains the Share data structure.
|
Package shares contains the Share data structure. |
|
Package square implements the logic to construct the original data square based on a list of transactions.
|
Package square implements the logic to construct the original data square based on a list of transactions. |