Skip to content

Commit 85a2ff4

Browse files
SahilAujlaSahilAujla
authored
add api specs for missing chains (#65)
* add api specs for missing chains * add server urls
1 parent 5b5116f commit 85a2ff4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+31316
-8
lines changed

‎build/api-specs/chains/celo.json‎

Lines changed: 8114 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎build/api-specs/chains/monad.json‎

Lines changed: 8106 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎build/api-specs/chains/sei.json‎

Lines changed: 8110 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎fern/docs.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2316,8 +2316,8 @@ navigation:
23162316
path: api-reference/celo/celo-chain-api-quickstart.mdx
23172317
- page: Celo Chain API FAQ
23182318
path: api-reference/celo/celo-chain-api-faq.mdx
2319-
- page: Celo Chain API Endpoints
2320-
path: api-reference/celo/celo-chain-api-endpoints.mdx
2319+
- api: Celo Chain API Endpoints
2320+
openrpc: ../build/api-specs/chains/celo.json
23212321
slug: celo
23222322
- section: 🐻 Berachain
23232323
contents:
@@ -2352,8 +2352,8 @@ navigation:
23522352
path: api-reference/sei/sei-api-quickstart.mdx
23532353
- page: Sei API FAQ
23542354
path: api-reference/sei/sei-api-faq.mdx
2355-
- page: Sei API Endpoints
2356-
path: api-reference/sei/sei-api-endpoints.mdx
2355+
- api: Sei API Endpoints
2356+
openrpc: ../build/api-specs/chains/sei.json
23572357
slug: sei
23582358
- section: ❇️ Flow
23592359
contents:
@@ -2451,8 +2451,8 @@ navigation:
24512451
path: api-reference/abstract/abstract-api-quickstart.mdx
24522452
- page: Abstract API FAQ
24532453
path: api-reference/abstract/abstract-api-faq.mdx
2454-
- page: Abstract API Endpoints
2455-
path: api-reference/abstract/abstract-api-endpoints.mdx
2454+
- api: Abstract API Endpoints
2455+
openrpc: ../build/api-specs/chains/abstract.json
24562456
slug: abstract
24572457
- section: 📒 opBNB (Paid Tier)
24582458
contents:
@@ -2508,6 +2508,6 @@ navigation:
25082508
path: api-reference/monad/monad-api-quickstart.mdx
25092509
- page: Monad API FAQ
25102510
path: api-reference/monad/monad-api-faq.mdx
2511-
- page: Monad API Endpoints
2512-
path: api-reference/monad/monad-api-endpoints.mdx
2511+
- api: Monad API Endpoints
2512+
openrpc: ../build/api-specs/chains/monad.json
25132513
slug: monad

‎src/openrpc/chains/celo/base.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
info:
2+
title: Alchemy Celo JSON-RPC Specification
3+
description: A specification of the standard JSON-RPC methods for Celo.
4+
version: 0.0.0
5+
servers:
6+
- url: https://celo-mainnet.g.alchemy.com/v2/
7+
name: Celo Mainnet
8+
- url: https://celo-alfajores.g.alchemy.com/v2/
9+
name: Celo Alfajores
10+
- url: https://celo-baklava.g.alchemy.com/v2/
11+
name: Celo Baklava

‎src/openrpc/chains/celo/components/base-types.yaml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
address:
2+
title: hex encoded address
3+
type: string
4+
pattern: ^0x[0-9a-fA-F]{40}$
5+
addresses:
6+
title: hex encoded address
7+
type: array
8+
items:
9+
$ref: "#/components/schemas/address"
10+
byte:
11+
title: hex encoded byte
12+
type: string
13+
pattern: ^0x([0-9a-fA-F]?){1,2}$
14+
bytes:
15+
title: hex encoded bytes
16+
type: string
17+
pattern: ^0x[0-9a-f]*$
18+
bytesMax32:
19+
title: 32 hex encoded bytes
20+
type: string
21+
pattern: ^0x[0-9a-f]{0,64}$
22+
bytes8:
23+
title: 8 hex encoded bytes
24+
type: string
25+
pattern: ^0x[0-9a-f]{16}$
26+
bytes32:
27+
title: 32 hex encoded bytes
28+
type: string
29+
pattern: ^0x[0-9a-f]{64}$
30+
bytes48:
31+
title: 48 hex encoded bytes
32+
type: string
33+
pattern: ^0x[0-9a-f]{96}$
34+
bytes96:
35+
title: 96 hex encoded bytes
36+
type: string
37+
pattern: ^0x[0-9a-f]{192}$
38+
bytes256:
39+
title: 256 hex encoded bytes
40+
type: string
41+
pattern: ^0x[0-9a-f]{512}$
42+
bytes65:
43+
title: 65 hex encoded bytes
44+
type: string
45+
pattern: ^0x[0-9a-f]{130}$
46+
ratio:
47+
title: normalized ratio
48+
type: number
49+
minimum: 0
50+
maximum: 1
51+
uint:
52+
title: hex encoded unsigned integer
53+
type: string
54+
pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$
55+
uint64:
56+
title: hex encoded 64 bit unsigned integer
57+
type: string
58+
pattern: ^0x([1-9a-f]+[0-9a-f]{0,15})|0$
59+
uint256:
60+
title: hex encoded 256 bit unsigned integer
61+
type: string
62+
pattern: ^0x([1-9a-f]+[0-9a-f]{0,31})|0$
63+
hash32:
64+
title: 32 byte hex value
65+
type: string
66+
pattern: ^0x[0-9a-f]{64}$
67+
notFound:
68+
title: "Not Found (null)"
69+
type: "null"

‎src/openrpc/chains/celo/components/block.yaml‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
Block:
2+
title: Block object
3+
type: object
4+
required:
5+
- hash
6+
- parentHash
7+
- sha3Uncles
8+
- miner
9+
- stateRoot
10+
- transactionsRoot
11+
- receiptsRoot
12+
- logsBloom
13+
- number
14+
- gasLimit
15+
- gasUsed
16+
- timestamp
17+
- extraData
18+
- mixHash
19+
- nonce
20+
- size
21+
- transactions
22+
- uncles
23+
additionalProperties: false
24+
properties:
25+
hash:
26+
title: Hash
27+
$ref: "#/components/schemas/hash32"
28+
parentHash:
29+
title: Parent block hash
30+
$ref: "#/components/schemas/hash32"
31+
sha3Uncles:
32+
title: Ommers hash
33+
$ref: "#/components/schemas/hash32"
34+
miner:
35+
title: Coinbase
36+
$ref: "#/components/schemas/address"
37+
stateRoot:
38+
title: State root
39+
$ref: "#/components/schemas/hash32"
40+
transactionsRoot:
41+
title: Transactions root
42+
$ref: "#/components/schemas/hash32"
43+
receiptsRoot:
44+
title: Receipts root
45+
$ref: "#/components/schemas/hash32"
46+
logsBloom:
47+
title: Bloom filter
48+
$ref: "#/components/schemas/bytes256"
49+
difficulty:
50+
title: Difficulty
51+
$ref: "#/components/schemas/uint"
52+
number:
53+
title: Number
54+
$ref: "#/components/schemas/uint"
55+
gasLimit:
56+
title: Gas limit
57+
$ref: "#/components/schemas/uint"
58+
gasUsed:
59+
title: Gas used
60+
$ref: "#/components/schemas/uint"
61+
timestamp:
62+
title: Timestamp
63+
$ref: "#/components/schemas/uint"
64+
extraData:
65+
title: Extra data
66+
$ref: "#/components/schemas/bytes"
67+
mixHash:
68+
title: Mix hash
69+
$ref: "#/components/schemas/hash32"
70+
nonce:
71+
title: Nonce
72+
$ref: "#/components/schemas/bytes8"
73+
baseFeePerGas:
74+
title: Base fee per gas
75+
$ref: "#/components/schemas/uint"
76+
withdrawalsRoot:
77+
title: Withdrawals root
78+
$ref: "#/components/schemas/hash32"
79+
blobGasUsed:
80+
title: Blob gas used
81+
$ref: "#/components/schemas/uint"
82+
excessBlobGas:
83+
title: Excess blob gas
84+
$ref: "#/components/schemas/uint"
85+
parentBeaconBlockRoot:
86+
title: Parent Beacon Block Root
87+
$ref: "#/components/schemas/hash32"
88+
size:
89+
title: Block size
90+
$ref: "#/components/schemas/uint"
91+
transactions:
92+
anyOf:
93+
- title: Transaction hashes
94+
type: array
95+
items:
96+
$ref: "#/components/schemas/hash32"
97+
- title: Full transactions
98+
type: array
99+
items:
100+
$ref: "#/components/schemas/TransactionInfo"
101+
withdrawals:
102+
title: Withdrawals
103+
type: array
104+
items:
105+
$ref: "#/components/schemas/Withdrawal"
106+
uncles:
107+
title: Uncles
108+
type: array
109+
items:
110+
$ref: "#/components/schemas/hash32"
111+
BlockTag:
112+
title: Block tag
113+
type: string
114+
enum:
115+
- earliest
116+
- finalized
117+
- safe
118+
- latest
119+
- pending
120+
description: "`earliest`: The lowest numbered block the client has available; `finalized`: The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination; `safe`: The most recent block that is safe from re-orgs under honest majority and certain synchronicity assumptions; `latest`: The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions; `pending`: A sample next block built by the client on top of `latest` and containing the set of transactions usually taken from local mempool. Before the merge transition is finalized, any call querying for `finalized` or `safe` block MUST be responded to with `-39001: Unknown block` error"
121+
BlockNumberOrTag:
122+
title: Block number or tag
123+
oneOf:
124+
- title: Block number
125+
$ref: "#/components/schemas/uint"
126+
- title: Block tag
127+
$ref: "#/components/schemas/BlockTag"
128+
BlockNumberOrTagOrHash:
129+
title: Block number, tag, or block hash
130+
anyOf:
131+
- title: Block number
132+
$ref: "#/components/schemas/uint"
133+
- title: Block tag
134+
$ref: "#/components/schemas/BlockTag"
135+
- title: Block hash
136+
$ref: "#/components/schemas/hash32"
137+
BadBlock:
138+
title: Bad block
139+
type: object
140+
required:
141+
- block
142+
- hash
143+
- rlp
144+
additionalProperties: false
145+
properties:
146+
block:
147+
title: Block
148+
$ref: "#/components/schemas/Block"
149+
hash:
150+
title: Hash
151+
$ref: "#/components/schemas/hash32"
152+
rlp:
153+
title: RLP
154+
$ref: "#/components/schemas/bytes"

‎src/openrpc/chains/celo/components/client.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
SyncingStatus:
2+
title: Syncing status
3+
oneOf:
4+
- title: Syncing progress
5+
type: object
6+
additionalProperties: false
7+
properties:
8+
startingBlock:
9+
title: Starting block
10+
$ref: "#/components/schemas/uint"
11+
currentBlock:
12+
title: Current block
13+
$ref: "#/components/schemas/uint"
14+
highestBlock:
15+
title: Highest block
16+
$ref: "#/components/schemas/uint"
17+
- title: Not syncing
18+
description: Should always return false if not syncing.
19+
type: boolean

‎src/openrpc/chains/celo/components/filter.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
FilterResults:
2+
title: Filter results
3+
oneOf:
4+
- title: new block or transaction hashes
5+
type: array
6+
items:
7+
$ref: "#/components/schemas/hash32"
8+
- title: new logs
9+
type: array
10+
items:
11+
$ref: "#/components/schemas/Log"
12+
Filter:
13+
title: filter
14+
type: object
15+
additionalProperties: false
16+
properties:
17+
fromBlock:
18+
title: from block
19+
$ref: "#/components/schemas/uint"
20+
toBlock:
21+
title: to block
22+
$ref: "#/components/schemas/uint"
23+
address:
24+
title: Address(es)
25+
oneOf:
26+
- title: Any Address
27+
type: "null"
28+
- title: Address
29+
$ref: "#/components/schemas/address"
30+
- title: Addresses
31+
$ref: "#/components/schemas/addresses"
32+
topics:
33+
title: Topics
34+
$ref: "#/components/schemas/FilterTopics"
35+
FilterTopics:
36+
title: Filter Topics
37+
oneOf:
38+
- title: Any Topic Match
39+
type: "null"
40+
- title: Specified Filter Topics
41+
type: array
42+
items:
43+
$ref: "#/components/schemas/FilterTopic"
44+
45+
FilterTopic:
46+
title: Filter Topic List Entry
47+
oneOf:
48+
- title: Single Topic Match
49+
$ref: "#/components/schemas/bytes32"
50+
- title: Multiple Topic Match
51+
type: array
52+
items:
53+
$ref: "#/components/schemas/bytes32"

0 commit comments

Comments
 (0)