cerc-io/lotus
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

docsgen

Browse Source
This commit is contained in:
Łukasz Magiera 2020-09-17 17:31:09 +02:00
parent 6eda53565f
commit 68e884ee44
2 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api/docgen/docgen.go
View File

@ -114,6 +114,7 @@ func init() {
addExample(retrievalmarket.ClientEventDealAccepted) addExample(retrievalmarket.ClientEventDealAccepted)
addExample(retrievalmarket.DealStatusNew) addExample(retrievalmarket.DealStatusNew)
addExample(network.ReachabilityPublic) addExample(network.ReachabilityPublic)
addExample(build.NewestNetworkVersion)
addExample(&types.ExecutionTrace{ addExample(&types.ExecutionTrace{
Msg: exampleValue(reflect.TypeOf(&types.Message{}), nil).(*types.Message), Msg: exampleValue(reflect.TypeOf(&types.Message{}), nil).(*types.Message),
MsgRct: exampleValue(reflect.TypeOf(&types.MessageReceipt{}), nil).(*types.MessageReceipt), MsgRct: exampleValue(reflect.TypeOf(&types.MessageReceipt{}), nil).(*types.MessageReceipt),

35
documentation/en/api-methods.md
View File

@ -149,6 +149,7 @@
* [StateMinerSectorCount](#StateMinerSectorCount) * [StateMinerSectorCount](#StateMinerSectorCount)
* [StateMinerSectors](#StateMinerSectors) * [StateMinerSectors](#StateMinerSectors)
* [StateNetworkName](#StateNetworkName) * [StateNetworkName](#StateNetworkName)
* [StateNetworkVersion](#StateNetworkVersion)
* [StateReadState](#StateReadState) * [StateReadState](#StateReadState)
* [StateReplay](#StateReplay) * [StateReplay](#StateReplay)
* [StateSearchMsg](#StateSearchMsg) * [StateSearchMsg](#StateSearchMsg)
@ -211,7 +212,7 @@ Response:
```json ```json
{ {
"Version": "string value", "Version": "string value",
"APIVersion": 3584, "APIVersion": 3840,
"BlockDelay": 42 "BlockDelay": 42
} }
``` ```
@ -3509,7 +3510,7 @@ Inputs:
Response: `"0"` Response: `"0"`
### StateMinerPartitions ### StateMinerPartitions
StateMinerPartitions loads miner partitions for the specified miner/deadline StateMinerPartitions returns all partitions in the specified deadline
Perms: read Perms: read
@ -3563,7 +3564,8 @@ Response:
"TotalPower": { "TotalPower": {
"RawBytePower": "0", "RawBytePower": "0",
"QualityAdjPower": "0" "QualityAdjPower": "0"
} },
"HasMinPower": true
} }
``` ```
@ -3697,8 +3699,9 @@ Inputs:
Response: Response:
```json ```json
{ {
"Sectors": 42, "Live": 42,
"Active": 42 "Active": 42,
"Faulty": 42
} }
``` ```
@ -3741,6 +3744,28 @@ Inputs: `null`
Response: `"lotus"` Response: `"lotus"`
### StateNetworkVersion
StateNetworkVersion returns the network version at the given tipset
Perms: read
Inputs:
```json
[
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
]
```
Response: `2`
### StateReadState ### StateReadState
StateReadState returns the indicated actor's state. StateReadState returns the indicated actor's state.