sunrise is a blockchain built using Cosmos SDK and CometBFT and created with Ignite CLI.
# install go
go version
# install ignite
ignite version
# v28.3.0
apt install -y protobuf-compiler
protoc --version
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
go install github.com/cosmos/cosmos-proto/cmd/protoc-gen-go-pulsar
^ +-------------------------------+ ^
| | | |
| | State-machine = Application | |
| | | | sunrise (built with Cosmos SDK)
| | ^ + | |
| +----------- | ABCI | ----------+ v
Sunrise | | + v | ^
validator or | | | |
full consensus | | Consensus | |
node | | | |
| +-------------------------------+ | sunrise-core (fork of CometBFT)
| | | |
| | Networking | |
| | | |
v +-------------------------------+ v
Install the sunrise CLI
ignite chain build
If you'd rather not install from source, you can download a prebuilt binary from the releases page.
Navigate to the latest release on https://github.com/SunriseLayer/sunrise/releases.
Download the binary for your platform (e.g. sunrise_Linux_x86_64.tar.gz
) from the Assets section. Tip: if you're not sure what platform you're on, you can run uname -a
and look for the operating system (e.g. Linux
, Darwin
) and architecture (e.g. x86_64
, arm64
).
Extract the archive
tar -xvf sunrise_Linux_x86_64.tar.gz
Verify the extracted binary works
./sunrised --help
[Optional] verify the prebuilt binary checksum. Download checksums.txt
and then verify the checksum:
sha256sum --ignore-missing --check checksums.txt
You should see output like this:
sunrise_Linux_x86_64.tar.gz: OK
See https://docs.sunriselayer.io/node/build-node for more information.
# Print help
sunrised --help
Variable | Explanation | Default value | Required |
---|---|---|---|
SUNRISE_HOME |
Home directory for the application | User home dir. Ref. | Optional |
# Start a single node devnet
./scripts/single-node.sh
# Publish blob data to the local devnet
sunrised tx blob pay-for-blob 0x00010203040506070809 0x48656c6c6f2c20576f726c6421 \
--chain-id private \
--from validator \
--keyring-backend test \
--fees 21000urise \
--yes
[!NOTE] The sunrised binary doesn't support signing with Ledger hardware wallets on Windows and OpenBSD.
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.
# Get more info on ignite commands.
ignite help
# Build and install the sunrised binary into the $GOPATH/bin directory.
ignite chain build
# Regenerate Protobuf files (this assumes Docker is running)
ignite generate proto-go
# Regenerate OpenAPI spec file (this assumes Docker is running)
ignite generate openapi
# Generate TypeScript frontend client files (this assumes Docker is running)
ignite generate ts-client
# Run tests
go test ./...