Skip to content

Commit af13560

Browse files
authored
Add json-rpc docs for ChainGetFinalizedTipSet
Added documentation for ChainGetFinalizedTipSet API. This is a copy/paste from https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-methods-v1-stable.md#ChainGetFinalizedTipSet
1 parent 67e562e commit af13560

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

reference/json-rpc/chain.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,92 @@ Response:
290290
]
291291
```
292292

293+
## ChainGetFinalizedTipSet
294+
ChainGetFinalizedTipSet returns the latest finalized tipset. It uses the
295+
current F3 instance to determine the finalized tipset.
296+
This is the tipset at the end of the last finalized round and can be used
297+
for follow-up querying of the chain state with the assurance that the
298+
state will not change.
299+
If F3 is operational and finalizing in this node. If not, it will fall back
300+
to the Expected Consensus (EC) finality definition of head - 900 epochs.
301+
302+
Perms: read
303+
304+
Inputs: `null`
305+
306+
Response:
307+
```json
308+
{
309+
"Cids": [
310+
{
311+
"/": "bafy2bzacedo7hjsumaajt6sbor42qycvjyk6goqe4oi4o4ddsjxkdeqrqf42c"
312+
}
313+
],
314+
"Blocks": [
315+
{
316+
"Miner": "f01938223",
317+
"Ticket": {
318+
"VRFProof": "rIPyBy+F827Szc5oN/6ylCmpzxfAWr7aI5F4YJrN4pLSyknkcJI3ivsCo2KKjQVZFRnFyEus1maD5LdzQpnFRKMla4138qEuML+Ne/fsgOMrUEAeL34ceVwJd+Mt4Jrz"
319+
},
320+
"ElectionProof": {
321+
"WinCount": 1,
322+
"VRFProof": "sN51JqjZNf+xWxwoo+wlMH1bpXI9T3wUIrla6FpwTxU4jC1z+ab5NFU/B2ZdDITTE+u8qaiibtLkld5lhNcOEOUqwKNyJ4nwFo5vAhWqvOTNdOiZmxsKpWG0NZUoXb/+"
323+
},
324+
"BeaconEntries": [
325+
{
326+
"Round": 17133822,
327+
"Data": "tH4q8euIaP9/QRJt8ALfkBvttSmQ/DOAt8+37wGGV5f8kkhzEFrHhskitNnPS70j"
328+
},
329+
{
330+
"Round": 17133832,
331+
"Data": "uQD5cEn8U69+sPjpccT8Bm0jVrnXLScf2jBkLJNHvAHLA6tPsZDREzpBIckpVvPy"
332+
}
333+
],
334+
"WinPoStProof": [
335+
{
336+
"PoStProof": 3,
337+
"ProofBytes": "qOPLMhMui8qm/rE2y/UceyBDv5JvRCH5Fc5Ul+kuN190XDcMme5eKURUCmE2sN1HoQ2dMZX+xNZY351dbG93H/tUr6wuNhkvmemi2Xi62YvqU36/kJh+K2YBiW7h/4LXCUTP/6XAOONOPl+j9GqS7RQxruPLfIyehvzVC0C8dB8+SVWtAnRKRPUUOPJvyHKejlrCyzWXOz/I7JG2/qEGLD0xwazBVwML1vVvuE5NzXeOoQGlnB2PwSRb5Cn8FH8Q"
338+
}
339+
],
340+
"Parents": [
341+
{
342+
"/": "bafy2bzaceba2kdmysmi5ieugzvv5np7f2lobayzpvtk777du74n7jq6xhynda"
343+
},
344+
{
345+
"/": "bafy2bzacecrye24tkqrvvddcf62gfi4z4o33z2tdedbpaalordozaxfrz2jyi"
346+
},
347+
{
348+
"/": "bafy2bzaceab5mrohjvnp3mz7mo33ky7qqlmssrs7veqmjrgouafxyhnd5dy66"
349+
}
350+
],
351+
"ParentWeight": "116013147118",
352+
"Height": 4863283,
353+
"ParentStateRoot": {
354+
"/": "bafy2bzaceajxzsvzuq3ddzxfrs2jlaxsooqmgdy5uxbqujnjy3y56iumzzy7u"
355+
},
356+
"ParentMessageReceipts": {
357+
"/": "bafy2bzacecfcx2ykqucyv3gkyrcy3upwrvdraz3ktfg7phkqysefdwsggglac"
358+
},
359+
"Messages": {
360+
"/": "bafy2bzacebzofmh6migvc4v6qsme6vuxlhi6pv2ocy4apyic3uihjqm7dum3u"
361+
},
362+
"BLSAggregate": {
363+
"Type": 2,
364+
"Data": "krFATGA0OBu/kFwtXsThVtKCkppnU7045uTURCeiOeJttxuXfx3wqJrLkCytnJFWFLVC+tiVWI4BxC3wqc9r6eAlNr9dEBx+3KwML/RFG/b5grmknLpGWn7g1EB/2T4y"
365+
},
366+
"Timestamp": 1744204890,
367+
"BlockSig": {
368+
"Type": 2,
369+
"Data": "pWiUr+M8xxTxLED7GuU586gSfZCaHyLbLj0uS0HhKYRtHuyG47fIrfIT/04OCmQvEXBD8pFraWbMc3tnFrSsM1mIBJ5M38UPUfXDSspo+QGdouo2kll2X+VNKY3ajb1K"
370+
},
371+
"ForkSignaling": 0,
372+
"ParentBaseFee": "20592036"
373+
}
374+
],
375+
"Height": 4863283
376+
}
377+
```
378+
293379
## ChainGetGenesis
294380

295381
ChainGetGenesis returns the genesis tipset.

0 commit comments

Comments
 (0)