SimWiz.py - Python区块链仿真开发包

simwiz.py是一个用于区块链仿真系统开发的Python包,适合快速实现共识算法的仿真,或者进行大规模区块链网络的实验,例如物联网+区块链系统等。官方下载地址:http://sc.hubwiz.com/codebag/simwiz-python/

1、开发包概述

simwiz.py区块链仿真开发包的主要特点如下:

  • 基于离散事件仿真机制,可以单机模拟包含大量节点的区块链网络
  • 内置仿真网络和区块链数据结构,可快速进行共识算法和区块链网络的仿真实验
  • 简洁的API接口,非常容易上手,便于二次开发

simwiz.py运行在Python 3.x环境下,当前版本1.0.0,主要类及关系如下图所示:

python区块链仿真

simwiz.py的主要代码文件说明如下:

代码文件说明
simwiz/simulation.py仿真入口类
simwiz/event_queue.py仿真事件队列类
simwiz/event.py仿真事件类
simwiz/network.py仿真网络类
simwiz/node.py仿真节点类
simwiz/location.py仿真节点地理位置类
simwiz/blockchain.py仿真区块链类
simwiz/block.py仿真区块类
simwiz/transaction.py仿真交易类
simwiz/blockchain_node.py仿真区块链节点类
simwiz/utils.py辅助工具类
demo.py仿真演示程序

2、使用演示程序

在终端进入simwiz.py开发包目录,执行如下命令运行内置的演示程序:

1
2
~$ cd simwiz.py
~/simwiz.py$ python3 demo.py

演示程序中,4个节点构成的区块链网络会定期输出其内部区块链构成,结果如下:

python区块链仿真

可以看到各节点(0 ~ 3)在每个出块周期(1 ~ 7)都通过共识算法保持了区块链数据的一致。

3、启动仿真区块链

使用Simulation类来创建仿真实例,并调用其run()方法启动仿真。例如,下面的代码创建一个包含4个默认节点的区块链网络的仿真对象,并执行1000毫秒的仿真:

1
2
3
4
5
6
7
8
9
10
11
from simwiz import *                                    # 引入simwiz包  

minters = 4
nodes = [ # 创建4个节点
BlockchainNode(interval=100,minters=minters)
for i in range(minters)
]
net = Network(nodes) # 4个节点组网
sim = Simulation(net) # 创建仿真对象

sim.run(1000) # 仿真1秒钟

4、自定义共识算法的实现

simwiz.py开发包内置的BlockchainNode类采用的共识算法类似于DPoS,即根据时间槽来决定当前的出块节点。可以通过继承BlockchainNode并重写其on_timer方法与on_message方法,实现自定义的共识算法。例如,让每个节点按预设的概率出块:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
from simwiz import *
import random

class PoxNode(BlockchainNode):
def __init__(self,prob,interval,minters):
super.__init__(interval,minters)
self.prob = prob # 当前节点的出块概率

def on_timer(self,sim):
if random.random() < self.prob:
block = self.blockchain.create_next_block() # 出块
msg = pojo({ # 创建区块消息
'type': 'block',
'payload': block
})
sim.broadcast(self,msg) # 广播区块消息

def on_message(self,sim,message):
if message.type == 'block':
self.blockchain.commit_block(message.payload) # 提交收到的区块
if message.type == 'transaction':
self.blockchain.cache_tx(message.payload) # 暂存收到的交易

按概率出块的区块链共识算法都可以采用这个PoxNode模型来仿真,例如PoW(工作量证明)共识算法,每个节点的出块概率是与节点算力相对应的,即:节点出块概率 = 节点算力 / 全网算力

下面的代码利用PoxNode来仿真一个包含100个节点的PoW网络:

1
2
3
4
5
6
7
8
9
miners = 100                                            # 100个挖矿节点
prob = 0.01 # 按均匀分布采样每个节点的出块概率
interval = 100 # 出块周期设置为100毫秒
nodes = [ # 创建节点对象
PoxNode(prob,interval,miners)
for i in range(100)
]
sim = Simulation(Network(nodes)) # 创建仿真对象
sim.run(10000) # 执行10秒的仿真

SimWiz.Py官方下载地址:http://sc.hubwiz.com/codebag/simwiz-python/