Das Projekt lokal starten

Die Verzeichnisse haben eigene Abhängigkeiten. Verwenden Sie die Lockfiles des Repositorys und halten Sie die Versionen von Verträgen, ABI, Manifesten und Clients aufeinander abgestimmt.

Die folgenden Befehle bauen oder prüfen die Komponenten lokal. Sie sind kein Verfahren zur Produktionsbereitstellung.

Voraussetzungen

Das Projekt verwendet eine aktuelle Node.js-Version, pnpm für dApp und Dienste, Foundry für Solidity sowie npm für dieses GitBook. Die Dienste benötigen Node 22 oder neuer; das GitBook wurde mit Node 24 vorbereitet.

Die Verträge legen Solidity 0.8.26, die EVM Cancun, die Verarbeitung via IR, den Optimierer mit 10 Runs und den Verzicht auf CBOR-Metadaten fest. Diese Parameter gehören zur Identität der zu prüfenden Bytecodes.

Nach dem Klonen müssen die Solidity-Abhängigkeiten des Repositorys vorhanden sein:

git submodule update --init --recursive

Verträge kompilieren und testen

Im Verzeichnis contracts/:

forge build --sizes
forge test

Die Konfiguration enthält mehrere Stufen für Fuzzing und Invarianten:

FOUNDRY_PROFILE=ci forge test
FOUNDRY_PROFILE=gate forge test

Das Gate-Profil ist bewusst langlaufend. Ein Testergebnis muss der genauen Revision, den Parametern und den kompilierten Quellen zugeordnet werden. Die neue Implementierung mit mehreren Walls befindet sich noch in der Validierung; ein früheres Log ist kein Ergebnis dieser Befehle auf dieser Version.

Die dApp starten

Im Verzeichnis dapp/:

pnpm install --frozen-lockfile
pnpm typecheck
pnpm test
pnpm build
pnpm dev

Vite zeigt die Entwicklungs-URL an. Die Konfiguration unterscheidet zwischen einem Simulationsmodus und den Daten des konfigurierten Deployments. Verwenden Sie die Beispiele und Anweisungen des Repositorys, um lokal einen RPC zu konfigurieren, ohne Zugangsdaten in die Quellen oder das öffentliche Bundle zu kopieren.

Dass das Frontend kompiliert, beweist nicht, dass sein Manifest dem im Netzwerk vorhandenen Vertrag entspricht.

Die ABI pflegen

Im Verzeichnis contracts/ folgt der Export auf die Kompilierung:

bash scripts/export-abi.sh
python3 scripts/check-abi.py

Für die dApp steht pnpm gen-abi, für die Dienste pnpm gen:abi bereit. Prüfen Sie die erzeugten Änderungen an den betroffenen Schnittstellen, Ereignissen und Typen. Die neue Wall-Bibliothek und die Ansichten nach ID müssen in die Synchronisierung der Veröffentlichung aufgenommen werden.

Der dApp-Befehl pnpm sync-deployment liest ein Deployment-Manifest erneut ein: Er darf nur mit den Metadaten der tatsächlich geprüften Version ausgeführt werden.

Die Dienste prüfen

Im Verzeichnis services/:

pnpm install --frozen-lockfile
pnpm gen:abi
pnpm typecheck
pnpm test

Der Dry-Run-Modus des Keepers wird mit den in seiner README dokumentierten lokalen Parametern konfiguriert. Betrieb und Wiederaufnahme von Transaktionen haben eine eigene Seite.

Dieses GitBook starten

Im Verzeichnis gitbook/:

npm ci
npm run dev

Die Website wird unter http://localhost:4000 mit erneutem Aufbau der Seiten bereitgestellt. Um das statische Verzeichnis _book/ zu erzeugen und die Links zu prüfen:

npm run build
npm run preview

Die lokale Vorschau verwendet http://localhost:4001. Die Schriftarten sind eingebettet; die Suche läuft im Browser auf dem Index des Buchs.

Um die Browserabläufe der Dokumentation zu prüfen:

npm run test:install
npm run test:browser

Die README von gitbook/ beschreibt die Wahl von HonKit, die Verzeichnisstruktur, die Prüfungen und die redaktionelle Pflege.

Quellen: contracts/foundry.toml, Repository-Skripte, dapp/package.json, services/package.json und gitbook/package.json. Für den Build dieser Dokumentation sind weder Schlüssel noch authentifizierte RPC-URLs erforderlich.