ZKchainHub is envisioned as a permissionless, cloud-agnostic platform that allows anyone to deploy an instance, specifically focusing on the settlement chain. You can fetch metrics from the ZKsync ecosystem and ZK chains from L1 RPC (Ethereum). Optionally, it will also fetch data from L2 RPCs for the chains where the user provides the RPC.
This repository is a monorepo consisting of 4 packages and 1 app:
@zkchainhub/shared: A library for shared configurations, constants, types, etc.@zkchainhub/chain-providers: A library that provides abstracted services over Viem providers to query blockchain data@zkchainhub/pricing: An extensible library that provides Pricing services to fetch token prices. Currently, only Coingecko provider is developed@zkchainhub/metadata: A library that exposes different providers for fetching chains and tokens metadata.@zkchainhub/metrics: A library that provides different aggregated metrics from the ZKsync ecosystem and ZK chains.@zkchainhub/api: An Express server that exposes an API where you can fetch information about ZKsync ecosystem and their chains, using the before mentioned libraries
- Ensure you have
node >= 20.0.0andpnpm >= 9.5.0installed.
This is a high level architecture diagram of the ZKchainHub
graph LR
API -->|Ethereum RPC| ETH_RPC[Ethereum RPC]
API -.->|L2 RPC| L2_RPC[L2 RPC]
style API fill:#2E86C1,stroke:#ffffff,stroke-width:2px
style ETH_RPC fill:#2E86C1,stroke:#ffffff,stroke-width:2px
style L2_RPC fill:#2E86C1,stroke:#ffffff,stroke-width:2px
$ pnpm installTo build the monorepo packages, run:
$ pnpm build- Follow the instructions for
apps/apion API's README
# development watch mode
$ pnpm run dev
# production mode
$ pnpm run start
Verify that ZKchainHub API is running on http://localhost:3000 (or the port specified)
# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:covTo build a Docker image for the API, navigate to the root directory of the monorepo and run the following command:
docker build . --target api --tag api:latest
Locally Swagger docs are available at http://localhost:3000/docs
Run pnpm run lint to make sure the code base follows configured linter rules.
We follow the Conventional Commits specification.
ZKchainHub was built with ❤️ by Wonderland.
Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
DeFi sucks, but Wonderland is here to make it better.
This project is licensed under the MIT License. See the LICENSE file for details.