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
这是什么?Canopy 是 Canopy Network 协议的官方 Go 语言实现。它是一个递归式区块链框架,新链可以依托“种子链”启动,直接获得内置的安全性和共识机制,而无需从零开始。
这是我要运行的区块链节点,还是用来搭建新链的框架?两者都是:它既是一个完整节点,作为 P2P 网络的一部分运行(包括控制器、有限状态机、BFT 共识、P2P 网络和持久化层),也是一个供其他链自行启动的递归框架。
我该如何运行 Canopy 节点?克隆仓库,然后按照 README 中 'How to Run It' 一节的命令运行 Canopy 程序,或者使用 Docker 启动容器化的 Canopy Localnet。
我需要安装 Docker,还是直接构建 Go 二进制文件就行?构建和测试节点需要 Go(单元测试通过 Go 标准测试工具运行);只有当你想运行容器化的 Localnet 时才需要 Docker。
深入之前有什么需要注意的吗?README 通过链接的章节指向确切的运行命令、RPC 规范和协议文档,而不是全部写在正文里,所以你可能需要访问这些链接(wiki、eth-spec)来补全安装和兼容性细节。
它只能在 Linux 服务器上运行吗?代码完全由 Go 编写,并提供了 Dockerfile,因此理论上可以在 Linux、macOS 和 Windows 上构建和运行,不过文档中推荐的节点运行流程主要基于 Linux 和 Docker。
我能把 MetaMask 或其他以太坊工具连接到 Canopy 链吗?可以。Canopy 在 /v1/eth 提供兼容以太坊的 RPC 接口,因此现有的以太坊钱包、交易所和索引服务(包括 MetaMask)可以像连接普通以太坊节点一样接入。
用 Canopy 构建的新链会永远依附于种子链吗?不会。递归模型允许新链依托现有链启动,但最终会变得独立,所有链共同构成 README 所说的“一张无法被阻止的效用与安全之网”。
如果部分节点行为不当,什么机制保障网络安全?Canopy 使用拜占庭容错(BFT)共识,即使部分节点不可靠或存在恶意行为,网络仍能就新区块达成一致。
Canopy 节点内部有哪些核心模块?主要有五个部分:控制器(统筹协调全局)、有限状态机(验证交易和状态转换)、BFT 共识、P2P 网络,以及持久化(负责存储、索引和验证)。
Size
38.5 MB
Stars
14.7K
Age
1y
Commits · 90 Days