1
- ## Chain
1
+ # Chain
2
2
3
3
The Chain method group contains methods for interacting with the
4
4
blockchain, but that do not require any form of state computation.
5
5
6
- ### ChainBlockstoreInfo
6
+ ## ChainBlockstoreInfo
7
7
8
8
ChainBlockstoreInfo returns some basic information about the blockstore
9
9
@@ -19,7 +19,7 @@ Response:
19
19
}
20
20
```
21
21
22
- ### ChainCheckBlockstore
22
+ ## ChainCheckBlockstore
23
23
24
24
ChainCheckBlockstore performs an (asynchronous) health check on the chain/state blockstore
25
25
if supported by the underlying implementation.
@@ -30,7 +30,7 @@ Inputs: `null`
30
30
31
31
Response: ` {} `
32
32
33
- ### ChainDeleteObj
33
+ ## ChainDeleteObj
34
34
35
35
ChainDeleteObj deletes node referenced by the given CID
36
36
@@ -48,7 +48,7 @@ Inputs:
48
48
49
49
Response: ` {} `
50
50
51
- ### ChainExport
51
+ ## ChainExport
52
52
53
53
ChainExport returns a stream of bytes with CAR dump of chain data.
54
54
The exported chain data includes the header chain from the given tipset
@@ -77,7 +77,7 @@ Inputs:
77
77
78
78
Response: ` "Ynl0ZSBhcnJheQ==" `
79
79
80
- ### ChainExportRangeInternal
80
+ ## ChainExportRangeInternal
81
81
82
82
ChainExportRangeInternal triggers the export of a chain
83
83
CAR-snapshot directly to disk. It is similar to ChainExport,
@@ -122,7 +122,7 @@ Inputs:
122
122
123
123
Response: ` {} `
124
124
125
- ### ChainGetBlock
125
+ ## ChainGetBlock
126
126
127
127
ChainGetBlock returns the block specified by the given CID.
128
128
@@ -192,7 +192,7 @@ Response:
192
192
}
193
193
```
194
194
195
- ### ChainGetBlockMessages
195
+ ## ChainGetBlockMessages
196
196
197
197
ChainGetBlockMessages returns messages stored in the specified block.
198
198
@@ -274,7 +274,7 @@ Response:
274
274
}
275
275
```
276
276
277
- ### ChainGetEvents
277
+ ## ChainGetEvents
278
278
279
279
ChainGetEvents returns the events under an event AMT root CID.
280
280
@@ -308,7 +308,7 @@ Response:
308
308
]
309
309
```
310
310
311
- ### ChainGetGenesis
311
+ ## ChainGetGenesis
312
312
313
313
ChainGetGenesis returns the genesis tipset.
314
314
@@ -326,7 +326,7 @@ Response:
326
326
}
327
327
```
328
328
329
- ### ChainGetMessage
329
+ ## ChainGetMessage
330
330
331
331
ChainGetMessage reads a message referenced by the specified CID from the
332
332
chain blockstore.
@@ -363,7 +363,7 @@ Response:
363
363
}
364
364
```
365
365
366
- ### ChainGetMessagesInTipset
366
+ ## ChainGetMessagesInTipset
367
367
368
368
ChainGetMessagesInTipset returns message stores in current tipset
369
369
@@ -411,7 +411,7 @@ Response:
411
411
]
412
412
```
413
413
414
- ### ChainGetNode
414
+ ## ChainGetNode
415
415
416
416
Perms: read
417
417
@@ -432,7 +432,7 @@ Response:
432
432
}
433
433
```
434
434
435
- ### ChainGetParentMessages
435
+ ## ChainGetParentMessages
436
436
437
437
ChainGetParentMessages returns messages stored in parent tipset of the
438
438
specified block.
@@ -476,7 +476,7 @@ Response:
476
476
]
477
477
```
478
478
479
- ### ChainGetParentReceipts
479
+ ## ChainGetParentReceipts
480
480
481
481
ChainGetParentReceipts returns receipts for messages in parent tipset of
482
482
the specified block. The receipts in the list returned is one-to-one with the
@@ -509,7 +509,7 @@ Response:
509
509
]
510
510
```
511
511
512
- ### ChainGetPath
512
+ ## ChainGetPath
513
513
514
514
ChainGetPath returns a set of revert/apply operations needed to get from
515
515
one tipset to another, for example:
@@ -567,7 +567,7 @@ Response:
567
567
]
568
568
```
569
569
570
- ### ChainGetTipSet
570
+ ## ChainGetTipSet
571
571
572
572
ChainGetTipSet returns the tipset specified by the given TipSetKey.
573
573
@@ -598,7 +598,7 @@ Response:
598
598
}
599
599
```
600
600
601
- ### ChainGetTipSetAfterHeight
601
+ ## ChainGetTipSetAfterHeight
602
602
603
603
ChainGetTipSetAfterHeight looks back for a tipset at the specified epoch.
604
604
If there are no blocks at the specified epoch, the first non-nil tipset at a later epoch
@@ -632,7 +632,7 @@ Response:
632
632
}
633
633
```
634
634
635
- ### ChainGetTipSetByHeight
635
+ ## ChainGetTipSetByHeight
636
636
637
637
ChainGetTipSetByHeight looks back for a tipset at the specified epoch.
638
638
If there are no blocks at the specified epoch, a tipset at an earlier epoch
@@ -666,7 +666,7 @@ Response:
666
666
}
667
667
```
668
668
669
- ### ChainHasObj
669
+ ## ChainHasObj
670
670
671
671
ChainHasObj checks if a given CID exists in the chain blockstore.
672
672
@@ -684,7 +684,7 @@ Inputs:
684
684
685
685
Response: ` true `
686
686
687
- ### ChainHead
687
+ ## ChainHead
688
688
689
689
ChainHead returns the current head of the chain.
690
690
@@ -702,7 +702,7 @@ Response:
702
702
}
703
703
```
704
704
705
- ### ChainHotGC
705
+ ## ChainHotGC
706
706
707
707
ChainHotGC does online (badger) GC on the hot store; only supported if you are using
708
708
the splitstore
@@ -723,7 +723,7 @@ Inputs:
723
723
724
724
Response: ` {} `
725
725
726
- ### ChainNotify
726
+ ## ChainNotify
727
727
728
728
ChainNotify returns channel with chain head updates.
729
729
First message is guaranteed to be of len == 1, and type == 'current'.
@@ -747,7 +747,7 @@ Response:
747
747
]
748
748
```
749
749
750
- ### ChainPrune
750
+ ## ChainPrune
751
751
752
752
ChainPrune forces compaction on cold store and garbage collects; only supported if you
753
753
are using the splitstore
@@ -767,7 +767,7 @@ Inputs:
767
767
768
768
Response: ` {} `
769
769
770
- ### ChainPutObj
770
+ ## ChainPutObj
771
771
772
772
ChainPutObj puts a given object into the block store
773
773
@@ -781,7 +781,7 @@ Inputs:
781
781
782
782
Response: ` {} `
783
783
784
- ### ChainReadObj
784
+ ## ChainReadObj
785
785
786
786
ChainReadObj reads ipld nodes referenced by the specified CID from chain
787
787
blockstore and returns raw bytes.
@@ -800,7 +800,7 @@ Inputs:
800
800
801
801
Response: ` "Ynl0ZSBhcnJheQ==" `
802
802
803
- ### ChainSetHead
803
+ ## ChainSetHead
804
804
805
805
ChainSetHead forcefully sets current chain head. Use with caution.
806
806
@@ -823,7 +823,7 @@ Inputs:
823
823
824
824
Response: ` {} `
825
825
826
- ### ChainStatObj
826
+ ## ChainStatObj
827
827
828
828
ChainStatObj returns statistics about the graph referenced by 'obj'.
829
829
If 'base' is also specified, then the returned stat will be a diff
@@ -853,7 +853,7 @@ Response:
853
853
}
854
854
```
855
855
856
- ### ChainTipSetWeight
856
+ ## ChainTipSetWeight
857
857
858
858
ChainTipSetWeight computes weight for the specified tipset.
859
859
0 commit comments