Skip to content

Commit ec07ded

Browse files
masihmasih
committed
gen that doc 
1 parent 914f6e8 commit ec07ded

File tree

3 files changed

+140
-12
lines changed

3 files changed

+140
-12
lines changed

‎build/openrpc/v2/full.json‎

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,73 @@
7272
"schema": {
7373
"examples": [
7474
{
75-
"Cids": null,
76-
"Blocks": null,
77-
"Height": 0
75+
"Cids": [
76+
{
77+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
78+
}
79+
],
80+
"Blocks": [
81+
{
82+
"Miner": "f01938223",
83+
"Ticket": {
84+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
85+
},
86+
"ElectionProof": {
87+
"WinCount": 1,
88+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+"
89+
},
90+
"BeaconEntries": [
91+
{
92+
"Round": 17133822,
93+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j"
94+
},
95+
{
96+
"Round": 17133832,
97+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy"
98+
}
99+
],
100+
"WinPoStProof": [
101+
{
102+
"PoStProof": 3,
103+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
104+
}
105+
],
106+
"Parents": [
107+
{
108+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
109+
},
110+
{
111+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
112+
},
113+
{
114+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
115+
}
116+
],
117+
"ParentWeight": "116013147118",
118+
"Height": 4863283,
119+
"ParentStateRoot": {
120+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
121+
},
122+
"ParentMessageReceipts": {
123+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
124+
},
125+
"Messages": {
126+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
127+
},
128+
"BLSAggregate": {
129+
"Type": 2,
130+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y"
131+
},
132+
"Timestamp": 1744204890,
133+
"BlockSig": {
134+
"Type": 2,
135+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K"
136+
},
137+
"ForkSignaling": 0,
138+
"ParentBaseFee": "20592036"
139+
}
140+
],
141+
"Height": 4863283
78142
}
79143
],
80144
"additionalProperties": false,

‎documentation/en/api-v2-unstable-methods.md‎

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,73 @@ Inputs:
5959
Response:
6060
```json
6161
{
62-
"Cids": null,
63-
"Blocks": null,
64-
"Height": 0
62+
"Cids": [
63+
{
64+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
65+
}
66+
],
67+
"Blocks": [
68+
{
69+
"Miner": "f01938223",
70+
"Ticket": {
71+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
72+
},
73+
"ElectionProof": {
74+
"WinCount": 1,
75+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+"
76+
},
77+
"BeaconEntries": [
78+
{
79+
"Round": 17133822,
80+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j"
81+
},
82+
{
83+
"Round": 17133832,
84+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy"
85+
}
86+
],
87+
"WinPoStProof": [
88+
{
89+
"PoStProof": 3,
90+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
91+
}
92+
],
93+
"Parents": [
94+
{
95+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
96+
},
97+
{
98+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
99+
},
100+
{
101+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
102+
}
103+
],
104+
"ParentWeight": "116013147118",
105+
"Height": 4863283,
106+
"ParentStateRoot": {
107+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
108+
},
109+
"ParentMessageReceipts": {
110+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
111+
},
112+
"Messages": {
113+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
114+
},
115+
"BLSAggregate": {
116+
"Type": 2,
117+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y"
118+
},
119+
"Timestamp": 1744204890,
120+
"BlockSig": {
121+
"Type": 2,
122+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K"
123+
},
124+
"ForkSignaling": 0,
125+
"ParentBaseFee": "20592036"
126+
}
127+
],
128+
"Height": 4863283
65129
}
66130
```
67131

‎node/impl/full/state_v2.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,16 @@ func (s *StateModuleV2) StateGetID(ctx context.Context, addr address.Address, se
5353
return &id, nil
5454
}
5555

56-
func (a *StateModuleV2) StateCompute(ctx context.Context, msgs []*types.Message, selector types.TipSetSelector) (*api.ComputeStateOutput, error) {
57-
ts, err := a.Chain.ChainGetTipSet(ctx, selector)
56+
func (s *StateModuleV2) StateCompute(ctx context.Context, msgs []*types.Message, selector types.TipSetSelector) (*api.ComputeStateOutput, error) {
57+
ts, err := s.Chain.ChainGetTipSet(ctx, selector)
5858
if err != nil {
5959
return nil, xerrors.Errorf("selecting tipset: %w", err)
6060
}
6161

62-
return a.State.StateCompute(ctx, ts.Height(), msgs, ts.Key())
62+
return s.State.StateCompute(ctx, ts.Height(), msgs, ts.Key())
6363
}
6464

65-
func (a *StateModuleV2) StateSimulate(ctx context.Context, msgs []*types.Message, selector types.TipSetSelector, limit types.TipSetLimit) (*api.ComputeStateOutput, error) {
65+
func (s *StateModuleV2) StateSimulate(ctx context.Context, msgs []*types.Message, selector types.TipSetSelector, limit types.TipSetLimit) (*api.ComputeStateOutput, error) {
6666
if err := limit.Validate(); err != nil {
6767
return nil, xerrors.Errorf("validating tipset limit: %w", err)
6868
}
@@ -72,13 +72,13 @@ func (a *StateModuleV2) StateSimulate(ctx context.Context, msgs []*types.Message
7272
}
7373
// TODO: Add upper-bound limit to how far of simulation is acceptable?
7474

75-
ts, err := a.Chain.ChainGetTipSet(ctx, selector)
75+
ts, err := s.Chain.ChainGetTipSet(ctx, selector)
7676
if err != nil {
7777
return nil, xerrors.Errorf("selecting tipset: %w", err)
7878
}
7979
targetHeight := limit.HeightRelativeTo(ts.Height())
8080
if ts.Height() > targetHeight {
8181
return nil, xerrors.Errorf("tipset height %d is less than requested height at: %d", ts.Height(), limit)
8282
}
83-
return a.State.StateCompute(ctx, targetHeight, msgs, ts.Key())
83+
return s.State.StateCompute(ctx, targetHeight, msgs, ts.Key())
8484
}

0 commit comments

Comments
 (0)