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, рекурсивной платформы для блокчейнов, где новые цепочки запускаются с помощью «исходной цепочки» (seed chain) и получают встроенную безопасность и консенсус вместо того, чтобы стартовать с нуля.
Это блокчейн-узел, который я запускаю, или фреймворк для создания новых цепочек?И то, и другое: полноценный узел, который вы запускаете как часть P2P-сети (контроллер, конечный автомат, BFT-консенсус, P2P-сеть и слой хранения данных), а также рекурсивный фреймворк, с помощью которого другие цепочки могут запускать себя.
Как запустить узел Canopy?Клонируйте репозиторий и запустите бинарный файл Canopy, following the commands in the README's 'How to Run It' section, или поднимите контейнеризированный Canopy Localnet с помощью Docker.
Нужен ли Docker, или можно просто собрать бинарный файл на Go?Go нужен для сборки и тестирования узла (модульные тесты запускаются стандартными инструментами тестирования Go); Docker нужен только если вы предпочитаете запускать контейнеризированный Localnet.
На что обратить внимание перед началом работы?README указывает точные команды запуска, спецификацию RPC и документацию по протоколу через ссылки на разделы, а не приводит всё внутри, поэтому, скорее всего, придётся пройти по этим ссылкам (wiki, eth-spec), чтобы разобраться с настройкой и деталями совместимости.
Работает ли это только на серверах Linux?Кодовая база написана на чистом Go и содержит готовый Dockerfile, поэтому она должна собираться и работать на Linux, macOS и Windows, хотя документированный сценарий для узлов опирается на Linux/Docker.
Можно ли подключить MetaMask или другие инструменты Ethereum к цепочке Canopy?Да — Canopy предоставляет RPC, совместимый с Ethereum, по адресу /v1/eth, поэтому существующие кошельки, биржи и индексаторы Ethereum, включая MetaMask, могут подключаться так, будто работают с обычной конечной точкой Ethereum.
Остаётся ли новая цепочка, созданная на Canopy, навсегда связанной с исходной цепочкой?Нет — рекурсивная модель позволяет новым цепочкам запускаться с опорой на существующие, но в итоге они становятся независимыми и вместе образуют то, что в README названо «неостановимой сетью полезности и безопасности» («an unstoppable web of utility and security»).
Что защищает сеть, если некоторые узлы работают некорректно?Canopy использует BFT-консенсус (Byzantine Fault Tolerant, устойчивый к византийским отказам), который позволяет сети согласовывать новые блоки, даже когда часть узлов ненадёжна или действует злонамеренно.
Из каких основных модулей состоит узел Canopy?Пять главных компонентов: контроллер (координирует всё), конечный автомат (проверяет транзакции и переходы состояний), BFT-консенсус, P2P-сеть и слой хранения (хранение, индексация, верификация).
Size
38.5 MB
Stars
14.7K
Age
1y
Commits · 90 Days