Skip to content

Commit e84d2a1

Browse files
zcstarrzcstarr
committed
chore: add docs to update
1 parent 4611eb4 commit e84d2a1

File tree

63 files changed

+13356
-13536
lines changed

Some content is hidden

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

63 files changed

+13356
-13536
lines changed

‎packages/example-site/docs/api-reference/methods/debug_getBadBlocks.mdx‎

Lines changed: 833 additions & 823 deletions
Large diffs are not rendered by default.

‎packages/example-site/docs/api-reference/methods/debug_getRawBlock.mdx‎

Lines changed: 59 additions & 63 deletions
Large diffs are not rendered by default.

‎packages/example-site/docs/api-reference/methods/debug_getRawHeader.mdx‎

Lines changed: 59 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -5,97 +5,93 @@ hide_table_of_contents: true
55
description: ""
66
---
77

8-
import {TwoColumnLayout, InteractiveRequest, ResponseExample} from 'open-rpc-docusaurus-plugin-beta/components';
8+
import {TwoColumnLayout, InteractiveRequest, ResponseExample} from '@open-rpc/docusaurus-plugin/components';
99
import { useState } from 'react';
1010

1111
<TwoColumnLayout sidebar={<InteractiveRequest request={"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"debug_getRawHeader\",\n \"params\": [\n \"0x32026E\"\n ],\n \"id\": 1\n}"} />}>
12-
<div>
13-
# debug\_getRawHeader
14-
15-
16-
17-
Returns an RLP-encoded header.
12+
# debug\_getRawHeader
1813

19-
<div>
20-
## Parameters (by position)
2114

22-
<div>
23-
**Block** `string or string` *required*
2415

25-
***
16+
Returns an RLP-encoded header.
2617

27-
<details>
28-
<summary>
29-
Show Option 1 `Block number` string
30-
</summary>
18+
## Parameters (by position)
3119

32-
#### `Block number` fields
20+
**Block** `string or string` *required*
3321

34-
**Block** `string` *required*
22+
***
3523

36-
Block number
37-
38-
*Match pattern:* `^0x(0|[1-9a-f][0-9a-f]*)$`
39-
40-
***
41-
</details>
24+
<div>
25+
<details>
26+
<summary>
27+
Show Option 1 `Block number` string
28+
</summary>
4229

43-
<details>
44-
<summary>
45-
Show Option 2 `Block tag` string
46-
</summary>
30+
#### `Block number` fields
4731

48-
#### `Block tag` fields
32+
**Block** `string` *required*
4933

50-
`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
34+
Block number
5135

52-
**Block** `string` *required*
36+
*Match pattern:* `^0x(0|[1-9a-f][0-9a-f]*)$`
5337

54-
`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
38+
***
39+
</details>
40+
</div>
5541

56-
*Allowed values:* `earliest` `finalized` `safe` `latest` `pending`
42+
<div>
43+
<details>
44+
<summary>
45+
Show Option 2 `Block tag` string
46+
</summary>
5747

58-
***
59-
</details>
60-
</div>
61-
</div>
48+
#### `Block tag` fields
6249

63-
<div>
64-
## Result
50+
`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
6551

66-
**Header RLP** `string`
52+
**Block** `string` *required*
6753

68-
hex encoded bytes
54+
`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
6955

70-
*Match pattern:* `^0x[0-9a-f]*$`
56+
*Allowed values:* `earliest` `finalized` `safe` `latest` `pending`
7157

7258
***
73-
</div>
59+
</details>
60+
</div>
61+
62+
## Result
7463

75-
<div>
76-
## Examples
64+
**Header RLP** `string`
7765

78-
<details>
79-
<summary>
80-
debug\_getRawHeader example
81-
</summary>
66+
hex encoded bytes
8267

83-
#### Request
68+
*Match pattern:* `^0x[0-9a-f]*$`
8469

85-
```json
86-
{
87-
"params": [
88-
"0x32026E"
89-
]
90-
}
91-
```
70+
***
9271

93-
#### Response
72+
## Examples
9473

95-
```json
96-
"0xf90236a09f73691f6dabca4f0a99b05d0a701995506aa311dcaa9ce9833d6f4ca474c162a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794c6e2459991bfe27cca6d86722f35da23a1e4cb97a078103ea8c47231886481d72ec1afae6eeb06c3773ce24a91323d5c9eed69d4cca0008992da2531db404f07b0871dd620a94ba346963e1b1c6dc7b00748e8593a1ea0b6c3890d9604434fc52f722848c84d1770add20cd75bbc28cdedff42940dbb56b90100200800000400000002000e0000000401000000440100000000c0400600000002000801000000040480020840048000000000400000000000000020004220000011002000000000000204000800000010010002000002000000000040a000000000000400020000010885000000000808000000008800001004002010020300005000000010002110410402000000000000000890000008000000000000000000020040000002000000000000810400000040006000004000004080020000000000000022001000000000000840400000000220250000000000080402000420000418000000000000000400040000004080040010200000000000108020020000808332026e8401c9c380833e3c3c846436f93899d883010b05846765746888676f312e32302e32856c696e7578a0112d8f15793e7df7f8dcdb21c891cff78c0d1839cb5b6dcd06116cdbb99536ae88000000000000000008a0cdb97712af6685bb9650d21d609525913293c48adda7c45990926daada335c9b"
97-
```
98-
</details>
99-
</div>
74+
<div>
75+
<details>
76+
<summary>
77+
debug\_getRawHeader example
78+
</summary>
79+
80+
#### Request
81+
82+
```json
83+
{
84+
"params": [
85+
"0x32026E"
86+
]
87+
}
88+
```
89+
90+
#### Response
91+
92+
```json
93+
"0xf90236a09f73691f6dabca4f0a99b05d0a701995506aa311dcaa9ce9833d6f4ca474c162a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794c6e2459991bfe27cca6d86722f35da23a1e4cb97a078103ea8c47231886481d72ec1afae6eeb06c3773ce24a91323d5c9eed69d4cca0008992da2531db404f07b0871dd620a94ba346963e1b1c6dc7b00748e8593a1ea0b6c3890d9604434fc52f722848c84d1770add20cd75bbc28cdedff42940dbb56b90100200800000400000002000e0000000401000000440100000000c0400600000002000801000000040480020840048000000000400000000000000020004220000011002000000000000204000800000010010002000002000000000040a000000000000400020000010885000000000808000000008800001004002010020300005000000010002110410402000000000000000890000008000000000000000000020040000002000000000000810400000040006000004000004080020000000000000022001000000000000840400000000220250000000000080402000420000418000000000000000400040000004080040010200000000000108020020000808332026e8401c9c380833e3c3c846436f93899d883010b05846765746888676f312e32302e32856c696e7578a0112d8f15793e7df7f8dcdb21c891cff78c0d1839cb5b6dcd06116cdbb99536ae88000000000000000008a0cdb97712af6685bb9650d21d609525913293c48adda7c45990926daada335c9b"
94+
```
95+
</details>
10096
</div>
10197
</TwoColumnLayout>

‎packages/example-site/docs/api-reference/methods/debug_getRawReceipts.mdx‎

Lines changed: 59 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -5,100 +5,96 @@ hide_table_of_contents: true
55
description: ""
66
---
77

8-
import {TwoColumnLayout, InteractiveRequest, ResponseExample} from 'open-rpc-docusaurus-plugin-beta/components';
8+
import {TwoColumnLayout, InteractiveRequest, ResponseExample} from '@open-rpc/docusaurus-plugin/components';
99
import { useState } from 'react';
1010

1111
<TwoColumnLayout sidebar={<InteractiveRequest request={"{\n \"jsonrpc\": \"2.0\",\n \"method\": \"debug_getRawReceipts\",\n \"params\": [\n \"0x32026E\"\n ],\n \"id\": 1\n}"} />}>
12-
<div>
13-
# debug\_getRawReceipts
14-
15-
12+
# debug\_getRawReceipts
1613

17-
Returns an array of EIP-2718 binary-encoded receipts.
1814

19-
<div>
20-
## Parameters (by position)
2115

22-
<div>
23-
**Block** `string or string` *required*
16+
Returns an array of EIP-2718 binary-encoded receipts.
2417

25-
***
18+
## Parameters (by position)
2619

27-
<details>
28-
<summary>
29-
Show Option 1 `Block number` string
30-
</summary>
20+
**Block** `string or string` *required*
3121

32-
#### `Block number` fields
22+
***
3323

34-
**Block** `string` *required*
24+
<div>
25+
<details>
26+
<summary>
27+
Show Option 1 `Block number` string
28+
</summary>
3529

36-
Block number
30+
#### `Block number` fields
3731

38-
*Match pattern:* `^0x(0|[1-9a-f][0-9a-f]*)$`
32+
**Block** `string` *required*
3933

40-
***
41-
</details>
34+
Block number
4235

43-
<details>
44-
<summary>
45-
Show Option 2 `Block tag` string
46-
</summary>
36+
*Match pattern:* `^0x(0|[1-9a-f][0-9a-f]*)$`
4737

48-
#### `Block tag` fields
38+
***
39+
</details>
40+
</div>
4941

50-
`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
42+
<div>
43+
<details>
44+
<summary>
45+
Show Option 2 `Block tag` string
46+
</summary>
5147

52-
**Block** `string` *required*
48+
#### `Block tag` fields
5349

54-
`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
50+
`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
5551

56-
*Allowed values:* `earliest` `finalized` `safe` `latest` `pending`
52+
**Block** `string` *required*
5753

58-
***
59-
</details>
60-
</div>
61-
</div>
54+
`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
6255

63-
<div>
64-
## Result
56+
*Allowed values:* `earliest` `finalized` `safe` `latest` `pending`
6557

66-
**Receipts** `array<string>`
58+
***
59+
</details>
60+
</div>
6761

68-
hex encoded bytes
62+
## Result
6963

70-
*Match pattern:* `^0x[0-9a-f]*$`
64+
**Receipts** `array<string>`
7165

72-
***
73-
</div>
66+
hex encoded bytes
7467

75-
<div>
76-
## Examples
68+
*Match pattern:* `^0x[0-9a-f]*$`
7769

78-
<details>
79-
<summary>
80-
debug\_getRawReceipts example
81-
</summary>
70+
***
8271

83-
#### Request
72+
## Examples
8473

85-
```json
86-
{
87-
"params": [
88-
"0x32026E"
89-
]
90-
}
91-
```
74+
<div>
75+
<details>
76+
<summary>
77+
debug\_getRawReceipts example
78+
</summary>
9279

93-
#### Response
80+
#### Request
9481

95-
```json
96-
[
97-
"0xf901a60182c70eb9010000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000002000000000000000000000008000000000000000000000000000000000040000000001000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000100000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000002000000000100000000000000000000000800000000000000000000000000000000000000000000000000000000000000000000020000000000000000f89df89b947753cfad258efbc52a9a1452e42ffbce9be486cbf863a0ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa00000000000000000000000000828d0386c1122e565f07dd28c7d1340ed5b3315a000000000000000000000000021849e99c31e3113a489d7eb0fd4d8c0edbe47afa00000000000000000000000000000000000000000000000000000000029b92700",
98-
"0xf901a70183018e1cb9010000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000002000000000000000000000008000000000000000000000000000000000040000000001000000000000000000000000000000000000000000000000010000000000000000000000000000000008000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000002000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000020000000000000000f89df89b947753cfad258efbc52a9a1452e42ffbce9be486cbf863a0ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa00000000000000000000000000828d0386c1122e565f07dd28c7d1340ed5b3315a000000000000000000000000069cda9d6cc6ce05982d0b4fdf9480f2991f39b5aa00000000000000000000000000000000000000000000000000000000029b92700"
82+
```json
83+
{
84+
"params": [
85+
"0x32026E"
9986
]
100-
```
101-
</details>
102-
</div>
87+
}
88+
```
89+
90+
#### Response
91+
92+
```json
93+
[
94+
"0xf901a60182c70eb9010000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000002000000000000000000000008000000000000000000000000000000000040000000001000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000100000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000002000000000100000000000000000000000800000000000000000000000000000000000000000000000000000000000000000000020000000000000000f89df89b947753cfad258efbc52a9a1452e42ffbce9be486cbf863a0ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa00000000000000000000000000828d0386c1122e565f07dd28c7d1340ed5b3315a000000000000000000000000021849e99c31e3113a489d7eb0fd4d8c0edbe47afa00000000000000000000000000000000000000000000000000000000029b92700",
95+
"0xf901a70183018e1cb9010000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000002000000000000000000000008000000000000000000000000000000000040000000001000000000000000000000000000000000000000000000000010000000000000000000000000000000008000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000002000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000020000000000000000f89df89b947753cfad258efbc52a9a1452e42ffbce9be486cbf863a0ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa00000000000000000000000000828d0386c1122e565f07dd28c7d1340ed5b3315a000000000000000000000000069cda9d6cc6ce05982d0b4fdf9480f2991f39b5aa00000000000000000000000000000000000000000000000000000000029b92700"
96+
]
97+
```
98+
</details>
10399
</div>
104100
</TwoColumnLayout>

0 commit comments

Comments
 (0)