Skip to content

Commit c28a0f1

Browse files
committed
lint: fix method-examples warnings
1 parent 805250f commit c28a0f1

4 files changed

Lines changed: 74 additions & 2 deletions

File tree

openrpc-lint.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ extends: [recommended]
22
rules:
33
method-description:
44
severity: ignore
5-
method-examples:
6-
severity: warn
75
result-description:
86
severity: ignore
97
schema-description:

src/engine/openrpc/methods/forkchoice.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,38 @@
196196
message: Unsupported fork
197197
- code: -38006
198198
message: Too deep reorg
199+
examples:
200+
- name: engine_forkchoiceUpdatedV4 example
201+
params:
202+
- name: Forkchoice state
203+
value:
204+
headBlockHash: '0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858'
205+
safeBlockHash: '0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858'
206+
finalizedBlockHash: '0x3b8fb240d288781d4aac94d3fd16809ee413bc99294a085798a589dae51ddd4a'
207+
- name: Payload attributes
208+
value:
209+
timestamp: '0x64e7785b'
210+
prevRandao: '0xc130d5e63c61c935f6089e61140ca9136172677cf6aa5800dcc1cf0a02152a14'
211+
suggestedFeeRecipient: '0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b'
212+
withdrawals:
213+
- index: '0xf0'
214+
validatorIndex: '0xf0'
215+
address: '0x00000000000000000000000000000000000010f0'
216+
amount: '0x1'
217+
- index: '0xf1'
218+
validatorIndex: '0xf1'
219+
address: '0x00000000000000000000000000000000000010f1'
220+
amount: '0x1'
221+
parentBeaconBlockRoot: '0x11f780a954bcba8889998e4e61deaae6388dd2391e9c810bd9c94962cc1eadc1'
222+
slotNumber: '0x1'
223+
targetGasLimit: '0x1c9c380'
224+
- name: Custody columns
225+
value: null
226+
result:
227+
name: Response object
228+
value:
229+
payloadStatus:
230+
status: VALID
231+
latestValidHash: '0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858'
232+
validationError: null
233+
payloadId: '0x0000000021f32cc1'

src/eth/execute.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,3 +171,41 @@
171171
message: Max init code size exceeded
172172
- code: -38026
173173
message: Client adjustable limit exceeded
174+
examples:
175+
- name: eth_simulateV1 example
176+
params:
177+
- name: Payload
178+
value:
179+
blockStateCalls:
180+
- calls:
181+
- from: '0xfe3b557e8fb62b89f4916b721be55ceb828dbd73'
182+
to: '0x627306090abab3a6e1400e9345bc60c78a8bef57'
183+
value: '0x1'
184+
- name: Block tag
185+
value: latest
186+
result:
187+
name: Result of calls
188+
value:
189+
- hash: '0xd5f1812548be429cbdc6376b29611fc49e06f1359758c4ceaaa3b393e2239f9c'
190+
parentHash: '0x1f68ac259155e2f38211ddad0f0a15394d55417b185a93923e2abe71bb7a4d6d'
191+
sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'
192+
miner: '0xb42b6c4a95406c78ff892d270ad20b22642e102d'
193+
stateRoot: '0x91309efa7e42c1f137f31fe9edbe88ae087e6620d0d59031324da3e2f4f93233'
194+
transactionsRoot: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421'
195+
receiptsRoot: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421'
196+
logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
197+
number: '0x68b3'
198+
gasLimit: '0x47e7c4'
199+
gasUsed: '0x5208'
200+
timestamp: '0x5835c54d'
201+
extraData: '0x'
202+
mixHash: '0x24900fb3da77674a861c428429dce0762707ecb6052325bbd9b3c64e74b5af9d'
203+
nonce: '0x0000000000000000'
204+
size: '0x200'
205+
transactions: []
206+
uncles: []
207+
calls:
208+
- status: '0x1'
209+
returnData: '0x'
210+
gasUsed: '0x5208'
211+
logs: []

src/schemas/execute.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
EthSimulatePayload:
22
title: Arguments for eth_simulate
3+
type: object
34
required:
45
- blockStateCalls
56
properties:

0 commit comments

Comments
 (0)