Official golang implementation of the Canopy Network Protocol

Overview

Connect to mainnet with a `canopy` node. For more information on the Canopy Network Protocol visit canopy network

How to run it

To run the Canopy binary you can use the following flags alongside the `canopy` executable:

Usage:
  canopy [command]

Available Commands:
  admin       admin only operations for the node
  help        Help about any command
  query       query the blockchain rpc
  start       start the blockchain software

Flags:
      --data-dir string   custom data directory location (default "$HOME/.canopy")
  -h, --help              help for canopy
      --version           version for canop

Running Tests

To run Canopy unit tests, use the Go testing tools:

make test

How to contribute

Canopy is an open-source project, and we welcome contributions from the community. Here's how you can get involved:

1. Fork the repository and clone it locally.
2. Code your improvements or fixes.
3. Submit a Pull Request (PR) for review.

Please follow the guidelines below to help us maintain high-quality contributions:

High Impact or Architectural Changes

Before making large changes, we encourage you to discuss them with the Canopy team on Discord. This ensures we're aligned on the direction of the project.

You can also post research and ideas on our forum.

Coding Style

• Code must adhere to the official Go formatting guidelines (i.e. use gofmt).
• (Optional) Use EditorConfig to help your text editor maintain consistent formatting across the project.
• Code must be documented following the official Go commentary guidelines.
• Pull requests should be based on and opened against the development branch.

How to build

To build the project, run the following command:

make build

Contact