canopy README

The project's README from github.com/canopy-network/canopy. As one markdown file: README.md.

Canopy Logo

Official golang implementation of the Canopy Network Protocol

GoDoc Getting Started Go Version Next.js Version

Overview

License Testing Platform Status

⫸ Welcome to the Network that Powers the Peer-to-Peer Launchpad for New Chains

Built on a recursive architecture, chains bootstrap each other into independence —
forming an unstoppable web of utility and security.

Here you'll find:

➪ A recursive framework to build blockchains.

➪ The seed chain that started the recursive cycle.

For more information on the Canopy Network Protocol visit https://canopynetwork.org

Standard

➪ Canopy is an Ethereum-RPC compatible L1 for native transfers, so it can plug into existing Ethereum exchange, wallet, and indexer tooling, including MetaMask. Use the /v1/eth endpoint as a custom Ethereum RPC and review the compatibility notes in the eth-spec

RPC

➪ Full RPC Specification

Protocol Documentation

➪ Check out the Canopy Network wiki: https://canopy-network.gitbook.io/docs

Repository Documentation

Welcome to the Canopy Network reference implementation. This repository can be well understood reading about the core modules:

How to Run It

➪ To run the Canopy binary, use the following commands:

make build/canopy-full
canopy start

How to Run It with 🐳 Docker

➪ To run a Canopy Localnet in a containerized environment, use the following commands:

make docker/build
make docker/up-fast
make docker/logs

or simply

make docker/up && make docker/logs

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 to 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 these guidelines to maintain high-quality contributions:

High Impact or Architectural Changes

➪ Before making large changes, discuss them with the Canopy team on Discord to ensure alignment.

Coding Style

Pre-Release Contributors Last Commit

Contact

Twitter Discord

canopy (canopy-network/canopy)

Searching Database…

14.7K ·GitHub
What is this?Canopy is the official Go implementation of the Canopy Network Protocol, a recursive blockchain framework where new chains bootstrap off a 'seed chain' to launch with built-in security and consensus instead of starting from scratch.
Is this a blockchain node I run, or a framework for building new chains?It's both: a full node you run as part of the P2P network (Controller, Finite State Machine, BFT consensus, P2P networking, and a persistence layer) and a recursive framework other chains can use to launch themselves.
How do I get a Canopy node running?Clone the repo and run the Canopy binary following the commands in the README's 'How to Run It' section, or spin up a containerized Canopy Localnet with Docker.
Do I need Docker, or can I just build the Go binary?Go is required to build and test the node (unit tests run via the standard Go testing tools); Docker is only needed if you prefer running the containerized Localnet.
Anything to watch out for before diving in?The README points to the exact run commands, RPC spec and protocol docs via linked sections rather than inlining everything, so you'll likely need to follow those links (wiki, eth-spec) to fill in setup and compatibility details.
Does it only run on Linux servers?The codebase is pure Go with a provided Dockerfile, so it should build and run on Linux, macOS and Windows, though the documented workflow leans on Linux/Docker for nodes.
Can I connect MetaMask or other Ethereum tools to a Canopy chain?Yes — Canopy exposes an Ethereum-compatible RPC at /v1/eth, so existing Ethereum wallets, exchanges and indexers, including MetaMask, can plug in as if talking to a normal Ethereum endpoint.
Does a new chain built with Canopy stay tied to the seed chain forever?No — the recursive model lets new chains bootstrap off existing ones but eventually become independent, together forming what the README calls 'an unstoppable web of utility and security.'
What keeps the network safe if some nodes misbehave?Canopy uses Byzantine Fault Tolerant (BFT) consensus, which lets the network agree on new blocks even when some nodes are unreliable or malicious.
What are the core modules inside a Canopy node?Five main pieces: the Controller (coordinates everything), the Finite State Machine (validates transactions and state transitions), BFT Consensus, P2P Networking, and Persistence (storage, indexing, verification).
Size
38.5 MB
Stars
14.7K
Age
1y
Commits · 90 Days