用于 Web3 应用程序的服务器组件和代理

代理

服务器

链下

初学者

Ori Pomerantz

2024年7月15日

13 分钟阅读

简介

在大多数情况下，去中心化应用程序使用服务器分发软件，但所有实际交互都发生在客户端（通常是 Web 浏览器）和区块链之间。

但是，在某些情况下，应用程序可以从独立运行的服务器组件中受益。这样的服务器将能够通过发布交易来响应事件以及来自其他来源（例如 API）的请求。

这样的服务器可以完成几个可能的任务。

秘密状态的持有者。在游戏中，不将游戏知道的所有信息都提供给玩家通常很有用。然而，区块链上没有秘密，区块链中的任何信息都很容易被任何人发现。因此，如果游戏状态的一部分需要保密，就必须将其存储在其他地方（并且可能使用零知识证明来验证该状态的影响）。
中心化预言机。如果赌注足够低，一个外部服务器，读取一些在线信息然后发布到链上，可能足以用作预言机。
代理。没有交易来激活，区块链上什么也不会发生。服务器可以代表用户在机会出现时执行套利等操作。

示例程序

您可以在 githubopens in a new tab 上查看示例服务器。此服务器侦听来自此合约opens in a new tab的事件，这是 Hardhat Greeter 的修改版本。当问候语被更改时，它会将其改回。

要运行它：

克隆存储库。

1git clone https://github.com/qbzzt/20240715-server-component.git
2cd 20240715-server-component

安装必要的软件包。如果您还没有安装，请先安装 Nodeopens in a new tab。
```
1npm install
```
编辑 .env 以指定在 Holesky 测试网上拥有 ETH 的帐户的私钥。如果你在 Holesky 上没有 ETH，你可以使用这个水龙头opens in a new tab。
```
1PRIVATE_KEY=0x <此处填写私钥>
```
启动服务器。
```
1npm start
```
转到区块浏览器opens in a new tab，并使用与拥有私钥的地址不同的地址来修改问候语。可以看到问候语已自动修改回来。

工作原理

理解如何编写服务器组件的最简单方法是逐行查看示例。

`src/app.ts`

程序绝大部分内容都包含在 src/app.tsopens in a new tab 中。

创建先决条件对象

1import {
2  createPublicClient,
3  createWalletClient,
4  getContract,
5  http,
6  Address,
7} from "viem"

这些是我们需要的 Viemopens in a new tab 实体、函数和 Address 类型opens in a new tab。该服务器是用 TypeScriptopens in a new tab 编写的，它是 JavaScript 的一个扩展，使其成为强类型opens in a new tab。

1import { privateKeyToAccount } from "viem/accounts"

此函数opens in a new tab可让我们生成与私钥对应的钱包信息，包括地址。

1import { holesky } from "viem/chains"

要在 Viem 中使用区块链，您需要导入其定义。在这种情况下，我们希望连接到 Holeskyopens in a new tab 测试区块链。

1// 这就是我们将 .env 中的定义添加到 process.env 的方式。
2import * as dotenv from "dotenv"
3dotenv.config()

这就是我们将 .env 读入环境的方式。我们稍后会需要它来获取私钥。

1const greeterAddress : Address = "0xB8f6460Dc30c44401Be26B0d6eD250873d8a50A6"
2const greeterABI = [
3    {
4        "inputs": [
5            {
6                "internalType": "string",
7                "name": "_greeting",
8                "type": "string"
9            }
10        ],
11        "stateMutability": "nonpayable",
12        "type": "constructor"
13    },
14         .
15         .
16         .
17    {
18        "inputs": [
19            {
20                "internalType": "string",
21                "name": "_greeting",
22                "type": "string"
23            }
24        ],
25        "name": "setGreeting",
26        "outputs": [],
27        "stateMutability": "nonpayable",
28        "type": "function"
29    }
30] as const
显示全部

要使用合约，我们需要它的地址和。我们在这里两者都提供。

在 JavaScript（以及因此 TypeScript）中，您不能为常量分配新值，但您_可以_修改存储在其中的对象。通过使用后缀 as const，我们告诉 TypeScript 列表本身是常量，不可更改。

1const publicClient = createPublicClient({
2  chain: holesky,
3  transport: http(),
4})

创建一个 Viem 公共客户端opens in a new tab。公共客户端没有附加私钥，因此无法发送交易。它们可以调用视图 函数opens in a new tab、读取账户余额等。

1const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)

环境变量可在 process.envopens in a new tab 中使用。但是，TypeScript 是强类型的。环境变量可以是任何字符串或为空，因此环境变量的类型是 string | undefined。然而，在 Viem 中，密钥被定义为 0x${string}（0x 后跟一个字符串）。在这里，我们告诉 TypeScript PRIVATE_KEY 环境变量将是该类型。如果不是，我们会得到一个运行时错误。

然后 privateKeyToAccountopens in a new tab 函数使用此私钥创建一个完整的帐户对象。

1const walletClient = createWalletClient({
2  account,
3  chain: holesky,
4  transport: http(),
5})

接下来，我们使用帐户对象创建一个钱包客户端opens in a new tab。此客户端有私钥和地址，因此可用于发送交易。

1const greeter = getContract({
2  address: greeterAddress,
3  abi: greeterABI,
4  client: { public: publicClient, wallet: walletClient },
5})

现在我们具备了所有先决条件，我们终于可以创建一个合约实例opens in a new tab。我们将使用这个合约实例与链上合约进行通信。

从区块链读取数据

1console.log(`Current greeting:`, await greeter.read.greet())

只读的合约函数（viewopens in a new tab 和 pureopens in a new tab）在 read 下可用。在这种情况下，我们使用它来访问 greetopens in a new tab 函数，该函数返回问候语。

JavaScript 是单线程的，所以当我们启动一个长时间运行的进程时，我们需要指定我们异步执行它opens in a new tab。调用区块链，即使是只读操作，也需要在计算机和区块链节点之间进行一次往返。这就是我们在这里指定代码需要 await 结果的原因。

如果您对这项工作的工作原理感兴趣，可以在此处阅读相关内容opens in a new tab，但实际上您只需要知道，如果您开始一个需要很长时间的操作，您就需要await结果，并且任何执行此操作的函数都必须声明为 async。

发出交易

1const setGreeting = async (greeting: string): Promise<any> => {

这是您调用以发出更改问候语的交易的函数。由于这是一个长时间的操作，该函数被声明为 async。由于内部实现，任何 async 函数都需要返回一个 Promise 对象。在这种情况下，Promise<any> 意味着我们没有指定 Promise 中究竟会返回什么。

1const txHash = await greeter.write.setGreeting([greeting])

合约实例的 write 字段包含所有写入区块链状态的函数（那些需要发送交易的函数），例如 setGreetingopens in a new tab。参数（如果有）以列表形式提供，函数返回交易的哈希。

1    console.log(`正在修复，请参阅 https://eth-holesky.blockscout.com/tx/${txHash}`)
2
3    return txHash
4}

报告交易的哈希（作为区块浏览器 URL 的一部分以查看它）并返回它。

响应事件

1greeter.watchEvent.SetGreeting({

watchEvent 函数opens in a new tab允许您指定在发出事件时要运行的函数。如果您只关心一种类型的事件（在本例中为 SetGreeting），您可以使用此语法将自己限制在该事件类型。

1    onLogs: logs => {

当有日志条目时，onLogs 函数被调用。在以太坊中，“log”和“event”通常可以互换。

1console.log(
2  `地址 ${logs[0].args.sender} 将问候语更改为 ${logs[0].args.greeting}`
3)

可能会有多个事件，但为简单起见，我们只关心第一个。 logs[0].args 是事件的参数，在本例中是 sender 和 greeting。

1        if (logs[0].args.sender != account.address)
2            setGreeting(`${account.address} 坚持要说“你好！”`)
3    }
4})

如果发送方_不是_此服务器，请使用 setGreeting 更改问候语。

`package.json`

此文件opens in a new tab控制 Node.jsopens in a new tab 配置。本文仅解释重要的定义。

1{
2  "main": "dist/index.js",

此定义指定要运行的 JavaScript 文件。

1  "scripts": {
2    "start": "tsc && node dist/app.js",
3  },

脚本是各种应用程序操作。在这种情况下，我们只有一个 start，它会编译然后运行服务器。 tsc 命令是 typescript 包的一部分，可将 TypeScript 编译为 JavaScript。如果要手动运行它，它位于 node_modules/.bin 中。第二个命令运行服务器。

1  "type": "module",

JavaScript Node 应用程序有多种类型。 module 类型允许我们在顶层代码中使用 await，这在您执行缓慢的（因此是异步的）操作时很重要。

1  "devDependencies": {
2    "@types/node": "^20.14.2",
3    "typescript": "^5.4.5"
4  },

这些是仅在开发时需要的包。这里我们需要 typescript，并且因为我们将其与 Node.js 一起使用，我们还获得了节点变量和对象的类型，例如 process。 ^<version> 符号opens in a new tab 表示该版本或更高版本，但没有重大更改。有关版本号含义的更多信息，请参阅此处opens in a new tab。

1  "dependencies": {
2    "dotenv": "^16.4.5",
3    "viem": "2.14.1"
4  }
5}

这些是在运行时运行 dist/app.js 时所需的包。

结论

我们在这里创建的中心化服务器完成了它的工作，即充当用户的代理。任何希望 dapp 继续运行并愿意花费燃料的人都可以使用自己的地址运行服务器的新实例。

但是，这仅在中心化服务器的操作可以轻松验证时才有效。如果中心化服务器有任何秘密状态信息，或者运行复杂的计算，那么它就是一个中心化实体，你需要信任它才能使用该应用程序，而这正是区块链试图避免的。在未来的文章中，我计划展示如何使用零知识证明来解决这个问题。

点击此处查看我的更多作品opens in a new tab。

页面最后更新： 2025年9月9日