如何构建无服务器智能合约自动化项目

智能合约”这个名字其实并不确切。尽管名字中有“智能”二字,但 Ethereum 上的智能合约并不能全自动执行。智能合约代码的运行需要借助外力的触发。换句话说,我们需要通过一些外部流程来触发智能合约

如何构建无服务器智能合约自动化项目

在本文中,我们将通过构建可行的解决方案来解决该问题,了解一下:

· 为什么需要链下智能合约自动化
· 智能合约自动化的用例
· 如何借助无服务器架构来部署无服务器功能

最后,我们还将介绍 serverless-ethers——全功能的智能合约自动化服务,部署后可直接使用。我们可以以此服务为基础,构建符合自己需求的自定义智能合约自动化项目

1. 问题是:名叫智能合约,却无法自动执行

假设我们想要实现一个能够每小时自动执行一次的智能合约。要怎么做呢?

现实就是:根本做不到。仅靠 Solidity 智能合约是做不到这一点的。尽管名叫“智能合约”,但 Ethereum 中的智能合约并不能自动执行,我们需要借助外部源(人或机器)来调用智能合约并执行其代码。

合约最多能做到的是:在不同任务间插入一小时间隔,例如:

function runMe() public {
require(block.timestamp >= lastTriggeredAt + 1 hour);

}

以上“require()”语句可确保两次执行至少间隔一小时。但是,仍需要在开始时人为触发智能合约,然后代码才会正常运行。

2. 来谈一谈“自动e执行”

从技术层面上来看,有一些操作是可以使用函数修改器来自动执行的。比如说Compound Governance的COMP分配。一旦地址获得了0.001COMP,之后所有的Compound交易(例如提供资产,或转移cToken)都会自动将COMP转到其钱包中。

我们可以在函数修改器中实现上述逻辑,将修改器放在函数前,并在调用函数时自动执行逻辑。由调用方来支付相关的附加费用。
然而,并不是所有的智能合约系统都可以采用这种方法。由于这些修改器只能在特定条件下运行,因此可能会导致意料之外的gas费用。同时,还可能会向用户随机收取额外的gas费用,以实现合约“平衡性”。

并且,代码的运行仍然需要通过人为调用智能合约才能实现。

3. 智能合约自动化的常见用例

DeFi协议依赖于某种链下智能合约自动化。MakerDAO依赖第三方来监控债务头寸的抵押担保比率,并清算担保不足的头寸。其他的DeFi协议也都有类似的需求。

在链下智能合约自动化方面,有两个常见用例:

· 自动触发器(Automated Triggers):在特定情况下执行合约。
· 状态和事件监控(State and Event Monitoring):了解合约在何时出现特定状态。

1. 自动触发器

我们经常需要定期、或在特定条件下执行合约,例如:

· 周期性地恢复平衡池
· 结束DAO/治理过程中的投票
· 按比例支付安全代币股息

2. 状态和事件监控

有时我们需要了解合约是否满足了某些条件,例如:

· 了解智能合约的价值是否发生了变化
· 获取所有准入限制更改的通知
· 了解何时发出特定的智能合约事件

4. 解决方案:无服务器函数?

实际上,无服务器功能刚好适用于上面提到的这几个用例。有了无服务器化,我们便无需在部署代码之前预配任何东西,并且之后也不需要费心管理,极大地简化了问题的解决方案。

5. 快速入门:借助Serverless Framework来实现无服务器化

无服务器架构(Serverless Framework)为我们提供了开发、部署、监控和保护无服务器应用程序所需的一切内容。让我们一起来看看如何能够以最简单的方式完成开发吧。

> npm install -g serverless
> serverless -v
x.x.x

首先,我们来快速了解一下Serverless Framework的运作方式。

0. serverless.yml

所有Serverless服务中的Lambda函数和事件都可以在名为serverless.yml的配置文件中找到。该文件对服务(包含Functions和Events)进行了定义。

service: serverless-ethers
provider:
name: aws
runtime: nodejs12.x
environment:
CHAIN_ID: 3
DEFAULT_GAS_PRICE: 60000000000

functions:
myFunc:
handler: functions/myFunc.handler
events:
– schedule: rate(2 hours)

我们可以在function属性下,对无服务器函数进行定义。在上面的例子中:

· 我们有名为myFunc的Function
· handler属性指向包含你想在函数中运行的代码的文件和模块
· events属性为要执行的函数指定Event触发器

一个服务中可以包含多个函数。

1.     Functions

Function是AWS Lambda函数,是一个类似于微服务的独立部署单元。作为一段部署在云中的代码,通常被用于执行单个作业。
// functions/myFunc.js
exports.handler = async function(event, context) {
// Do anything
};

Functions只是普通的JS函数,可以将事件对象作为有效负载。

2. Events

Events是触发函数运行的事件,隶属于每个Function,可以在serverless.yml中的事件属性中找到。
我们可以使用Scheduled Events触发器来定期自动执行函数。例如,我们指定每2小时运行一次myFunc函数:

# serverless.yml

functions:
myFunc:
handler: functions/myFunc.handler
events:
– schedule: rate(2 hours)

我们还可以借助cron schedule expression来指定安排计划

# serverless.yml

events:
– schedule: cron(0 12 * * ? *) # 12PM UTC

如果你使用的是AWS的话,事件即为AWS中可以出发AWS Lambda函数的任意事件,比如:

· AWS API Gateway HTTP端点请求(例如,REST API)
· AWS S3存储桶上传(例如,图像)
· CloudWatch计时器(例如,每5分钟运行一次)
· AWS SNS主题(例如,信息)
· 等等……

就目前而言,知道这些就够了。如果还想了解更多关于Serverless framework的内容的话,可以看一下这个文件(https://www.serverless.com/framework/docs/?ref=hackernoon.com)

在了解了Serverless Framework的基础知识后,我们来看一看serverless-ethers服务吧。

6. serverless-ethers是什么

serverless-ethers是一个全功能Serverless服务,部署后即可直接使用。
git clone git@github.com:yosriady/serverless-ethers.git
cd serverless-ethers
nvm use
npm install

我们可以将此项目作为构建自定义智能合约自动化的基础。其预先配置的是AWS,但修改后也适用于其他云提供商(如GCP、Azure等)。
serverless-ethers项目的结构如下:

├── contracts/
│   ├── abis/
│   ├── abis.js
│   └── addresses.js
├── functions/
│   └── exec.js
└── serverless.yml

· contracts/包含智能合约ABI和地址。
· functions/包含实现业务逻辑的JS函数。
· serverless.yml描述服务配置。

接下来,我们将深入了解一下各个部分。

7. 合约样本示例

为了进行测试,我编写并部署了一个智能合约示例:

// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.6.10;

contract DummyStorage {
event Write(address indexed source, uint256 value);

uint internal _currentValue;

function get() public view returns (uint) {
return _currentValue;
}

function put(uint value) public {
emit Write(msg.sender, value);
_currentValue = value;

该DummyStorage智能合约具有以下功能:

get是一个能反馈合约当前值的只读函数。
put是一个用于更新合约当前值的写入函数。

该示例合约已经过验证并在Ropsten上运行。大家可以用它来测试自己的函数!

1. 智能合约ABIs

合约目录中包含与函数交互的合约ABIs。在示例项目中,它包含DummyStorage合约的ABI。

├── contracts/
│   ├── abis/
│   │     └── DummyStorage.json
│   ├── abis.js
│   └── addresses.js

我们可以将ABI看作是智能合约的公共API规范,类似于OpenAPI规范。我们需要用ABI来调用合约函数。
合约/目录结构能协助我们导入合约ABI和地址:

// functions/exec.js

const { abis, addresses } = require(‘../contracts’);

const DummyStorageABI = abis.DummyStorage;
const DummyStorageAddress = addresses.DummyStorage

这都是我们在接下来的函数部分中将要用到的。

2. Functions

exec函数利用Ethers来加载合约ABI并调用智能合约:

// Initialize contract
const contract = new ethers.Contract(
DummyStorageAddress,
DummyStorageABI,
wallet,
)

// Call smart contract function `put(uint)`
const RANDOM_INTEGER = Math.floor(Math.random() * 100); // returns a random integer from 0 to 99
const tx = await contract.put(RANDOM_INTEGER)

加载合约ABI和地址后,我们将得到一个具备智能合约所有函数的ethers.Contract抽象,包括get()和put().

在示例exec函数中,我们用一个随机整数来调用contract.put()。

3. serverless.yml

在运行exec函数之前,我们需要在serverless.yml中指定几个环境变量:

# serverless.yml

service: serverless-ethers
provider:
name: aws
runtime: nodejs12.x
region: ap-southeast-1
timeout: 30
environment:
DEFAULT_GAS_PRICE: 60000000000
MNEMONIC: …
SLACK_HOOK_URL: …

serverless-ethers使用了以下环境变量:

· DEFAULT_GAS_PRICE:事务写入时使用的默认gas价格。
· MNEMONIC:用于导出Ethereum地址的12个助记词。如果打算将数据写入Ethereum的话,要确保确保其由Ether进行支付。
· SLACK_HOOK_URL:示例中使用Incoming Webhooks向Slack发送消息。你可以从自己的Slack仪表板上获取此URL。(可选项)

你可以从AWS Lambda控制台更改已部署函数的环境变量。

注意:切记不要在构建过程中用明文存储密钥。在存储助记词和API密钥等凭证时,要使用安全的参数存储,如AWS Secrets Manager。因为每个项目的安全需求和设置不同,所以请根据自身实际情况来决定密码存储方式。

8. 本地运行

我们可以使用无服务器CLI命令在本地运行函数。

> serverless invoke local -f exec
Starting…
Contract ABIs loaded
Ethers wallet loaded
Contract loaded
Sending transaction…
:white_check_mark: Transaction sent https://ropsten.etherscan.io/tx/0x72204f07911a319b4e5f7eb54ad15ed666cfc1403b53def40c9d60188b176383
Completed
True

9. 部署到AWS

运行serverless deploy即可轻松实现部署:

> serverless deploy
Serverless: Packaging service…
Serverless: Excluding development dependencies…
Serverless: Creating Stack…
Serverless: Checking Stack create progress…
……..
Serverless: Stack create finished…
Serverless: Uploading CloudFormation file to S3…
Serverless: Uploading artifacts…
Serverless: Uploading service serverless-ethers.zip file to S3 (2.95 MB)…
Serverless: Validating template…
Serverless: Updating Stack…
Serverless: Checking Stack update progress…
…………………
Serverless: Stack update finished…
Service Information
service: serverless-ethers
stage: dev
region: ap-southeast-1
stack: serverless-ethers-dev
resources: 8
api keys:
None
endpoints:
None
functions:
exec: serverless-ethers-dev-exec
layers:
None

现在,一个无服务器函数就完成了,我们可以用它来对智能合约进行自动化和监控,并且可以在这个示例项目的基础上构建属于自己的智能合约自动化。

10. 写在最后

祝贺你学会了以下内容:

· 为什么需要链下智能合约自动化
· 智能合约自动化的用例
· Serverless架构
· serverless-ethers示例应用程序的运行原理

11. 补充:用Slack 实现ChatOps

除了serverless-ethers,我们还可以通过postToSlack函数来集成Slack。

const successMessage = `:white_check_mark: Transaction sent https://ropsten.etherscan.io/tx/${tx.hash}`;
await postToSlack(successMessage);

postToSlack函数利用了你从Slack console获取的SLACK_HOOK_URL环境变量。设置完成后,只要交易成功发送,就会马上通知Slack,轻轻松松监控函数。

12. 补充:监控智能合约事件

截至目前,我们只介绍了“自动触发”用例,那要怎样监控智能合约状态和事件呢?

我们可以使用Ethers v5 Events API来定期监控特定事件。可以在函数中执行以下操作:

// Given the following Event:
// event Transfer(bytes32 indexed node, address owner)

// Get the filter (the second null could be omitted)
const filter = contract.filters.Transfer(userAccount, null);

// Query the filter
const logs = contract.queryFilter(filter, 0, “latest”); // from block 0 to latest block

// Print out all the values:
logs.forEach((log) => {
console.log(log.args._to, log.args._value);
}

假设我们希望让这个函数周期性执行(例如每5分钟一次),还需要存储一个标记,对该函数自上次执行后所看到的最后一个块进行跟踪。

该智能合约在监控Access Control白名单时非常有用。有了事件监控功能,可以在白名单中添加新地址时通知Slack。

该内容来自于互联网公开内容,非区块链原创内容,如若转载,请注明出处:https://htzkw.com/archives/24832

联系我们

aliyinhang@gmail.com