/chain-main

Crypto.org Chain⛓: Croeseid Testnet and beyond development

Primary LanguageGoOtherNOASSERTION


Crypto.org Chain


Table of Contents

  1. Description
  2. Contributing
  3. License
  4. Documentation
  5. Build
    1. Nix
  6. Start a Local Full Node
  7. Send your First Transaction
  8. Testing
  9. Useful Links

1. Description

Crypto.org Chain is a blockchain application built using Cosmos SDK and Tendermint, intended as a backbone for some of the existing and future Crypto.org ecosystem.

2. Contributing

Please abide by the Code of Conduct in all interactions, and the contributing guidelines when submitting code.

3. License

Apache 2.0

4. Documentation

Technical documentation can be found in this Github repository (you can read it in this hosted version).

5. Build full node

make build

By default, the command will build a binary with Mainnet configurations.

To build with different network, provided NETWORK variable to make command

NETWORK=testnet make build

1. Nix

Nix is a (cross-language) package manager for reproducible builds. On Linux and macOS, you can install it as follows (on Windows 10, you can possibly use the Windows Subsystem for Linux):

$ curl -L https://nixos.org/nix/install | sh

If you're using a recent Mac with a T2 chip, you might need to check nix macos installation when the command above is not working in your environment.

You can then run:

$ make chaindImage

Which will build a docker image that contains the full node binary.

Optionally, you can also use a binary cache to speed up the build process:

$ nix-env -iA cachix -f https://cachix.org/api/v1/install
$ cachix use crypto-org-chain

6. Start a local Development Network and Node

Please follow this documentation to run a local devnet.

7. Send Your First Transaction

After setting the local devnet, you may interact with the your local blockchain by following this documentation.

8. Testing

There are different tests that can be executed in the following ways:

  • unit tests: make test
  • simulations: make test-sim-* (e.g. make test-sim-nondeterminism)
  • integrations tests: make nix-integration-test (see more details in their documentation)

9. Useful links