Python--web3区块链-智能合约测试

Posted 2023-04-03 ZongXin.Zhou

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Python--web3区块链-智能合约测试相关的知识，希望对你有一定的参考价值。

提示：阅读该文章建议先了解什么是智能合约。

一、智能合约python基础

1、连接环境

# web3对象与已部署的用户合约进行通信
rpc = "HTTP合约通讯地址（http url）" 
web3 = Web3(HTTPProvider(rpc))

2、区块相关

# 当前区块高度
blockNumber = web3.eth.blockNumber
print(blockNumber)

# 获取最新的区块
block = web3.eth.getBlock('latest')
print(block)

# 输出默认区块
print(web3.eth.defaultBlock)

3、账户相关

# 将第一个测试账户设置为默认账户
web3.eth.defaultAccount = web3.eth.accounts[0:1]

# 输出默认账户
print(web3.eth.defaultAccount)

# 获取账号信息
accounts = web3.eth.accounts
print("账户列表：", accounts)

# 获取当前gas的价格
print(web3.eth.gasPrice)

address1 = "你的钱包地址"
# 获取eth余额
balance1 = web3.fromWei(web3.eth.getBalance(address1), "ether")
print(balance1)

二、智能合约ABI简易介绍

ABI官方链接

“合约ABI是以太坊生态系统中与合约交互的标准方式，不论是外部客户端与合约的交互还是合约与合约之间的交互。”上述是以太坊官方文档给出的定义，更通俗的理解，包含两方面内容：
ABI是合约接口的说明。
ABI定义与合约进行交互数据编码规则

在测试合约接口的时候我们会用到

三、测试合约前提

1、熟悉项目业务层逻辑

2、开发提供智能合约接口文档

（1）、确认我们要在那个链上测试，让开发提供对应的测试币
（2）、提供测试地址（类似于web2的url）
（3）、提供最新合约地址（这个地址开发每次部署到链上都会变更）
（4）、提供ABI（合约接口的说明）如果开发不给可以在eth区块链浏览器上获得
（5）、我们自己测试钱包的秘钥

四、智能合约转账（单元脚本）

from web3 import Web3, HTTPProvider
import json, os

rpc = "HTTP合约通讯地址（http url）"
address1 = "个人合约地址"
address2 = "智能合约地址"
test_key = "个人钱包秘钥地址"

# 连接钱包地址
web3 = Web3(HTTPProvider(rpc))

# 结果为true表示连接成功
connect = web3.isConnected()
print(connect)

# 转账
def transfer_eth(amount, gas_price=20, gas_limit=21000):
    # 带签名的合约写操作
    params = 
        # 发送代币地址
        'from': address1,
        # 接收代币的地址
        'to': address2,

        # 代币数量，以wei为单位，可以是字符串和int类型 web3.toWei（数值，代币单位）
        # 为了方便调通代码，我们这里用wei来做单位，正常都是用ether。
        # 1 ether = 1 x 10^18wei = 1 x 10^9 Gwei
        'value': web3.toWei(amount, 'wei'),

        # 每个在链上可以执行的命令都设置了一个消耗的gas值，例：PUSH操作需要消耗3个gas，一次转账一般要消耗21000 gas，gas使用ether来支付
        # 1 ether = 1 x 10^18wei = 1 x 10^9 Gwei， 无论您执行的命令是成功还是失败，都需要支付计算费用
        # 简易理解：gas_limit 是一次交易中gas的可用上限
        'gas': gas_limit,

        # 通过gasPrice可以节省矿工费用，但也会减慢矿工打包的速度。因为，矿工会优先打包gas price设置高的交易，如果您想加快转账，您可以把gas price设置得更高，这样您就可以插队靠前
        # 一次转账一般要消耗21000 gas，如果你设置的gas Price = 1000000000wei = 1Gwei，则此次转账的交易手续费为：TxFee = 21000 Gwei = 0.000021 ether
        # A账户欲向B账户转账4 ether，则要求A账户至少要有 4 + 0.000021 = 4. 000021 ethrer
        # 简易理解：gasPrice就是你想用多少气费进行交易，为什么设置20，是因为当前市场价20就够了。如果你有钱，想更快也可以设置成25甚至更高
        'gasPrice': web3.toWei(gas_price, 'gwei'),

        # 'nonce': web3.eth.getTransactionCount(主钱包地址)，主要标记当前最新的交易号是多少，算是记录在交易队列中的位置
        'nonce': web3.eth.getTransactionCount(address1),
    
    # web3.eth.account.signTransaction用账户对交易签名（转账需要的参数，from钱包地址的秘钥）
    signed_tx = web3.eth.account.signTransaction(params, private_key=test_key)

    # 交易发送并获取交易hash
    tx_hash = web3.eth.sendRawTransaction(signed_tx.rawTransaction)
    return tx_hash


print("运行转账后的交易hash值：", transfer_eth(100))

执行完代码，我们就可以去etherscan上根据钱包地址查看交易数据了

五、获取智能合约接口数据（单元脚本）

（1）、把ABI放到任意目录下

（2）、编写单元测试脚本

from web3 import Web3, HTTPProvider
import json, os

rpc = "HTTP合约通讯地址（http url）"
address = "智能合约地址"

# 连接钱包地址
web3 = Web3(HTTPProvider(rpc))

# 结果为true表示连接成功
connect = web3.isConnected()
print(connect)

# 获取ABI存放地址
filePath = os.path.dirname(__file__) + '/abi.json'

# 这里是读取咱们的abi合约接口规范，方便后面使用
with open(filePath, 'r') as f:
    abi = json.load(f)

# 官方文档：创建一个新的契约实例及其在json接口对象中定义的所有方法和事件
# 官方文档：该web3.eth.Contract对象可以轻松地与以太坊区块链上的智能合约进行交互。
# 个人理解：创建与合约交互的对象，连接完通讯地址后，我们对这地址签订合同，合同里面有合约地址和接口规范（ABI）
# web3.eth.contract(接口文档的合约地址, ABI接口规范)
contract = web3.eth.contract(address=address, abi=abi)

# 通过合约.功能.调用接口方法（传参数）.获取返回值
# contract.functions.接口方法名(参数1,参数2,参数3).call()
res = contract.functions.getLastMintInfo(10).call()
print("getLastMintInfo:", res)

获取结果

六、mint智能合约接口数据（单元脚本）

from web3 import Web3, HTTPProvider
import json, os


rpc = "HTTP合约通讯地址（http url）"
address1 = "个人合约地址"
address2 = "智能合约地址"
test_key = "个人钱包秘钥地址"

# 连接钱包地址
web3 = Web3(HTTPProvider(rpc))

# 结果为true表示连接成功
connect = web3.isConnected()
print(connect)

# 获取ABI存放地址
filePath = os.path.dirname(__file__) + '/abi.json'

# 这里是读取咱们的abi合约接口规范，方便后面使用
with open(filePath, 'r') as f:
    abi = json.load(f)

# 个人理解：创建与合约交互的对象，连接完通讯地址后，我们对这地址签订合同，合同里面有合约地址和接口规范（ABI）
# web3.eth.contract(接口文档的合约地址, ABI接口规范)
contract = web3.eth.contract(address=address2, abi=abi)

# 通过合约功能.调用接口方法（传递mint方法的入参）.创建交易参数(key：value)
transaction = contract.functions.mint(1).buildTransaction(
    'gas': 70000,  # 最大气费上限
    'gasPrice': web3.toWei('20', 'gwei'),  # 气费
    'from': address1,  # 接受地址
    'value': web3.toWei('0.01', 'ether'),  # mint多少eth
    'nonce': web3.eth.getTransactionCount(address1),  # 当前第几个交易
)
# web3.eth.account.signTransaction用账户对交易签名（转账需要的参数，from钱包地址的秘钥）
signed_tx = web3.eth.account.signTransaction(transaction, private_key=test_key)
# 交易发送并获取交易hash
tx_hash = web3.eth.sendRawTransaction(signed_tx.rawTransaction)
print(tx_hash)

Solidity智能合约单元测试介绍

当前在各种区块链中，生态最全的要属兼容EVM的区块链，在该类区块链上的智能合约绝大部分使用Solidity编写。因此，对Solidity编写的智能合约进行单元测试便成为一项经常性的工作。本文简要的介绍一下怎样使用hardhat进行Solidity智能合约单元测试。

一、什么是Hardhat

我们来看其官方文档的描述:

Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software.

意思为 Hardhat是一个编译，部署，测试和调试以太坊程序的开发环境，在这里本文只涉及到其测试功能。

在Hardhat之前，我们使用truffle做为开发、部署和测试环境。作为后来者，Hardhat的功能更强大，因此现在我们一般使用Hardhat来作为智能合约开发和测试工具。

官方文档介绍了两种测试方式：ethers.js + Waffle和Web3.js + Truffle。在这里我们使用ethers.js + Waffle模式。

二、测试内容

我们进行单元测试，经常性的测试内容有：

状态检查，例如合约部署后检查初始状态是否正确，函数调用后检查状态是否改变。一般状态检查为读取view函数。
事件触发。基本上，合约中的关键操作都应该触发事件进行相应追踪。在单元测试中了可以测试事件是否触发，抛出的参数是否正确。
交易重置。在测试一些非预期条件时，交易应当重置并给出相应的原因。使用单元测试可以检测是否重置及错误原因是否相同。
函数计算。例如要计算不同条件下某函数的返回值（例如奖励值），我们需要循环调用某个函数并输入不同的参数，看是否结果相符。
完全功能测试。例如我们合约中涉及到了区块高度或者区块时间，比如质押一年后才能提取。此时我们一般需要加速区块时间或者区块高度来进行测试。幸运的是，hardhat提供了接口可以方便的进行此项测试。
测试覆盖率。包含代码覆盖率，函数覆盖率和分支覆盖率。一般情况下，应该追求 100%完全覆盖。比如你写了一个modifier，但是忘记加到函数上去了，而单元测试也漏掉了，此时代码覆盖就会显示该代码未测试，这样可以发现一些简单的BUG。特殊情况下或者确定有代码不会执行的情况下，不追求100%覆盖率。

接下来我们来详细介绍每项内容的测试方法。

三、示例合约

我们按照官方介绍新建一个示例工程Greeting。在工作目录下运行下列命令：

mkdir Greeting
cd Greeting
npm install --save-dev hardhat
npx hardhat

此时选择第二项，创建一个高级示例项目（当然也可以选第3项使用typescrit）,等待依赖库安装完毕。

运行code .使用vocode打开当前目录。

我们可以看到项目的contracts目录下已经生成了一个示例合约Greeter.sol，内容如下：

//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.0;

import "hardhat/console.sol";

contract Greeter 
    string private greeting;

    constructor(string memory _greeting) 
        console.log("Deploying a Greeter with greeting:", _greeting);
        greeting = _greeting;
    

    function greet() public view returns (string memory) 
        return greeting;
    

    function setGreeting(string memory _greeting) public 
        console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
        greeting = _greeting;

代码比较简单，需要注意的是它使用了一个hardhat/console.sol插件，该插件可以在hardhat netwrok环境中打印出相应的值，方便开发时调试。可以看到，它支持占位符模式。

进一步查看其文档，它实现了类似Node.js的console.log格式，其底层调用是util.format。这里我们看到它只使用了%s这一种占位符。

四、示例测试

打开项目根目录下的test目录，我们可以看到有一个sample-test.js的文件，其内容如下:

const  expect  = require("chai");
const  ethers  = require("hardhat");

describe("Greeter", function () 
  it("Should return the new greeting once it's changed", async function () 
    const Greeter = await ethers.getContractFactory("Greeter");
    const greeter = await Greeter.deploy("Hello, world!");
    await greeter.deployed();

    expect(await greeter.greet()).to.equal("Hello, world!");

    const setGreetingTx = await greeter.setGreeting("Hola, mundo!");

    // wait until the transaction is mined
    await setGreetingTx.wait();

    expect(await greeter.greet()).to.equal("Hola, mundo!");
  );
);

这里的测试也比较简单，一般使用describe来代表测试某个项目或者功能，使用it来代表具体某项测试。注意，describe和it是函数，在javascript中，一切都是函数。因此，我们可以在describe中再次嵌套describe，这样最外层的describe代表整个项目，内部的describe代表某项目功能。

在该测试文件中，先进行了合约的部署，然后验证合约的状态变量greeting是否为部署时提供的Hello, world!。然后运行setGreeting函数改变问候语为Hola, mundo!，并再次验证更改后的greeting。

五、运行测试

我们运行npx hardhat test ./test/sample-test.js，结果如下：

Compiled 2 Solidity files successfully


  Greeter
Deploying a Greeter with greeting: Hello, world!
Changing greeting from 'Hello, world!' to 'Hola, mundo!'
    ✔ Should return the new greeting once it's changed (946ms)


  1 passing (949ms)

这里可以看到，我们打印出来了两个日志，刚好是我们合约中的console.log语句。

六、测试console

这里，console.log支持的数据类型有限，它仅支持4种数据类型：

uint
string
bool
address

但是它又提供了额外的API来支持其它类型，如console.logBytes(bytes memory b)等。详情见https://hardhat.org/hardhat-network/reference/#console-log 。

我们来简单测试一下，在Greeter.sol中添加如下函数：

function testConsole() public view returns(bool) 
    console.log("Caller is '%s'", msg.sender);
    console.log("Caller is '%d'", msg.sender);
    console.log("Caller is ", msg.sender);
    console.log("Number is '%s'", 0xff);
    console.log("Number is '%d'", 0xff);
    console.logBytes1(bytes1(0xff));
    console.logBytes(abi.encode(msg.sender));
    console.log("Reslut is ", true);
    return true;

在sample-test.js中添加一行代码expect(await greeter.testConsole()).to.be.equal(true);，再次运行npx hardhat test ./test/sample-test.js，结果如下：

Compiled 1 Solidity file successfully


  Greeter
Deploying a Greeter with greeting: Hello, world!
Changing greeting from 'Hello, world!' to 'Hola, mundo!'
Caller is '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
Caller is '1.3908492957860717e+48'
Caller is  0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
Number is '255'
Number is '255'
0xff
0x000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266
Reslut is  true
    ✔ Should return the new greeting once it's changed (707ms)


  1 passing (709ms)

可以看到，当我们把地址类型当成整数打印时，它打印了对应的整数值。通常情况下，对于console.log支持的四种类型，我们可以不使用通配符或者全部使用%s作为字符串输出,特殊类型的数据使用相应的API进行打印。

七、事件测试

我们知道，合约中重要的操作基本上都会触发事件，因此，捕获抛出的事件并检查事件中的参数也是一项经常性的工作。在合约中添加如下代码。

function eventTest() public 
    emit CallerEmit(msg.sender, 500);

我们这次修改我们的测试文件，将各功能均写一个describe来进行，代码如下:

const  expect, util, assert  = require("chai");
const  ethers  = require("hardhat");

describe("Greeter", function () 
  let greeter;
  let owner, user1, users;

  beforeEach(async () => 
    [owner, user1, ...users] = await ethers.getSigners();
    const Greeter = await ethers.getContractFactory("Greeter");
    greeter = await Greeter.deploy("Hello, world!");
    await greeter.deployed();
  );
  describe("State check test", function () 
    it("Should return the new greeting once it's changed", async function () 
      expect(await greeter.greet()).to.equal("Hello, world!");

      const setGreetingTx = await greeter.setGreeting("Hola, mundo!");

      // wait until the transaction is mined
      await setGreetingTx.wait();
      expect(await greeter.greet()).to.equal("Hola, mundo!");
    );
  );

  describe("Console test", function () 
    it("Console.log should be successful", async function () 
      expect(await greeter.testConsole()).to.be.equal(true);
    );
  );

  describe("Event test", function () 
    it("owner emit test", async () => 
      await expect(greeter.eventTest())
        .to.be.emit(greeter, "CallerEmit")
        .withArgs(owner.address, 500);
    );
    it("user1 emit test", async () => 
      await expect(greeter.connect(user1).eventTest())
        .to.be.emit(greeter, "CallerEmit")
        .withArgs(user1.address, 500);
    );
    it("Get emit params test", async () => 
      const tx = await greeter.connect(users[0]).eventTest();
      await tx.wait();
      const receipt = await ethers.provider.getTransactionReceipt(tx.hash);
      const hash = ethers.utils.solidityKeccak256(
        ["string"],
        ["CallerEmit(address,uint256)"]
      );
      const infos = receipt.logs[0];
      assert.equal(infos.topics[0], hash);
      const sender = ethers.utils.getAddress(
        "0x" + infos.topics[1].substring(26)
      );
      assert.equal(sender, users[0].address);
      const value = ethers.BigNumber.from(infos.data);
      expect(value).to.be.equal(500);
    );
  );
);

可以看到，我们测试事件时进行了三项测试，分别为：

正常测试，主要是检查事件是否触发，参数是否正确。
同上，主要是切换合约调用者为user1。
这里是解析事件来获取事件参数，此场景应用于某些事件参数无法提前获取等，比如一个伪随机数。

八、重置测试

我们来测试条件不满足时的交易重置，在合约中添加如下代码：

function revertTest(uint a, uint b) public 
    require(a > 10, "a <= 10");
    if(b > 10) 
        revert("b > 10 ");
    else 
        revert();

注意：这里会有编译警告，提示我们最后一个revert缺少提示字符串，我们是故意这样的，请忽略它。

在测试文件中添加如下describe：

describe("Revert test", function () 
    it("a < 10 should be failed", async () => 
      await expect(greeter.revertTest(5, 5)).to.be.revertedWith("a <= 10");
    );
    it("b > 10 should be failed", async () => 
      await expect(greeter.revertTest(15, 55)).to.be.revertedWith("b > 10");
    );
    it("b < 10 should be failed", async () => 
      await expect(greeter.revertTest(15, 5)).to.be.reverted;
    );
);

然后我们运行测试通过。

九、区块测试

当我们合约中的内容涉及到区块时，一般需要进行相应区块高度或者区块时间的条件测试。先在测试合约中添加如下内容：

function blockNumberTest() public 
    require(block.number >= 10000,"not matched block number");
    console.log("block number: %d", block.number);


function blockTimeTest() public 
    require(block.timestamp >= 1750631915,"not matched block time");
    console.log("block timestamp: %d", block.timestamp);

编译时会提示上面两个函数为view函数，但是如果我们把它标记为view函数，那么测试时便不会mine一个新区块。为了模拟真实场景，我们不把它标记为view函数，从而在调用时产生一个新的区块。

然后在测试文件中增加如下describe：

describe("Block test", () => 
    let block;
    let timestamp;
    
    // 用来去除16进制的左边自动补零
    function convertNum(num) 
        let big = ethers.BigNumber.from("" + num)
        let str = big.toHexString()
        let index = 0
        for(let i=2;i<str.length;i++) 
            if(str[i] !== "0") 
                index = i;
                break;
            
        
        if(index === 0) 
            return str;
        else 
            return str.substring(0,2) + str.substring(index)
        
    
    
    beforeEach(async () => 
      block = await ethers.provider.getBlockNumber();
      timestamp = (await ethers.provider.getBlock(block)).timestamp;
    );
    // 注意，这里hardhat network 默认是一秒一个区块
  	it("Call before timestamp 1651631915 should be failed", async () => 
      assert.ok(timestamp < 1651631915);
      await expect(greeter.blockTimeTest()).to.be.revertedWith(
        "not matched block time"
      );
    );

    it("Call at timestamp 1651631915 should be successfult", async () => 
      await ethers.provider.send("evm_mine", [1651631915 - 1]);
      await greeter.blockTimeTest();
    );
    it("Call before block 10000 should  be failed", async () => 
      assert.ok(block < 10000);
      await expect(greeter.blockNumberTest()).to.be.revertedWith(
        "not matched block number"
      );
    );

    it("Call at block 10000 should be successful", async () => 
      let value = 10000 - block - 1;
      //快速推进到100000区块前一个
      await ethers.provider.send("hardhat_mine", [convertNum(value]);
      await greeter.blockNumberTest();
    );
);

注意，在上面的子describe中又使用了beforeEach函数。这里讲一下beforeEach和before的区别，beforeEach 顾名思义，在每项it测试前都会执行一次；而before，在一个describe中只会执行一次。

这里it函数要使用的describe函数内的变量都放在describe中定义，通常我们测试时会使用一个全新的状态，所以一般使用beforeEach而不是before。但特殊场景会有时会使用before，比如后面的测试依赖于前面的测试结果的。

执行测试后输出的结果显示，我们确定是在block == 10000和timestamp == 5555555555调用了相应的函数。

这里，我们采用的是hardhat自动出块策略。此时，每笔交易不管成功还是失败，都会出一个块，并且每个区块内就只有一个交易。但是如果我们想一个区块内包含多个交易怎么办？hardhat也提供了相应的rpc接口，例如evm_setAutomine和evm_setIntervalMining来模拟真实的出块场景。

我们在测试合约中增加如下代码：

uint public curBlock;
uint public counter;
modifier oneBlock() 
    if(curBlock != 0) 
        require(block.number == curBlock,"not in one block");
    
    _;
    if(curBlock == 0) 
        curBlock = block.number;
    


function addCounter() external oneBlock 
    counter ++;

这里增加了一个函数addCounter用来在一个区块内改变记数器。如果不在一个区块内，则会revert。

相应的测试文件增加如下代码，在Block test里增加：

it("addCounter test", async () => 
    expect(await greeter.counter()).to.be.equal(0);
    expect(await greeter.curBlock())以上是关于Python--web3区块链-智能合约测试的主要内容，如果未能解决你的问题，请参考以下文章 
 Solidity智能合约单元测试介绍
 Solidity智能合约单元测试介绍
 区块链本地部署智能合约环境
 java调用区块链智能合约
 区块链-智能合约工程师第一篇：某科技jd解读
 区块链-智能合约工程师第一篇：某科技jd解读