create-ponder
API reference
The create-ponder CLI tool is the easiest way to get started with Ponder.
It asks a few questions, then creates a new Ponder project in the specified directory including all required files (package.json, ponder.config.ts, ABIs, etc).
pnpm
pnpm create ponder {...options}Options
Usage:
$ create-ponder <directory> [options]
Options:
-t, --template [id] Use a template
--npm Use npm as your package manager
--pnpm Use pnpm as your package manager
--yarn Use yarn as your package manager
--skip-git Skip initializing a git repository
--skip-install Skip installing packages
-h, --help Display this message
-v, --version Display version numberTemplates
Templates help get you started faster by copying contract addresses, ABIs, and deployment blocks from an existing source.
Example projects
The -t, --template [id] option creates a new project from one of the example projects.
For example, this command creates a project using the feature-factory example project.
pnpm
pnpm create ponder --template feature-factoryHere are the available projects:
| Name | Template ID | Link |
|---|---|---|
| Factory contract | feature-factory | GitHub |
| Custom event filter | feature-filter | GitHub |
| Multiple chains | feature-multichain | GitHub |
| Proxy contract | feature-proxy | GitHub |
| Contract calls | feature-read-contract | GitHub |
| Friendtech project | project-friendtech | GitHub |
| Uniswap V3 flash loans | project-uniswap-v3-flash | GitHub |
| Basic ERC20 token | reference-erc20 | GitHub |
| Basic ERC721 token | reference-erc721 | GitHub |