Chạy dự án cục bộ

Mỗi thư mục có phụ thuộc riêng. Dùng lockfile của kho và giữ đồng bộ phiên bản hợp đồng, ABI, manifest và client.

Lệnh dưới đây build hoặc kiểm tra thành phần cục bộ, không phải quy trình đưa vào sản xuất.

Điều kiện trước

Dự án dùng Node.js gần đây, pnpm cho dapp và dịch vụ, Foundry cho Solidity, npm cho GitBook. Dịch vụ yêu cầu Node 22 trở lên; GitBook được chuẩn bị bằng Node 24.

Hợp đồng cố định Solidity 0.8.26, EVM Cancun, via IR, tối ưu 10 runs, không metadata CBOR. Các tham số thuộc định danh bytecode cần kiểm chứng.

Sau clone, phụ thuộc Solidity của kho phải có sẵn:

git submodule update --init --recursive

Biên dịch và kiểm thử hợp đồng

Từ contracts/:

forge build --sizes
forge test

Cấu hình có nhiều mức fuzzing và bất biến:

FOUNDRY_PROFILE=ci forge test
FOUNDRY_PROFILE=gate forge test

Profile gate cố ý chạy lâu. Kết quả kiểm thử phải gắn với đúng bản sửa đổi, tham số và mã đã biên dịch. Hiện thực nhiều tường mới còn xác thực; log cũ không phải kết quả chạy lệnh này trên bản đó.

Khởi động dapp

Từ dapp/:

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

Vite hiển thị URL phát triển. Cấu hình tách chế độ mô phỏng và dữ liệu của bản triển khai đã chọn. Theo ví dụ và hướng dẫn kho để đặt RPC cục bộ, không chép thông tin truy cập vào mã hoặc bundle công khai.

Frontend biên dịch được không chứng minh manifest khớp hợp đồng trên mạng.

Duy trì ABI

Từ contracts/, xuất sau biên dịch:

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

Dapp có pnpm gen-abi, dịch vụ có pnpm gen:abi. Xem thay đổi sinh ra của interface, sự kiện và kiểu liên quan. Đồng bộ bản phát hành phải gồm thư viện tường mới và view theo ID.

pnpm sync-deployment của dapp đọc lại manifest triển khai: chỉ chạy với metadata của phiên bản thực sự đã kiểm chứng.

Kiểm tra dịch vụ

Từ services/:

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

Dry-run keeper cấu hình bằng tham số cục bộ được nêu trong README. Vận hành và phục hồi giao dịch có trang riêng.

Khởi động GitBook này

Từ gitbook/:

npm ci
npm run dev

Site phục vụ ở http://localhost:4000, có build lại trang. Để tạo thư mục tĩnh _book/ và kiểm tra liên kết:

npm run build
npm run preview

Xem trước cục bộ dùng http://localhost:4001. Font được đóng gói; tìm kiếm chạy trong trình duyệt trên chỉ mục sách.

Để kiểm tra quy trình trình duyệt của tài liệu:

npm run test:install
npm run test:browser

README của gitbook/ mô tả lựa chọn HonKit, cây thư mục, kiểm tra và bảo trì nội dung.

Nguồn: contracts/foundry.toml, script trong kho, dapp/package.json, services/package.json và gitbook/package.json. Build tài liệu không cần khóa hay URL RPC có xác thực.