create-ponder
The easiest way to get started with Ponder is by using create-ponder
. This CLI tool creates a new Ponder project with package.json
, ponder.config.ts
, ponder.schema.ts
, ABIs, and other project files set up for you.
You can create a new app using the default template or one of the example apps.
pnpm create ponder {...options}
Options
option | description |
---|---|
--from-etherscan <url> | Link to a contract page on Etherscan |
--from-subgraph-id <id> | Subgraph ID, an IPFS content hash like "Qmb..." |
--etherscan-api-key <key> | Etherscan API key to use with --from-etherscan |
--dir <path> | Path to use for the project root |
Templates
Templates help get you started faster by copying contract addresses, ABIs, and deployment blocks from an existing source.
Etherscan contract link
The --from-etherscan
option accepts a link to an Etherscan contract page. See here for a full list of supported Etherscan deployments.
Subgraph ID
The --from-subgraph-id
option accepts a deployment ID for a subgraph that has been deployed to the hosted service. This template will copy schema.graphql
as well as the addresses, ABIs, and start blocks for each event source defined in the subgraph's subgraph.yaml
.