Skip to content

Commit 16488ec

Browse files
fix(doc): indexer api (#94)
1 parent 2b95ff6 commit 16488ec

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

docs/indexer-api.md

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,39 @@ https://indexer-api-production-c33d.up.railway.app/
3232
```bash
3333
curl -X POST https://indexer-api-production-c33d.up.railway.app/graphql \
3434
-H "Content-Type: application/json" \
35-
-d '{"query": "{ assets { items { id address owner } } }"}'
35+
-d '{"query": "{ assetEntitys { items { id address owner } } }"}'
3636
```
3737

3838
---
3939

40+
### Available query fields
41+
42+
Ponder generates both a singular (fetch by ID) and a plural (list) field for each table.
43+
44+
| Singular | Plural (list) | Description |
45+
|---|---|---|
46+
| `assetEntity` | `assetEntitys` | Asset contract state |
47+
| `subscription` | `subscriptions` | Subscription state per asset–subscriber |
48+
| `assetRegistry_AssetCreated` | `assetRegistry_AssetCreateds` | Asset creation events |
49+
| `assetRegistry_OwnershipTransferred` | `assetRegistry_OwnershipTransferreds` | Registry ownership transfer events |
50+
| `assetRegistry_RegistryFeeShareUpdated` | `assetRegistry_RegistryFeeShareUpdateds` | Registry fee share update events |
51+
| `assetRegistry_RegistryFeeClaimedBatch` | `assetRegistry_RegistryFeeClaimedBatchs` | Registry fee claim batch events |
52+
| `asset_SubscriptionAdded` | `asset_SubscriptionAddeds` | New subscription events |
53+
| `asset_SubscriptionExtended` | `asset_SubscriptionExtendeds` | Subscription extension events |
54+
| `asset_SubscriptionRevoked` | `asset_SubscriptionRevokeds` | Subscription revocation events |
55+
| `asset_SubscriptionCancelled` | `asset_SubscriptionCancelleds` | Subscription cancellation events |
56+
| `asset_SubscriptionPriceUpdated` | `asset_SubscriptionPriceUpdateds` | Subscription price update events |
57+
| `asset_CreatorFeeClaimed` | `asset_CreatorFeeClaimeds` | Creator fee claim events |
58+
| `asset_OwnershipTransferred` | `asset_OwnershipTransferreds` | Asset ownership transfer events |
59+
| `_meta` || Indexer metadata (last indexed block, etc.) |
60+
61+
---
62+
4063
## Data Model
4164

4265
### Entities (mutable state)
4366

44-
#### `AssetEntity`
67+
#### `assetEntity`
4568

4669
Current state of each asset contract created through the registry.
4770

@@ -57,7 +80,7 @@ Current state of each asset contract created through the registry.
5780
**Example query — fetch all assets by owner:**
5881
```graphql
5982
{
60-
assets(where: { owner: "0xYourAddress" }) {
83+
assetEntitys(where: { owner: "0xYourAddress" }) {
6184
items {
6285
id
6386
assetId
@@ -70,15 +93,15 @@ Current state of each asset contract created through the registry.
7093

7194
---
7295

73-
#### `Subscription`
96+
#### `subscription`
7497

7598
Current subscription state per asset–subscriber pair. One row per unique `(asset, subscriber)` — not per nonce. Preserves the original `startTime` across mid-subscription term changes.
7699

77100
| Field | Type | Description |
78101
|---|---|---|
79-
| `id` | `String` | Primary key — `{AssetEntity.id}_{subscriber}` |
102+
| `id` | `String` | Primary key — `{assetEntity.id}_{subscriber}` |
80103
| `chainId` | `Int` | Chain ID |
81-
| `assetId` | `String` | Links to `AssetEntity.id` |
104+
| `assetId` | `String` | Links to `assetEntity.id` |
82105
| `subscriber` | `String` | `bytes32` subscriber identity hash |
83106
| `payer` | `String` | Address that paid (latest nonce) |
84107
| `startTime` | `BigInt` | Unix timestamp — original start of unbroken subscription |
@@ -120,7 +143,7 @@ Current subscription state per asset–subscriber pair. One row per unique `(ass
120143

121144
All event tables follow the same ID format: `{chainId}-{txHash}-{logIndex}`.
122145

123-
#### `AssetRegistry_AssetCreated`
146+
#### `assetRegistry_AssetCreated`
124147

125148
Emitted when a new Asset contract is deployed through the registry.
126149

@@ -137,7 +160,7 @@ Emitted when a new Asset contract is deployed through the registry.
137160

138161
---
139162

140-
#### `Asset_SubscriptionAdded`
163+
#### `asset_SubscriptionAdded`
141164

142165
Emitted when a new subscription is purchased.
143166

@@ -154,7 +177,7 @@ Emitted when a new subscription is purchased.
154177

155178
---
156179

157-
#### `Asset_SubscriptionExtended`
180+
#### `asset_SubscriptionExtended`
158181

159182
Emitted when an existing subscription's end time is extended.
160183

@@ -168,7 +191,7 @@ Emitted when an existing subscription's end time is extended.
168191

169192
---
170193

171-
#### `Asset_SubscriptionRevoked` / `Asset_SubscriptionCancelled`
194+
#### `asset_SubscriptionRevoked` / `asset_SubscriptionCancelled`
172195

173196
Emitted when a subscription ends early (revoked by owner, or cancelled by subscriber).
174197

@@ -181,7 +204,7 @@ Emitted when a subscription ends early (revoked by owner, or cancelled by subscr
181204

182205
---
183206

184-
#### `Asset_SubscriptionPriceUpdated`
207+
#### `asset_SubscriptionPriceUpdated`
185208

186209
| Field | Type |
187210
|---|---|
@@ -192,7 +215,7 @@ Emitted when a subscription ends early (revoked by owner, or cancelled by subscr
192215

193216
---
194217

195-
#### `Asset_CreatorFeeClaimed`
218+
#### `asset_CreatorFeeClaimed`
196219

197220
| Field | Type |
198221
|---|---|
@@ -204,7 +227,7 @@ Emitted when a subscription ends early (revoked by owner, or cancelled by subscr
204227

205228
---
206229

207-
#### `AssetRegistry_RegistryFeeClaimedBatch`
230+
#### `assetRegistry_RegistryFeeClaimedBatch`
208231

209232
| Field | Type |
210233
|---|---|
@@ -216,7 +239,7 @@ Emitted when a subscription ends early (revoked by owner, or cancelled by subscr
216239

217240
---
218241

219-
#### `AssetRegistry_RegistryFeeShareUpdated`
242+
#### `assetRegistry_RegistryFeeShareUpdated`
220243

221244
| Field | Type |
222245
|---|---|
@@ -263,3 +286,4 @@ All GraphQL list queries support cursor-based pagination:
263286
- All addresses are lowercase hex strings
264287
- `blockTimestamp` is a Unix timestamp in seconds
265288
- The API serves from a stable views schema — it remains available during indexer redeploys (zero downtime)
289+
- Ponder pluralises list fields by appending `s` to the table name (e.g. `assetEntitys`, `asset_SubscriptionAddeds`)

0 commit comments

Comments
 (0)