Skip to content

Commit 6f09aca

Browse files
KubuxuKubuxu
authored
docs: add tipset sample in api docs (#13021)
Signed-off-by: Jakub Sztandera <[email protected]>
1 parent b601b8b commit 6f09aca

File tree

8 files changed

+2291
-99
lines changed

8 files changed

+2291
-99
lines changed

‎api/docgen/docgen.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package docgen
22

33
import (
4+
_ "embed"
45
"encoding/json"
56
"fmt"
67
"go/ast"
@@ -89,6 +90,13 @@ func init() {
8990
ExampleValues[reflect.TypeOf(addr)] = addr
9091
ExampleValues[reflect.TypeOf(&addr)] = &addr
9192

93+
var ts types.TipSet
94+
err = json.Unmarshal(tipsetSampleJson, &ts)
95+
if err != nil {
96+
panic(err)
97+
}
98+
addExample(&ts)
99+
92100
pid, err := peer.Decode("12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf")
93101
if err != nil {
94102
panic(err)
@@ -828,3 +836,6 @@ func MethodGroupFromName(mn string) string {
828836
}
829837
return mn[:i+1]
830838
}
839+
840+
//go:embed tipset.json
841+
var tipsetSampleJson []byte

‎api/docgen/tipset.json

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
"Blocks": [
3+
{
4+
"BLSAggregate": {
5+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y",
6+
"Type": 2
7+
},
8+
"BeaconEntries": [
9+
{
10+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j",
11+
"Round": 17133822
12+
},
13+
{
14+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy",
15+
"Round": 17133832
16+
}
17+
],
18+
"BlockSig": {
19+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K",
20+
"Type": 2
21+
},
22+
"ElectionProof": {
23+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+",
24+
"WinCount": 1
25+
},
26+
"ForkSignaling": 0,
27+
"Height": 4863283,
28+
"Messages": {
29+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
30+
},
31+
"Miner": "f01938223",
32+
"ParentBaseFee": "20592036",
33+
"ParentMessageReceipts": {
34+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
35+
},
36+
"ParentStateRoot": {
37+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
38+
},
39+
"ParentWeight": "116013147118",
40+
"Parents": [
41+
{
42+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
43+
},
44+
{
45+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
46+
},
47+
{
48+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
49+
}
50+
],
51+
"Ticket": {
52+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
53+
},
54+
"Timestamp": 1744204890,
55+
"WinPoStProof": [
56+
{
57+
"PoStProof": 3,
58+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
59+
}
60+
]
61+
}
62+
],
63+
"Cids": [
64+
{
65+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
66+
}
67+
],
68+
"Height": 4863283
69+
}

‎build/openrpc/full.json

Lines changed: 536 additions & 24 deletions
Large diffs are not rendered by default.

‎build/openrpc/gateway.json

Lines changed: 402 additions & 18 deletions
Large diffs are not rendered by default.

‎build/openrpc/miner.json

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -929,9 +929,73 @@
929929
"schema": {
930930
"examples": [
931931
{
932-
"Cids": null,
933-
"Blocks": null,
934-
"Height": 0
932+
"Cids": [
933+
{
934+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
935+
}
936+
],
937+
"Blocks": [
938+
{
939+
"Miner": "f01938223",
940+
"Ticket": {
941+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
942+
},
943+
"ElectionProof": {
944+
"WinCount": 1,
945+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+"
946+
},
947+
"BeaconEntries": [
948+
{
949+
"Round": 17133822,
950+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j"
951+
},
952+
{
953+
"Round": 17133832,
954+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy"
955+
}
956+
],
957+
"WinPoStProof": [
958+
{
959+
"PoStProof": 3,
960+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
961+
}
962+
],
963+
"Parents": [
964+
{
965+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
966+
},
967+
{
968+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
969+
},
970+
{
971+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
972+
}
973+
],
974+
"ParentWeight": "116013147118",
975+
"Height": 4863283,
976+
"ParentStateRoot": {
977+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
978+
},
979+
"ParentMessageReceipts": {
980+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
981+
},
982+
"Messages": {
983+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
984+
},
985+
"BLSAggregate": {
986+
"Type": 2,
987+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y"
988+
},
989+
"Timestamp": 1744204890,
990+
"BlockSig": {
991+
"Type": 2,
992+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K"
993+
},
994+
"ForkSignaling": 0,
995+
"ParentBaseFee": "20592036"
996+
}
997+
],
998+
"Height": 4863283
935999
}
9361000
],
9371001
"additionalProperties": false,

‎documentation/en/api-v0-methods-miner.md

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -596,9 +596,73 @@ Inputs: `null`
596596
Response:
597597
```json
598598
{
599-
"Cids": null,
600-
"Blocks": null,
601-
"Height": 0
599+
"Cids": [
600+
{
601+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
602+
}
603+
],
604+
"Blocks": [
605+
{
606+
"Miner": "f01938223",
607+
"Ticket": {
608+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
609+
},
610+
"ElectionProof": {
611+
"WinCount": 1,
612+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+"
613+
},
614+
"BeaconEntries": [
615+
{
616+
"Round": 17133822,
617+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j"
618+
},
619+
{
620+
"Round": 17133832,
621+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy"
622+
}
623+
],
624+
"WinPoStProof": [
625+
{
626+
"PoStProof": 3,
627+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
628+
}
629+
],
630+
"Parents": [
631+
{
632+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
633+
},
634+
{
635+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
636+
},
637+
{
638+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
639+
}
640+
],
641+
"ParentWeight": "116013147118",
642+
"Height": 4863283,
643+
"ParentStateRoot": {
644+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
645+
},
646+
"ParentMessageReceipts": {
647+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
648+
},
649+
"Messages": {
650+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
651+
},
652+
"BLSAggregate": {
653+
"Type": 2,
654+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y"
655+
},
656+
"Timestamp": 1744204890,
657+
"BlockSig": {
658+
"Type": 2,
659+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K"
660+
},
661+
"ForkSignaling": 0,
662+
"ParentBaseFee": "20592036"
663+
}
664+
],
665+
"Height": 4863283
602666
}
603667
```
604668

0 commit comments

Comments
 (0)