Scorex简介

Scorex是用akka实现的开源区块链基础组件，采用模块化设计（共识模块抽象为接口，并可通过配置替换）。
Scorex核心代码只有约4000行，相对于其他区块链项目，它的“纯洁”更容易为区块链开发者掌握和运用。

本文目的

介绍如何下载Scorex相关代码，并在eclipse中以Debug方式运行，Debug方式运行可以让开发者更好地跟踪和学习Scorex的内部运行机制。

相关子项目

Scorex的文档有点乱，某些文档移动了位置但相应的链接没有更新导致链接失效，我根据首页中的链接按图索骥，对运行Scorex的相关项目总结如下：

• scrypto
  底层的加密函数库

• Scorex
  基础框架，包含了3个子模块：

  • Scorex-basic ——账户和钱包、块结构定义、P2P传输、共识接口定义。
  • Scorex-Consensus——共识的Nxt and Quora实现
  • Scorex-Transaction——交易的接口定义和实现

• Permacoin-consensus
  共识的Permacoin实现——Permacoin是微软和马里兰大学2014年提出的用于分布式可信任分片大文件存储的共识协议。

• Lagonaki
  示例应用——通过配置文件，将上述子项目作为库调用的应用示范。

开发环境

操作系统：macOS 10.12.1
JDK：j2se1.8.0_91
Scala: 2.12.1
sbt: 0.13.11
Scala-IDE: 4.5.0

基本步骤

分两步进行：

1. 下载Lagonaki代码，转为eclipse项目。
2. 用源代码项目替换Lagonaki中的对应的库，并在IDE中以debug方式运行。

下载和运行Lagonaki

将Lagonaki代码git clone到本地之后，打开 project/build.properties , 确认你本地的sbt版本与其版本一致：

sbt.version=0.13.11

生成lagonaki的eclipse项目

为了从sbt项目生成eclipse项目，新建一个 project/assembly.sbt ，其内容如下：

addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "5.0.1")

现在可以到Lagonaki的根目录下，运行sbt，但是运行之前请注意，sbt会下载一堆maven依赖库，默认的maven路径下载速度可能非常慢（慢到你失去耐心：），可以用国内的maven库镜像代替之，mac下的方法如下：
打开文件 ~/.sbt/repositories，增加国内maven镜像，并注释主maven库：

[repositories]
  local
  aliyun: http://maven.aliyun.com/nexus/content/groups/public/
#  maven-central
 ...

到Lagonaki的根目录下，首先运行sbt，等待sbt结束后运行eclipse
至此eclipse项目生成。

bash-3.2$ sbt
[info] Loading project definition from /Users/c4w/git/Lagonaki/project
[info] Set current project to lagonaki (in build file:/Users/c4w/git/Lagonaki/)
> eclipse
[info] About to create Eclipse project files for your project(s).
[info] Resolving org.scala-lang#scala-reflect;2.11.8 ...
[info] Successfully created Eclipse project files for project(s):
[info] lagonaki
>

导入lagonaki项目

Paste_Image.png

Paste_Image.png

运行lagonaki

Paste_Image.png

至此完成第一步骤，在IDE下运行示范应用。如果不指定运行参数，默认加载配置文件：settings.json，节点会从Seed Peers接入TestNet。

用源代码代替库文件运行Lagonaki

但我们需要跟踪Scorex的内部处理细节时，需要以Debug方式运行源代码。
首先，用上述将sbt项目导入到IDE的方法，将Scorex项目也导入到IDE。
这里有个坑，由于Scorex项目包含了子项目，需要用eclipse skip-parents=false命令代替eclipse命令，否则只有scorex-basic子项目代码导入。
scorex导入IDE之后，手工增加src路径：

Paste_Image.png

在lagonaki项目的Libraries中找到scorex-basicsxxx.jar，并Remove之。

Paste_Image.png

Paste_Image.png

成果验证

下面我们来验证上述工作达到了预期目标：即debug方式跟踪Scorex内部模块的运行，我们将利用Scorex集成的swagger-akka-http来触发用例。
Lagonaki应用的settings.json配置文件制定了rpc端口

 "rpcPort": 9085,

运行Lagonaki应用，浏览器访问此端口可以看到Swagger UI展示的api文档：

Paste_Image.png

Paste_Image.png

以debug方式运行应用，然后前台点击Try it out!，后台停留在断点位置，目标达成！

Paste_Image.png