Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 11 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,19 @@
# Ponder Extension for Scaffold-ETH 2
# Scaffold-ETH 2 Extensions - AI Skills

This extension integrates Ponder with Scaffold-ETH 2, making it easy to build and deploy a custom API that serves data from your smart contracts on any EVM chain. Ponder is an open-source backend framework for blockchain apps, helping you deliver custom data to your frontend quickly.
AI skills for extending [Scaffold-ETH 2](https://github.com/scaffold-eth/scaffold-eth-2) projects. Each skill gives an AI agent the knowledge it needs to integrate a technology into an SE-2 app.

## Installation
## Available Skills

```bash
npx create-eth@latest -e ponder
```
| Skill | Description |
|-------|-------------|
| [Ponder](./skills/ponder/SKILL.md) | Blockchain event indexing with [Ponder](https://ponder.sh/). Automatically indexes deployed contract events and serves data via GraphQL |

## 🚀 Setup Ponder Extension
## Usage

### Config
Point your AI agent directly at the skill file (`skills/ponder/SKILL.md`) for the full integration knowledge.

Ponder config (`packages/ponder/ponder.config.ts`) is set automatically from the deployed contracts and using the first blockchain network setup at `packages/nextjs/scaffold.config.ts`.
## How Skills Work

### Design your schema
Unlike traditional template-based extensions that merge files mechanically, skills are **knowledge documents**. They contain everything an AI agent needs to know: dependencies, configuration patterns, integration points, and examples, organized by concern rather than as rigid step-by-step instructions.

You can define your Ponder data schema on the file at `packages/ponder/ponder.schema.ts` following the Ponder documentation (https://ponder.sh/docs/schema).

### Indexing data

You can index events by adding files to `packages/ponder/src/` (https://ponder.sh/docs/indexing/write-to-the-database)

### Start the development server

Run `yarn ponder:dev` to start the Ponder development server, for indexing and serving the GraphQL API endpoint at http://localhost:42069

### Query the GraphQL API

With the dev server running, open http://localhost:42069 in your browser to use the GraphiQL interface. GraphiQL is a useful tool for exploring your schema and testing queries during development. (https://ponder.sh/docs/query/graphql)

You can query data on a page using `@tanstack/react-query`. Check the code at `packages/nextjs/app/greetings/page.ts` to get the greetings updates data and show it.

### Deploy

To deploy the Ponder indexer please refer to the Ponder Deploy documentation https://ponder.sh/docs/production/railway

At **Settings** -> **Deploy** -> you must set **Custom Start Command** to `yarn ponder:start`.

And then you have to set up the `NEXT_PUBLIC_PONDER_URL` env variable on your SE-2 dapp to use the deployed ponder indexer.
The AI reads the skill and applies it intelligently to the specific project, adapting to existing code and user preferences.
37 changes: 0 additions & 37 deletions extension/README.md.args.mjs

This file was deleted.

10 changes: 0 additions & 10 deletions extension/package.json

This file was deleted.

182 changes: 0 additions & 182 deletions extension/packages/nextjs/app/ponder-greetings/page.tsx

This file was deleted.

8 changes: 0 additions & 8 deletions extension/packages/nextjs/components/Header.tsx.args.mjs

This file was deleted.

6 changes: 0 additions & 6 deletions extension/packages/nextjs/package.json

This file was deleted.

9 changes: 0 additions & 9 deletions extension/packages/ponder/.env.example

This file was deleted.

21 changes: 0 additions & 21 deletions extension/packages/ponder/.gitignore.template.mjs

This file was deleted.

35 changes: 0 additions & 35 deletions extension/packages/ponder/README.md

This file was deleted.

Loading