宏愿
这篇文章记载的是一件趣事:一个干了十多年的IT老兵,痛下决心想为开源贡献点微薄之力,准备用一年时间达成这个目标,结果第二天就实现了_
2019年初,我萌生了一个想法,当时开源软件中国人参与极少,都是拿来主义。参与开源软件,好处很多
-
加深自己的理解,提升自己的技能
-
就业市场上增加影响力
-
作为一个程序员,给世界留下点东西
步骤
为了实现目标,我制订了一个计划
-
近期目标:首先能修复Ethereumj的bug,就像组*飞兄弟做的那样
-
中期目标:分叉一个自己的,将Ethereumj变为企业版本,就像Quorum那样
-
远期目标:将最新的VRF引入以太坊
当然前提是要能读懂代码,当时因为工作的原因,我正好接触了EthereumJ的代码(Java版本的以太坊,现在由Besu项目接替了),于是去github上找这个项目还没有被fix的issue,正好找到一个,于是修改,并通过了自测和pipeline后提交,没想到项目owner效率很高,第二天就被接纳了。
代码依赖分析
虽然只是改动了一点点,但是那只是冰山一角,首先还是要熟悉这个项目,我先从熟悉项目依赖入手。
-
netty,在点对点通讯中使用到很多;docker化之后,具体测试时,可以开启多个docker镜像,用宿主机不同端口进行通讯
-
spongycastle,加密库,里面有签名,hash和对称加密
-
leveldb和rocksdb,先是前者,后来换成后者,编码结构是怎么样?实际是在
ethereumj.conf
中配置,并在Common.java中初始化 -
solcJ 这个是solidity的编译器,Solidity Compiler win/mac/linux binaries
-
springframework 也用到了java中常用的spring框架,尤其是一些配置,肯定和spring是一样的;其实这里就config包下两个类是配置类
CommonConfig.java
,DefaultConfig.java
-
concurrent-locks 原来我印象中ethereumj很少用到并发,现在可能不一样了,因为引入了这个
-
Snappy compression 是google出品的一个快速的压缩和解压方法,可能在存储或者网络中会用到
善用单元测试
开源项目的质量控制,单元测试尤其重要
-
首先,不依赖一个具体的链的启动
-
所有测试数据在test/resource目录下
-
通过预期可以知道运行结果,并进行比较
启动配置
- resource目录下有最早的Olympic和Frontier的配置,但是最新的拜占庭和君士坦丁堡的HF可以试试,看看有没有什么区别?
不建议下整个以太坊的数据,我们的目的是企业级应用和java版本的Quorum;并且修改其bug
如果是Start.java中已经启动了,传入的参数是--help
,就会打印然后结束
--help -- this help message
-reset <yes/no> -- reset yes/no the all database
-db <db> -- to setup the path for the database directory
-listen <port> -- port to listen on for incoming connections
-connect <enode://pubKey@host:port> -- address actively connect to
-connectOnly <enode://pubKey@host:port> -- like 'connect', but will not attempt to connect to other peers
e.g: cli -reset no -db db-1 -listen 20202 -connect enode://0be5b4@poc-7.ethdev.com:30300
开源贡献指南
1, fork一份logback代码到自己的仓库
进入github要修改项目的主页,点击fork按钮,fork一份代码到自己的仓库
2, clone出fork后的项目
git clone https://github.com/xxxx/logback.git
3,使本地代码与原始项目关联
git remote add upstream https://github.com/qos-ch/logback.git
4,关联后,拉取原始项目代码到本地
git fetch upstream
5,本地进行修改
6, 提交代码到自己fork的github仓库
git commit -a -m ‘修改备注’
git push
7, 进入github上自己fork的项目,创建提交请求到原始代码
我所发挥的issue,虽然是别人提的
我按如上流程创建的PR
提交后CI马上运行进行检查,需要数分钟,光靠人工检查是不行的