Serverové komponenty a agenti pro web3 aplikace

agent

server

offchain

dapps

Začátečník

Ori Pomerantz

15. července 2024

8 minut čtení

Úvod

Ve většině případů používá decentralizovaná aplikace (dapp) server k distribuci softwaru, ale veškerá skutečná interakce probíhá mezi klientem (obvykle webovým prohlížečem) a blockchainem.

Existují však případy, kdy by pro aplikaci bylo přínosné mít serverovou komponentu, která běží nezávisle. Takový server by byl schopen reagovat na události a na požadavky z jiných zdrojů, jako je například API, vydáváním transakcí.

Existuje několik možných úkolů, které by takový server mohl plnit.

Držitel tajného stavu. Ve hrách je často užitečné, aby hráči neměli k dispozici všechny informace, které hra zná. Nicméně na blockchainu neexistují žádná tajemství, jakoukoli informaci, která je v blockchainu, může kdokoli snadno zjistit. Proto, pokud má být část herního stavu utajena, musí být uložena jinde (a případně mohou být účinky tohoto stavu ověřeny pomocí důkazů s nulovým vědomím).
Centralizované orákulum. Pokud jsou sázky dostatečně nízké, externí server, který čte nějaké informace online a poté je odesílá do řetězce, může být dostatečně dobrý pro použití jako orákulum.
Agent. Na blockchainu se nic nestane bez transakce, která to aktivuje. Server může jednat jménem uživatele a provádět akce, jako je arbitráž, když se naskytne příležitost.

Ukázkový program

Ukázkový server si můžete prohlédnout na GitHubu (opens in a new tab). Tento server naslouchá událostem přicházejícím z tohoto kontraktu (opens in a new tab), což je upravená verze Greeteru z nástroje Hardhat. Když se pozdrav změní, změní ho zpět.

Jak jej spustit:

Naklonujte si repozitář.

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

Nainstalujte potřebné balíčky. Pokud jej ještě nemáte, nainstalujte si nejprve Node.js (opens in a new tab).
```
npm install
```
Upravte .env a zadejte soukromý klíč účtu, který má ETH na testnetu Holesky. Pokud nemáte ETH na síti Holesky, můžete použít tento faucet (opens in a new tab).
```
PRIVATE_KEY=0x <private key goes here>
```
Spusťte server.
```
npm start
```
Přejděte do prohlížeče bloků (opens in a new tab) a pomocí jiné adresy, než je ta, která má soukromý klíč, upravte pozdrav. Uvidíte, že se pozdrav automaticky změní zpět.

Jak to funguje?

Nejjednodušší způsob, jak pochopit psaní serverové komponenty, je projít si ukázku řádek po řádku.

`src/app.ts`

Převážná většina programu je obsažena v src/app.ts (opens in a new tab).

Vytvoření nezbytných objektů

import {
  createPublicClient,
  createWalletClient,
  getContract,
  http,
  Address,
} from "viem"

Toto jsou entity Viem (opens in a new tab), které potřebujeme, funkce a typ Address (opens in a new tab). Tento server je napsán v jazyce TypeScript (opens in a new tab), což je rozšíření jazyka JavaScript, které jej činí silně typovaným (opens in a new tab).

import { privateKeyToAccount } from "viem/accounts"

Tato funkce (opens in a new tab) nám umožňuje vygenerovat informace o peněžence, včetně adresy, odpovídající soukromému klíči.

import { holesky } from "viem/chains"

Chcete-li ve Viem použít blockchain, musíte importovat jeho definici. V tomto případě se chceme připojit k testovacímu blockchainu Holesky (opens in a new tab).

// Takto přidáváme definice z .env do process.env.
import * as dotenv from "dotenv"
dotenv.config()

Tímto způsobem načteme .env do prostředí. Potřebujeme to pro soukromý klíč (viz dále).

const greeterAddress : Address = "0xB8f6460Dc30c44401Be26B0d6eD250873d8a50A6"
const greeterABI = [
    {
        "inputs": [
            {
                "internalType": "string",
                "name": "_greeting",
                "type": "string"
            }
        ],
        "stateMutability": "nonpayable",
        "type": "constructor"
    },
         .
         .
         .
    {
        "inputs": [
            {
                "internalType": "string",
                "name": "_greeting",
                "type": "string"
            }
        ],
        "name": "setGreeting",
        "outputs": [],
        "stateMutability": "nonpayable",
        "type": "function"
    }
] as const

K použití kontraktu potřebujeme jeho adresu a . Obojí poskytujeme zde.

V JavaScriptu (a tedy i v TypeScriptu) nemůžete konstantě přiřadit novou hodnotu, ale můžete upravit objekt, který je v ní uložen. Použitím přípony as const říkáme TypeScriptu, že samotný seznam je konstantní a nesmí být měněn.

const publicClient = createPublicClient({
  chain: holesky,
  transport: http(),
})

Vytvořte veřejného klienta (opens in a new tab) Viem. Veřejní klienti nemají připojený soukromý klíč, a proto nemohou odesílat transakce. Mohou volat funkce view (opens in a new tab), číst zůstatky účtů atd.

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

Proměnné prostředí jsou dostupné v process.env (opens in a new tab). TypeScript je však silně typovaný. Proměnná prostředí může být jakýkoli řetězec, nebo může být prázdná, takže typ pro proměnnou prostředí je string | undefined. Klíč je však ve Viem definován jako 0x${string} (0x následované řetězcem). Zde říkáme TypeScriptu, že proměnná prostředí PRIVATE_KEY bude tohoto typu. Pokud není, dostaneme chybu za běhu (runtime error).

Funkce privateKeyToAccount (opens in a new tab) pak používá tento soukromý klíč k vytvoření plnohodnotného objektu účtu.

const walletClient = createWalletClient({
  account,
  chain: holesky,
  transport: http(),
})

Dále použijeme objekt účtu k vytvoření klienta peněženky (opens in a new tab). Tento klient má soukromý klíč a adresu, takže jej lze použít k odesílání transakcí.

const greeter = getContract({
  address: greeterAddress,
  abi: greeterABI,
  client: { public: publicClient, wallet: walletClient },
})

Nyní, když máme všechny předpoklady, můžeme konečně vytvořit instanci kontraktu (opens in a new tab). Tuto instanci kontraktu použijeme ke komunikaci s onchain kontraktem.

Čtení z blockchainu

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

Funkce kontraktu, které jsou pouze pro čtení (view (opens in a new tab) a pure (opens in a new tab)), jsou dostupné pod read. V tomto případě to použijeme pro přístup k funkci greet (opens in a new tab), která vrací pozdrav.

JavaScript je jednovláknový, takže když spustíme dlouho běžící proces, musíme specifikovat, že to děláme asynchronně (opens in a new tab). Volání blockchainu, a to i pro operaci pouze pro čtení, vyžaduje obousměrnou komunikaci mezi počítačem a uzlem blockchainu. To je důvod, proč zde specifikujeme, že kód musí na výsledek počkat pomocí await.

Pokud vás zajímá, jak to funguje, můžete si o tom přečíst zde (opens in a new tab), ale z praktického hlediska vám stačí vědět, že pokud spustíte operaci, která trvá dlouho, použijete na výsledky await, a že každá funkce, která to dělá, musí být deklarována jako async.

Vydávání transakcí

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

Toto je funkce, kterou voláte k vydání transakce, jež změní pozdrav. Vzhledem k tomu, že se jedná o dlouhou operaci, je funkce deklarována jako async. Kvůli vnitřní implementaci musí každá funkce async vracet objekt Promise. V tomto případě Promise<any> znamená, že nespecifikujeme, co přesně bude v Promise vráceno.

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

Pole write instance kontraktu obsahuje všechny funkce, které zapisují do stavu blockchainu (ty, které vyžadují odeslání transakce), jako je setGreeting (opens in a new tab). Parametry, pokud nějaké jsou, se poskytují jako seznam a funkce vrací hash transakce.

    console.log(`Working on a fix, see https://eth-holesky.blockscout.com/tx/${txHash}`)

    return txHash
}

Nahlaste hash transakce (jako součást URL adresy do prohlížeče bloků pro její zobrazení) a vraťte jej.

Reakce na události

greeter.watchEvent.SetGreeting({

Funkce watchEvent (opens in a new tab) umožňuje určit, že se má funkce spustit při vyvolání události. Pokud vás zajímá pouze jeden typ události (v tomto případě SetGreeting), můžete použít tuto syntaxi a omezit se pouze na tento typ události.

    onLogs: logs => {

Funkce onLogs se volá, když existují záznamy v logu. V Ethereu jsou pojmy „log“ a „událost“ obvykle zaměnitelné.

console.log(
  `Address ${logs[0].args.sender} changed the greeting to ${logs[0].args.greeting}`
)

Může existovat více událostí, ale pro jednoduchost nás zajímá pouze ta první. logs[0].args jsou argumenty události, v tomto případě sender a greeting.

        if (logs[0].args.sender != account.address)
            setGreeting(`${account.address} insists on it being Hello!`)
    }
})

Pokud odesílatelem není tento server, použijte setGreeting ke změně pozdravu.

`package.json`

Tento soubor (opens in a new tab) řídí konfiguraci Node.js (opens in a new tab). Tento článek vysvětluje pouze důležité definice.

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

Tato definice určuje, který soubor JavaScript se má spustit.

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

Skripty představují různé akce aplikace. V tomto případě máme pouze start, který zkompiluje a poté spustí server. Příkaz tsc je součástí balíčku typescript a kompiluje TypeScript do JavaScriptu. Pokud jej chcete spustit ručně, nachází se v node_modules/.bin. Druhý příkaz spustí server.

  "type": "module",

Existuje více typů aplikací v Node.js. Typ module nám umožňuje mít await v kódu na nejvyšší úrovni, což je důležité, když provádíte pomalé (a tedy asynchronní) operace.

  "devDependencies": {
    "@types/node": "^20.14.2",
    "typescript": "^5.4.5"
  },

Toto jsou balíčky, které jsou vyžadovány pouze pro vývoj. Zde potřebujeme typescript a protože jej používáme s Node.js, získáváme také typy pro proměnné a objekty Node, jako je process. Zápis ^<version> (opens in a new tab) znamená danou verzi nebo vyšší verzi, která neobsahuje změny narušující zpětnou kompatibilitu (breaking changes). Více informací o významu čísel verzí naleznete zde (opens in a new tab).

  "dependencies": {
    "dotenv": "^16.4.5",
    "viem": "2.14.1"
  }
}

Toto jsou balíčky, které jsou vyžadovány za běhu, při spuštění dist/app.js.

Závěr

Centralizovaný server, který jsme zde vytvořili, plní svůj úkol, kterým je fungovat jako agent pro uživatele. Kdokoli jiný, kdo chce, aby dapp nadále fungovala, a je ochoten utratit gas, může spustit novou instanci serveru s vlastní adresou.

To však funguje pouze tehdy, když lze akce centralizovaného serveru snadno ověřit. Pokud má centralizovaný server nějaké tajné informace o stavu nebo provádí složité výpočty, jedná se o centralizovanou entitu, které musíte při používání aplikace důvěřovat, což je přesně to, čemu se blockchainy snaží vyhnout. V budoucím článku plánuji ukázat, jak tento problém obejít pomocí důkazů s nulovým vědomím.

Zde najdete více z mé práce (opens in a new tab).