Skip to content

Commit 75f56c7

Browse files
cursoragentshane
cursoragent
and
shane
committed
feat: Add warnings for unsupported chain IDs
Co-authored-by: shane <[email protected]>
1 parent e931b0d commit 75f56c7

File tree

6 files changed

+204
-0
lines changed

6 files changed

+204
-0
lines changed

‎evm/activity.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,32 @@ Each activity includes detailed information such as:
3232
Activities are mostly indexed events. There are, of course, no events for native token transfers (wen [7708](https://ethereum-magicians.org/t/eip-7708-eth-transfers-emit-a-log/20034)?). We do have a heuristic to catch very simple native token transfers, where the native token transfer is the entirety of the transaction, but unfortunately we don't currently catch native token transfers that happen within internal txns.
3333
</Callout>
3434

35+
## Unsupported Chain IDs
36+
37+
When you request chain IDs that are not supported, the API will return a warning in the response instead of throwing an error. The `warnings` field will contain information about which chain IDs were not supported, and activity will be returned only for the supported chains.
38+
39+
For example, if you request `chain_ids=1,9999,10,77777777777`:
40+
41+
```json
42+
{
43+
"activity": [
44+
// Activity for chains 1 and 10 only
45+
],
46+
"warnings": [
47+
{
48+
"code": "UNSUPPORTED_CHAIN_IDS",
49+
"message": "Some requested chain_ids are not supported. Activity is returned only for supported chains.",
50+
"chain_ids": [9999, 77777777777],
51+
"docs_url": "https://docs.sim.dune.com/evm/supported-chains"
52+
}
53+
]
54+
}
55+
```
56+
57+
<Note>
58+
Invalid chain ID tags (like typos in tag names) will still return errors as designed. Only invalid numeric chain IDs generate warnings.
59+
</Note>
60+
3561
## Data Finality & Re-orgs
3662

3763
Sim APIs are designed to automatically detect and handle blockchain re-organizations.

‎evm/balances.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,33 @@ When set, each balance includes a `historical_prices` array with one entry per o
7373
The maximum number of historical price offsets is 3. If more than 3 are provided, the API returns an error.
7474
</Warning>
7575

76+
## Unsupported Chain IDs
77+
78+
When you request chain IDs that are not supported, the API will return a warning in the response instead of throwing an error. The `warnings` field will contain information about which chain IDs were not supported, and balances will be returned only for the supported chains.
79+
80+
For example, if you request `chain_ids=1,9999,10,77777777777`:
81+
82+
```json
83+
{
84+
"wallet_address": "0x37305b1cd40574e4c5ce33f8e8306be057fd7341",
85+
"balances": [
86+
// Balances for chains 1 and 10 only
87+
],
88+
"warnings": [
89+
{
90+
"code": "UNSUPPORTED_CHAIN_IDS",
91+
"message": "Some requested chain_ids are not supported. Balances are returned only for supported chains.",
92+
"chain_ids": [9999, 77777777777],
93+
"docs_url": "https://docs.sim.dune.com/evm/supported-chains"
94+
}
95+
]
96+
}
97+
```
98+
99+
<Note>
100+
Invalid chain ID tags (like typos in tag names) will still return errors as designed. Only invalid numeric chain IDs generate warnings.
101+
</Note>
102+
76103
## Pagination
77104

78105
This endpoint is using cursor based pagination. You can use the `limit` query parameter to define the maximum page size.

‎evm/openapi/activity.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,38 @@
324324
}
325325
}
326326
},
327+
"Warning": {
328+
"type": "object",
329+
"required": [
330+
"code",
331+
"message"
332+
],
333+
"properties": {
334+
"code": {
335+
"type": "string",
336+
"description": "Warning code identifier",
337+
"example": "UNSUPPORTED_CHAIN_IDS"
338+
},
339+
"message": {
340+
"type": "string",
341+
"description": "Human-readable warning message",
342+
"example": "Some requested chain_ids are not supported. Activity is returned only for supported chains."
343+
},
344+
"chain_ids": {
345+
"type": "array",
346+
"items": {
347+
"type": "integer",
348+
"format": "int64"
349+
},
350+
"description": "List of chain IDs that triggered this warning"
351+
},
352+
"docs_url": {
353+
"type": "string",
354+
"description": "URL to relevant documentation",
355+
"example": "https://docs.sim.dune.com/evm/supported-chains"
356+
}
357+
}
358+
},
327359
"ActivityResponse": {
328360
"type": "object",
329361
"required": [
@@ -337,6 +369,13 @@
337369
},
338370
"description": "Array of activity items"
339371
},
372+
"warnings": {
373+
"type": "array",
374+
"items": {
375+
"$ref": "#/components/schemas/Warning"
376+
},
377+
"description": "Array of warnings about the request. For example, warnings about unsupported chain IDs."
378+
},
340379
"next_offset": {
341380
"type": "string",
342381
"description": "Pagination cursor for the next page of results"

‎evm/openapi/balances.json‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,38 @@
431431
}
432432
}
433433
},
434+
"Warning": {
435+
"type": "object",
436+
"required": [
437+
"code",
438+
"message"
439+
],
440+
"properties": {
441+
"code": {
442+
"type": "string",
443+
"description": "Warning code identifier",
444+
"example": "UNSUPPORTED_CHAIN_IDS"
445+
},
446+
"message": {
447+
"type": "string",
448+
"description": "Human-readable warning message",
449+
"example": "Some requested chain_ids are not supported. Balances are returned only for supported chains."
450+
},
451+
"chain_ids": {
452+
"type": "array",
453+
"items": {
454+
"type": "integer",
455+
"format": "int64"
456+
},
457+
"description": "List of chain IDs that triggered this warning"
458+
},
459+
"docs_url": {
460+
"type": "string",
461+
"description": "URL to relevant documentation",
462+
"example": "https://docs.sim.dune.com/evm/supported-chains"
463+
}
464+
}
465+
},
434466
"BalancesResponse": {
435467
"type": "object",
436468
"required": [
@@ -451,6 +483,13 @@
451483
}
452484
]
453485
},
486+
"warnings": {
487+
"type": "array",
488+
"items": {
489+
"$ref": "#/components/schemas/Warning"
490+
},
491+
"description": "Array of warnings about the request. For example, warnings about unsupported chain IDs."
492+
},
454493
"next_offset": {
455494
"type": "string",
456495
"description": "Use this value as the `offset` in your next request to continue pagination. Not included when there are no more balances."
@@ -482,6 +521,13 @@
482521
"type": "array",
483522
"items": { "$ref": "#/components/schemas/BalanceData" }
484523
},
524+
"warnings": {
525+
"type": "array",
526+
"items": {
527+
"$ref": "#/components/schemas/Warning"
528+
},
529+
"description": "Array of warnings about the request. For example, warnings about unsupported chain IDs."
530+
},
485531
"request_time": { "type": "string", "format": "date-time" },
486532
"response_time": { "type": "string", "format": "date-time" },
487533
"wallet_address": { "type": "string", "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045" }

‎evm/openapi/transactions.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,38 @@
453453
}
454454
}
455455
},
456+
"Warning": {
457+
"type": "object",
458+
"required": [
459+
"code",
460+
"message"
461+
],
462+
"properties": {
463+
"code": {
464+
"type": "string",
465+
"description": "Warning code identifier",
466+
"example": "UNSUPPORTED_CHAIN_IDS"
467+
},
468+
"message": {
469+
"type": "string",
470+
"description": "Human-readable warning message",
471+
"example": "Some requested chain_ids are not supported. Transactions are returned only for supported chains."
472+
},
473+
"chain_ids": {
474+
"type": "array",
475+
"items": {
476+
"type": "integer",
477+
"format": "int64"
478+
},
479+
"description": "List of chain IDs that triggered this warning"
480+
},
481+
"docs_url": {
482+
"type": "string",
483+
"description": "URL to relevant documentation",
484+
"example": "https://docs.sim.dune.com/evm/supported-chains"
485+
}
486+
}
487+
},
456488
"TransactionsResponse": {
457489
"type": "object",
458490
"required": [
@@ -473,6 +505,13 @@
473505
}
474506
]
475507
},
508+
"warnings": {
509+
"type": "array",
510+
"items": {
511+
"$ref": "#/components/schemas/Warning"
512+
},
513+
"description": "Array of warnings about the request. For example, warnings about unsupported chain IDs."
514+
},
476515
"next_offset": {
477516
"type": "string"
478517
},

‎evm/transactions.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,33 @@ Transactions are ordered by descending block time, so the most recent transactio
1414

1515
<SupportedChains endpoint="transactions" />
1616

17+
## Unsupported Chain IDs
18+
19+
When you request chain IDs that are not supported, the API will return a warning in the response instead of throwing an error. The `warnings` field will contain information about which chain IDs were not supported, and transactions will be returned only for the supported chains.
20+
21+
For example, if you request `chain_ids=1,9999,10,77777777777`:
22+
23+
```json
24+
{
25+
"wallet_address": "0x37305b1cd40574e4c5ce33f8e8306be057fd7341",
26+
"transactions": [
27+
// Transactions for chains 1 and 10 only
28+
],
29+
"warnings": [
30+
{
31+
"code": "UNSUPPORTED_CHAIN_IDS",
32+
"message": "Some requested chain_ids are not supported. Transactions are returned only for supported chains.",
33+
"chain_ids": [9999, 77777777777],
34+
"docs_url": "https://docs.sim.dune.com/evm/supported-chains"
35+
}
36+
]
37+
}
38+
```
39+
40+
<Note>
41+
Invalid chain ID tags (like typos in tag names) will still return errors as designed. Only invalid numeric chain IDs generate warnings.
42+
</Note>
43+
1744
## Decoded transactions
1845

1946
Enable decoded transaction data and logs by adding the `?decode=true` query parameter to your request.

0 commit comments

Comments
 (0)