Skip to content

Commit 9124ca1

Browse files
Reduces header level by one.
1 parent 9fbd511 commit 9124ca1

23 files changed

+316
-302
lines changed

reference/json-rpc/auth.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Auth
1+
# Auth
22

3-
### AuthNew
3+
## AuthNew
44

55
Perms: admin
66

@@ -12,7 +12,7 @@ Inputs:
1212

1313
Response: `"Ynl0ZSBhcnJheQ=="`
1414

15-
### AuthVerify
15+
## AuthVerify
1616

1717
Perms: read
1818

reference/json-rpc/chain.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## Chain
1+
# Chain
22

33
The Chain method group contains methods for interacting with the
44
blockchain, but that do not require any form of state computation.
55

6-
### ChainBlockstoreInfo
6+
## ChainBlockstoreInfo
77

88
ChainBlockstoreInfo returns some basic information about the blockstore
99

@@ -19,7 +19,7 @@ Response:
1919
}
2020
```
2121

22-
### ChainCheckBlockstore
22+
## ChainCheckBlockstore
2323

2424
ChainCheckBlockstore performs an (asynchronous) health check on the chain/state blockstore
2525
if supported by the underlying implementation.
@@ -30,7 +30,7 @@ Inputs: `null`
3030

3131
Response: `{}`
3232

33-
### ChainDeleteObj
33+
## ChainDeleteObj
3434

3535
ChainDeleteObj deletes node referenced by the given CID
3636

@@ -48,7 +48,7 @@ Inputs:
4848

4949
Response: `{}`
5050

51-
### ChainExport
51+
## ChainExport
5252

5353
ChainExport returns a stream of bytes with CAR dump of chain data.
5454
The exported chain data includes the header chain from the given tipset
@@ -77,7 +77,7 @@ Inputs:
7777

7878
Response: `"Ynl0ZSBhcnJheQ=="`
7979

80-
### ChainExportRangeInternal
80+
## ChainExportRangeInternal
8181

8282
ChainExportRangeInternal triggers the export of a chain
8383
CAR-snapshot directly to disk. It is similar to ChainExport,
@@ -122,7 +122,7 @@ Inputs:
122122

123123
Response: `{}`
124124

125-
### ChainGetBlock
125+
## ChainGetBlock
126126

127127
ChainGetBlock returns the block specified by the given CID.
128128

@@ -192,7 +192,7 @@ Response:
192192
}
193193
```
194194

195-
### ChainGetBlockMessages
195+
## ChainGetBlockMessages
196196

197197
ChainGetBlockMessages returns messages stored in the specified block.
198198

@@ -274,7 +274,7 @@ Response:
274274
}
275275
```
276276

277-
### ChainGetEvents
277+
## ChainGetEvents
278278

279279
ChainGetEvents returns the events under an event AMT root CID.
280280

@@ -308,7 +308,7 @@ Response:
308308
]
309309
```
310310

311-
### ChainGetGenesis
311+
## ChainGetGenesis
312312

313313
ChainGetGenesis returns the genesis tipset.
314314

@@ -326,7 +326,7 @@ Response:
326326
}
327327
```
328328

329-
### ChainGetMessage
329+
## ChainGetMessage
330330

331331
ChainGetMessage reads a message referenced by the specified CID from the
332332
chain blockstore.
@@ -363,7 +363,7 @@ Response:
363363
}
364364
```
365365

366-
### ChainGetMessagesInTipset
366+
## ChainGetMessagesInTipset
367367

368368
ChainGetMessagesInTipset returns message stores in current tipset
369369

@@ -411,7 +411,7 @@ Response:
411411
]
412412
```
413413

414-
### ChainGetNode
414+
## ChainGetNode
415415

416416
Perms: read
417417

@@ -432,7 +432,7 @@ Response:
432432
}
433433
```
434434

435-
### ChainGetParentMessages
435+
## ChainGetParentMessages
436436

437437
ChainGetParentMessages returns messages stored in parent tipset of the
438438
specified block.
@@ -476,7 +476,7 @@ Response:
476476
]
477477
```
478478

479-
### ChainGetParentReceipts
479+
## ChainGetParentReceipts
480480

481481
ChainGetParentReceipts returns receipts for messages in parent tipset of
482482
the specified block. The receipts in the list returned is one-to-one with the
@@ -509,7 +509,7 @@ Response:
509509
]
510510
```
511511

512-
### ChainGetPath
512+
## ChainGetPath
513513

514514
ChainGetPath returns a set of revert/apply operations needed to get from
515515
one tipset to another, for example:
@@ -567,7 +567,7 @@ Response:
567567
]
568568
```
569569

570-
### ChainGetTipSet
570+
## ChainGetTipSet
571571

572572
ChainGetTipSet returns the tipset specified by the given TipSetKey.
573573

@@ -598,7 +598,7 @@ Response:
598598
}
599599
```
600600

601-
### ChainGetTipSetAfterHeight
601+
## ChainGetTipSetAfterHeight
602602

603603
ChainGetTipSetAfterHeight looks back for a tipset at the specified epoch.
604604
If there are no blocks at the specified epoch, the first non-nil tipset at a later epoch
@@ -632,7 +632,7 @@ Response:
632632
}
633633
```
634634

635-
### ChainGetTipSetByHeight
635+
## ChainGetTipSetByHeight
636636

637637
ChainGetTipSetByHeight looks back for a tipset at the specified epoch.
638638
If there are no blocks at the specified epoch, a tipset at an earlier epoch
@@ -666,7 +666,7 @@ Response:
666666
}
667667
```
668668

669-
### ChainHasObj
669+
## ChainHasObj
670670

671671
ChainHasObj checks if a given CID exists in the chain blockstore.
672672

@@ -684,7 +684,7 @@ Inputs:
684684

685685
Response: `true`
686686

687-
### ChainHead
687+
## ChainHead
688688

689689
ChainHead returns the current head of the chain.
690690

@@ -702,7 +702,7 @@ Response:
702702
}
703703
```
704704

705-
### ChainHotGC
705+
## ChainHotGC
706706

707707
ChainHotGC does online (badger) GC on the hot store; only supported if you are using
708708
the splitstore
@@ -723,7 +723,7 @@ Inputs:
723723

724724
Response: `{}`
725725

726-
### ChainNotify
726+
## ChainNotify
727727

728728
ChainNotify returns channel with chain head updates.
729729
First message is guaranteed to be of len == 1, and type == 'current'.
@@ -747,7 +747,7 @@ Response:
747747
]
748748
```
749749

750-
### ChainPrune
750+
## ChainPrune
751751

752752
ChainPrune forces compaction on cold store and garbage collects; only supported if you
753753
are using the splitstore
@@ -767,7 +767,7 @@ Inputs:
767767

768768
Response: `{}`
769769

770-
### ChainPutObj
770+
## ChainPutObj
771771

772772
ChainPutObj puts a given object into the block store
773773

@@ -781,7 +781,7 @@ Inputs:
781781

782782
Response: `{}`
783783

784-
### ChainReadObj
784+
## ChainReadObj
785785

786786
ChainReadObj reads ipld nodes referenced by the specified CID from chain
787787
blockstore and returns raw bytes.
@@ -800,7 +800,7 @@ Inputs:
800800

801801
Response: `"Ynl0ZSBhcnJheQ=="`
802802

803-
### ChainSetHead
803+
## ChainSetHead
804804

805805
ChainSetHead forcefully sets current chain head. Use with caution.
806806

@@ -823,7 +823,7 @@ Inputs:
823823

824824
Response: `{}`
825825

826-
### ChainStatObj
826+
## ChainStatObj
827827

828828
ChainStatObj returns statistics about the graph referenced by 'obj'.
829829
If 'base' is also specified, then the returned stat will be a diff
@@ -853,7 +853,7 @@ Response:
853853
}
854854
```
855855

856-
### ChainTipSetWeight
856+
## ChainTipSetWeight
857857

858858
ChainTipSetWeight computes weight for the specified tipset.
859859

0 commit comments

Comments
 (0)