0gkitdocsGitHub

Templates

0gkit ships nine starter projects so you can go from zero to a running 0G app in one command. Each is a minimal, correct, copy-and-go example focused on one surface.

Scaffold any of them with create-0gkit-app:

npm create 0gkit-app@latest my-app -- --template <name>
cd my-app && pnpm install && pnpm dev

…or with degit if you want just the files (no git history):

npx degit rajkaria/0gkit/templates/<name> my-app
cd my-app && pnpm install

The CLI also scaffolds a minimal read-only project with no template needed: npx @foundryprotocol/0gkit-cli init my-app (writes package.json, .env.example, index.mjs, README.md, .gitignore). Use that for a bare start; use a template below for a focused, surface-specific example.


The five canonical archetypes (SP8)

chat

Real-time chat where messages live on 0G Storage and the on-chain MessagePosted event log is the source of truth for the message list. Uses the SP6 reorg-safe useEvent hook so rolled-back messages disappear automatically.

npm create 0gkit-app@latest my-chat -- --template chat

Surfaces demoed: wallet + storage + indexer + react + typed contracts. Best when: building anything where users post → the chain remembers.

storage-app

Upload + retrieve a file with SP7 dry-run preflight (predict cost + Merkle root before broadcasting), dedup (skip the funding tx if the root already exists), and round-trip verify. Uses @foundryprotocol/0gkit-storage + @foundryprotocol/0gkit-core.

npm create 0gkit-app@latest my-store -- --template storage-app

Surfaces demoed: wallet + storage + SP7 estimator. Best when: persisting datasets/artifacts to 0G.

ai-agent

Multi-step LangChain-style ReAct agent on 0G Compute, where every inference step's TEE attestation is verified before its decision is acted on. In-process loop today; documented hand-off path for SP10 (0gkit-jobs).

npm create 0gkit-app@latest my-agent -- --template ai-agent

Surfaces demoed: wallet + compute + attestation. Best when: chained model reasoning with auditable enclave provenance.

tee-attested-api

A Hono HTTP API where every response carries an X-0G-Attestation header. Clients can verify cryptographically that the response originated inside genuine enclave hardware. Plain console.log access logging today; documented hand-off for SP11 (0gkit-observability).

npm create 0gkit-app@latest my-api -- --template tee-attested-api

Surfaces demoed: wallet + attestation + compute. Best when: shipping a public API whose payloads need provenance.

nft-with-storage

A Foundry-deployed ERC-721 where both the metadata JSON and the media file live on 0G Storage. tokenURI(id) returns 0g-storage://<merkleRoot>. Uses SP4 typed-contract codegen.

npm create 0gkit-app@latest my-nft -- --template nft-with-storage

Surfaces demoed: wallet + storage + SP4 typed contracts. Best when: minting collectibles with on-chain provenance + off-chain payloads.


The four Phase-1 starters

inference-app

A Node script that runs a chat completion against a 0G compute provider and prints the on-chain fee receipt, including the OpenAI drop-in shim. Uses @foundryprotocol/0gkit-compute.

npm create 0gkit-app@latest my-infer -- --template inference-app

Best when: running paid LLM inference on 0G, or migrating OpenAI code.

attestation-verify

A pure, no-network, no-keys example that signs and verifies a TEE attestation envelope and prints a report. Uses @foundryprotocol/0gkit-attestation.

npm create 0gkit-app@latest my-attest -- --template attestation-verify

Best when: producing or checking signed eval-result attestations.

mcp-agent

A ready-to-wire MCP setup so Claude / Cursor / Cline can drive 0G. Includes the client config blocks from the MCP guide and an embedding example with @foundryprotocol/0gkit-mcp.

npm create 0gkit-app@latest my-mcp -- --template mcp-agent

Best when: giving an LLM agent direct, glue-free 0G access.

react-app

A Next.js client component using the @foundryprotocol/0gkit-react hooks — browser-side attestation verify plus a server route for the Node-only upload/inference path.

npm create 0gkit-app@latest my-ui -- --template react-app

Best when: building a 0G-powered React UI.

Deploy on Vercel

Every template ships with a one-click Vercel deploy button in its README. The button forks the template into a new repo under your GitHub account, prompts for the env vars below, and deploys on Fluid Compute in under 60 seconds.

TemplateRequired env varsDeploy
chatNETWORK, PRIVATE_KEYDeploy
storage-appNETWORK, PRIVATE_KEYDeploy
ai-agentNETWORK, PRIVATE_KEYDeploy
tee-attested-apiNETWORK, PRIVATE_KEY, OTEL_EXPORTER_OTLP_ENDPOINT (opt)Deploy
nft-with-storageNETWORK, PRIVATE_KEY, RPC_URLDeploy
inference-appNETWORK, PRIVATE_KEYDeploy
react-appNETWORK, WALLETCONNECT_PROJECT_ID (opt)Deploy
mcp-agentNETWORK, PRIVATE_KEYDeploy
attestation-verifyNETWORKDeploy

After scaffolding

Every template is testnet-first (Galileo) — no real funds needed. Run npx @foundryprotocol/0gkit-cli doctor to preflight, then follow the template's README. See Getting started for environment variables and Troubleshooting if a peer dependency complains.