高度模块化, 遵循 KISS原则的区块链开发框架
官方网站和文档: https://chain.33.cn
官方插件库: https://github.com/33cn/plugin
典型案例: https://github.com/bityuan/bityuan
chain33背后故事: chain33诞生记
视频教程: 视频教程
Chain33 采用分层模块化设计, 核心模块按层次划分:
| 层次 | 模块 | 说明 |
|---|---|---|
| 协议与数据 | types/ |
protobuf 自动生成的类型定义(交易、区块、地址等) |
| 区块链核心 | blockchain/ store/ mempool/ account/ |
区块同步与索引、持久化存储、交易池、账户与执行账户 |
| 共识与执行 | consensus/ executor/ |
共识接口与交易执行引擎(具体共识算法见 system/consensus/) |
| 网络与通信 | p2p/ rpc/ queue/ client/ |
P2P 网络、grpc/jsonrpc/ethrpc 三套 RPC、进程内消息队列 |
| 应用层 | wallet/ system/ |
钱包与 BIP 助记词、可插拔系统扩展(dapp/address/crypto/store 等接口与注册点) |
| 基础设施 | common/ util/ pluginmgr/ metrics/ |
通用工具库、辅助组件、插件管理器、监控指标 |
| 运行时与命令行 | cmd/ |
二进制入口: chain33 主进程、cli、autotest、execblock 等 |
环境要求: Go 1.21+
编译:
git clone https://github.com/33cn/chain33.git $GOPATH/src/github.com/33cn/chain33
cd $GOPATH/src/github.com/33cn/chain33
make注意: 代码必须放在 $GOPATH/src/github.com/33cn/chain33, 否则 go 包路径会找不到。
国内用户需要配置代理获取依赖包, mod 功能已在 Makefile 中默认开启:
export GOPROXY=https://mirrors.aliyun.com/goproxy
测试:
$ make test通过这个命令可以运行一个单节点到环境, 可以用于开发测试
$ chain33 -f chain33.toml- 不可以使用 master 分支, 要使用 发布分支
我们先说一下代码贡献的细节流程, 这些流程可以不看, 用户可以直接看我们贡献代码简化流程
- 如果有什么想法, 建立 issues, 和我们来讨论。
- 首先点击 右上角的 fork 图标, 把chain33 fork 到自己的分支 比如我的是 vipwzw/chain33
git clone https://github.com/vipwzw/chain33.git $GOPATH/src/github.com/33cn/chain33
注意: 这里要 clone 到 $GOPATH/src/github.com/33cn/chain33, 否则go 包路径会找不到
-
添加
33cn/chain33远端分支:git remote add upstream https://github.com/33cn/chain33.git我已经把这个加入了 Makefile 可以直接 运行make addupstream -
保持
33cn/chain33和vipwzw/chain33master 分支的同步, 可以直接跑make sync, 或者执行下面的命令
git fetch upstream
git checkout master
git merge upstream/master
注意: 不要去修改 master 分支, 这样, master 分支永远和upstream/master 保持同步
- 从最新的33cn/chain33代码建立分支开始开发
git fetch upstream
git checkout master
git merge upstream/master
git checkout -b "fixbug_ci"
- 开发完成后, push 到
vipwzw/chain33
git fetch upstream
git checkout master
git merge upstream/master
git checkout fixbug_ci
git merge master
git push origin fixbug_ci
然后在界面上进行pull request
- 首先点击 右上角的 fork 图标, 把chain33 fork 到自己的分支 比如我的是 vipwzw/chain33
git clone https://github.com/vipwzw/chain33.git $GOPATH/src/github.com/33cn/chain33
注意: 这里要 clone 到 $GOPATH/src/github.com/33cn/chain33, 否则go 包路径会找不到
make addupstream
make branch b=mydevbranchname
make push b=mydevbranchname m="这个提交的信息"
如果m不设置, 那么不会执行 git commit 的命令
比如我要修改 name=libangzhu branch chain33-p2p-listenPort 的pr
make pull name=libangzhu b=chain33-p2p-listenPort
然后修改代码, 修改完成后, 并且在本地commit
make pullpush name=libangzhu b=chain33-p2p-listenPort
BSD 3-Clause License
Copyright (c) 2018, 33.cn
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.