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

docs gen; also fixes lack of *cid.Cid examples elsewhere.

Browse Source
This commit is contained in:
Raúl Kripalani 2022-11-11 20:20:28 +00:00
parent 17ea9f520a
commit 9c5d888ec9
7 changed files with 259 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api/docgen/docgen.go
View File

@ -68,6 +68,7 @@ func init() {
} }
ExampleValues[reflect.TypeOf(c)] = c ExampleValues[reflect.TypeOf(c)] = c
ExampleValues[reflect.TypeOf(&c)] = &c
c2, err := cid.Decode("bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve") c2, err := cid.Decode("bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve")
if err != nil { if err != nil {

BIN
build/openrpc/full.json.gz
View File

Binary file not shown.

BIN
build/openrpc/gateway.json.gz
View File

Binary file not shown.

BIN
build/openrpc/miner.json.gz
View File

Binary file not shown.

103
documentation/en/api-v0-methods-miner.md
View File

@ -465,7 +465,9 @@ Inputs:
{ {
"SealProof": 8, "SealProof": 8,
"SectorNumber": 9, "SectorNumber": 9,
"SectorKey": null, "SectorKey": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SealedCID": { "SealedCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} }
@ -1280,8 +1282,12 @@ Response:
"ProposalCid": { "ProposalCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"AddFundsCid": null, "AddFundsCid": {
"PublishCid": null, "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PublishCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"State": 42, "State": 42,
@ -1296,7 +1302,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1458,8 +1466,12 @@ Response:
"ProposalCid": { "ProposalCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"AddFundsCid": null, "AddFundsCid": {
"PublishCid": null, "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PublishCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"State": 42, "State": 42,
@ -1474,7 +1486,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1510,7 +1524,9 @@ Response:
"Selector": { "Selector": {
"Raw": "Ynl0ZSBhcnJheQ==" "Raw": "Ynl0ZSBhcnJheQ=="
}, },
"PieceCID": null, "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerByte": "0", "PricePerByte": "0",
"PaymentInterval": 42, "PaymentInterval": 42,
"PaymentIntervalIncrease": 42, "PaymentIntervalIncrease": 42,
@ -2909,7 +2925,9 @@ Inputs:
1024, 1024,
{}, {},
{ {
"PublishCid": null, "PublishCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DealID": 5432, "DealID": 5432,
"DealProposal": { "DealProposal": {
"PieceCID": { "PieceCID": {
@ -2963,7 +2981,9 @@ Response:
"FailedSectors": { "FailedSectors": {
"123": "can't acquire read lock" "123": "can't acquire read lock"
}, },
"Msg": null, "Msg": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Error": "string value" "Error": "string value"
} }
] ]
@ -3157,7 +3177,9 @@ Response:
123, 123,
124 124
], ],
"Msg": null, "Msg": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Error": "string value" "Error": "string value"
} }
] ]
@ -3205,7 +3227,9 @@ Inputs:
} }
}, },
"DealInfo": { "DealInfo": {
"PublishCid": null, "PublishCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DealID": 5432, "DealID": 5432,
"DealProposal": { "DealProposal": {
"PieceCID": { "PieceCID": {
@ -3233,8 +3257,12 @@ Inputs:
"TicketValue": "Bw==", "TicketValue": "Bw==",
"TicketEpoch": 10101, "TicketEpoch": 10101,
"PreCommit1Out": "Bw==", "PreCommit1Out": "Bw==",
"CommD": null, "CommD": {
"CommR": null, "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"CommR": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PreCommitInfo": { "PreCommitInfo": {
"SealProof": 8, "SealProof": 8,
"SectorNumber": 9, "SectorNumber": 9,
@ -3246,10 +3274,14 @@ Inputs:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
"PreCommitDeposit": "0", "PreCommitDeposit": "0",
"PreCommitMessage": null, "PreCommitMessage": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PreCommitTipSet": [ "PreCommitTipSet": [
{ {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
@ -3261,7 +3293,9 @@ Inputs:
"SeedValue": "Bw==", "SeedValue": "Bw==",
"SeedEpoch": 10101, "SeedEpoch": 10101,
"CommitProof": "Ynl0ZSBhcnJheQ==", "CommitProof": "Ynl0ZSBhcnJheQ==",
"CommitMessage": null, "CommitMessage": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Log": [ "Log": [
{ {
"Kind": "string value", "Kind": "string value",
@ -3397,7 +3431,12 @@ Perms: admin
Inputs: `null` Inputs: `null`
Response: `null` Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
### SectorTerminatePending ### SectorTerminatePending
SectorTerminatePending returns a list of pending sector terminations to be sent in the next batch message SectorTerminatePending returns a list of pending sector terminations to be sent in the next batch message
@ -3498,8 +3537,12 @@ Response:
{ {
"SectorID": 9, "SectorID": 9,
"State": "Proving", "State": "Proving",
"CommD": null, "CommD": {
"CommR": null, "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"CommR": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Proof": "Ynl0ZSBhcnJheQ==", "Proof": "Ynl0ZSBhcnJheQ==",
"Deals": [ "Deals": [
5432 5432
@ -3513,7 +3556,9 @@ Response:
} }
}, },
"DealInfo": { "DealInfo": {
"PublishCid": null, "PublishCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DealID": 5432, "DealID": 5432,
"DealProposal": { "DealProposal": {
"PieceCID": { "PieceCID": {
@ -3546,11 +3591,17 @@ Response:
"Value": "Bw==", "Value": "Bw==",
"Epoch": 10101 "Epoch": 10101
}, },
"PreCommitMsg": null, "PreCommitMsg": {
"CommitMsg": null, "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"CommitMsg": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Retries": 42, "Retries": 42,
"ToUpgrade": true, "ToUpgrade": true,
"ReplicaUpdateMessage": null, "ReplicaUpdateMessage": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"LastErr": "string value", "LastErr": "string value",
"Log": [ "Log": [
{ {
@ -3604,7 +3655,9 @@ Inputs:
1040384, 1040384,
1024, 1024,
"Bw==", "Bw==",
null {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
] ]
``` ```

122
documentation/en/api-v0-methods.md
View File

@ -1250,7 +1250,9 @@ Inputs:
{ {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
null {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
] ]
``` ```
@ -1262,7 +1264,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 42, "Size": 42,
"MinPrice": "0", "MinPrice": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
@ -1273,7 +1277,9 @@ Response:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
} }
] ]
@ -1344,7 +1350,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1448,7 +1456,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1513,7 +1523,9 @@ Response:
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"ID": 5, "ID": 5,
"PieceCID": null, "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerByte": "0", "PricePerByte": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
"Status": 0, "Status": 0,
@ -1686,7 +1698,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1751,7 +1765,9 @@ Response:
{ {
"Key": 50, "Key": 50,
"Err": "string value", "Err": "string value",
"Root": null, "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Source": "string value", "Source": "string value",
"FilePath": "string value", "FilePath": "string value",
"CARPath": "string value" "CARPath": "string value"
@ -1776,7 +1792,9 @@ Response:
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"ID": 5, "ID": 5,
"PieceCID": null, "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerByte": "0", "PricePerByte": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
"Status": 0, "Status": 0,
@ -1837,7 +1855,9 @@ Inputs:
{ {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
null {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
] ]
``` ```
@ -1848,7 +1868,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 42, "Size": 42,
"MinPrice": "0", "MinPrice": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
@ -1859,7 +1881,9 @@ Response:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
} }
``` ```
@ -1936,7 +1960,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DatamodelPathSelector": "Links/21/Hash/Links/42/Hash", "DatamodelPathSelector": "Links/21/Hash/Links/42/Hash",
"Size": 42, "Size": 42,
"FromLocalCAR": "string value", "FromLocalCAR": "string value",
@ -1949,7 +1975,9 @@ Inputs:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
}, },
{ {
@ -1991,7 +2019,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DatamodelPathSelector": "Links/21/Hash/Links/42/Hash", "DatamodelPathSelector": "Links/21/Hash/Links/42/Hash",
"Size": 42, "Size": 42,
"FromLocalCAR": "string value", "FromLocalCAR": "string value",
@ -2004,7 +2034,9 @@ Inputs:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
}, },
{ {
@ -2040,7 +2072,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -2056,7 +2090,12 @@ Inputs:
] ]
``` ```
Response: `null` Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
### ClientStatelessDeal ### ClientStatelessDeal
ClientStatelessDeal fire-and-forget-proposes an offline deal to a miner without subsequent tracking. ClientStatelessDeal fire-and-forget-proposes an offline deal to a miner without subsequent tracking.
@ -2073,7 +2112,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -2089,7 +2130,12 @@ Inputs:
] ]
``` ```
Response: `null` Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
## Create ## Create
@ -2616,7 +2662,9 @@ Response:
{ {
"SealProof": 8, "SealProof": 8,
"SectorNumber": 9, "SectorNumber": 9,
"SectorKey": null, "SectorKey": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SealedCID": { "SealedCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} }
@ -4159,7 +4207,9 @@ Response:
"PendingAmt": "0", "PendingAmt": "0",
"NonReservedAmt": "0", "NonReservedAmt": "0",
"PendingAvailableAmt": "0", "PendingAvailableAmt": "0",
"PendingWaitSentinel": null, "PendingWaitSentinel": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"QueuedAmt": "0", "QueuedAmt": "0",
"VoucherReedeemedAmt": "0" "VoucherReedeemedAmt": "0"
} }
@ -4188,7 +4238,9 @@ Response:
"PendingAmt": "0", "PendingAmt": "0",
"NonReservedAmt": "0", "NonReservedAmt": "0",
"PendingAvailableAmt": "0", "PendingAvailableAmt": "0",
"PendingWaitSentinel": null, "PendingWaitSentinel": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"QueuedAmt": "0", "QueuedAmt": "0",
"VoucherReedeemedAmt": "0" "VoucherReedeemedAmt": "0"
} }
@ -5888,7 +5940,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
] ]
@ -6056,7 +6110,9 @@ Inputs:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
[ [
{ {
@ -6178,7 +6234,9 @@ Inputs:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
[ [
{ {
@ -6361,7 +6419,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
] ]
@ -6800,7 +6860,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
``` ```
@ -6871,7 +6933,9 @@ Response:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
"PreCommitDeposit": "0", "PreCommitDeposit": "0",
"PreCommitEpoch": 10101 "PreCommitEpoch": 10101

114
documentation/en/api-v1-unstable-methods.md
View File

@ -1316,7 +1316,9 @@ Inputs:
{ {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
null {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
] ]
``` ```
@ -1328,7 +1330,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 42, "Size": 42,
"MinPrice": "0", "MinPrice": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
@ -1339,7 +1343,9 @@ Response:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
} }
] ]
@ -1410,7 +1416,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1514,7 +1522,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1579,7 +1589,9 @@ Response:
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"ID": 5, "ID": 5,
"PieceCID": null, "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerByte": "0", "PricePerByte": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
"Status": 0, "Status": 0,
@ -1752,7 +1764,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -1817,7 +1831,9 @@ Response:
{ {
"Key": 50, "Key": 50,
"Err": "string value", "Err": "string value",
"Root": null, "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Source": "string value", "Source": "string value",
"FilePath": "string value", "FilePath": "string value",
"CARPath": "string value" "CARPath": "string value"
@ -1841,7 +1857,9 @@ Response:
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"ID": 5, "ID": 5,
"PieceCID": null, "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerByte": "0", "PricePerByte": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
"Status": 0, "Status": 0,
@ -1902,7 +1920,9 @@ Inputs:
{ {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
null {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
] ]
``` ```
@ -1913,7 +1933,9 @@ Response:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 42, "Size": 42,
"MinPrice": "0", "MinPrice": "0",
"UnsealPrice": "0", "UnsealPrice": "0",
@ -1924,7 +1946,9 @@ Response:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
} }
``` ```
@ -2007,7 +2031,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"Piece": null, "Piece": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"DataSelector": "Links/21/Hash/Links/42/Hash", "DataSelector": "Links/21/Hash/Links/42/Hash",
"Size": 42, "Size": 42,
"Total": "0", "Total": "0",
@ -2019,7 +2045,9 @@ Inputs:
"MinerPeer": { "MinerPeer": {
"Address": "f01234", "Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null "PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
} }
} }
] ]
@ -2078,7 +2106,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -2094,7 +2124,12 @@ Inputs:
] ]
``` ```
Response: `null` Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
### ClientStatelessDeal ### ClientStatelessDeal
ClientStatelessDeal fire-and-forget-proposes an offline deal to a miner without subsequent tracking. ClientStatelessDeal fire-and-forget-proposes an offline deal to a miner without subsequent tracking.
@ -2111,7 +2146,9 @@ Inputs:
"Root": { "Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}, },
"PieceCid": null, "PieceCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1024, "PieceSize": 1024,
"RawBlockSize": 42 "RawBlockSize": 42
}, },
@ -2127,7 +2164,12 @@ Inputs:
] ]
``` ```
Response: `null` Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
## Create ## Create
@ -3124,7 +3166,9 @@ Response:
{ {
"SealProof": 8, "SealProof": 8,
"SectorNumber": 9, "SectorNumber": 9,
"SectorKey": null, "SectorKey": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SealedCID": { "SealedCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} }
@ -5068,7 +5112,9 @@ Response:
"PendingAmt": "0", "PendingAmt": "0",
"NonReservedAmt": "0", "NonReservedAmt": "0",
"PendingAvailableAmt": "0", "PendingAvailableAmt": "0",
"PendingWaitSentinel": null, "PendingWaitSentinel": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"QueuedAmt": "0", "QueuedAmt": "0",
"VoucherReedeemedAmt": "0" "VoucherReedeemedAmt": "0"
} }
@ -5097,7 +5143,9 @@ Response:
"PendingAmt": "0", "PendingAmt": "0",
"NonReservedAmt": "0", "NonReservedAmt": "0",
"PendingAvailableAmt": "0", "PendingAvailableAmt": "0",
"PendingWaitSentinel": null, "PendingWaitSentinel": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"QueuedAmt": "0", "QueuedAmt": "0",
"VoucherReedeemedAmt": "0" "VoucherReedeemedAmt": "0"
} }
@ -6888,7 +6936,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
] ]
@ -7084,7 +7134,9 @@ Inputs:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
[ [
{ {
@ -7206,7 +7258,9 @@ Inputs:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
[ [
{ {
@ -7389,7 +7443,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
] ]
@ -7782,7 +7838,9 @@ Response:
"ExpectedStoragePledge": "0", "ExpectedStoragePledge": "0",
"ReplacedSectorAge": 10101, "ReplacedSectorAge": 10101,
"ReplacedDayReward": "0", "ReplacedDayReward": "0",
"SectorKeyCID": null, "SectorKeyCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"SimpleQAPower": true "SimpleQAPower": true
} }
``` ```
@ -7858,7 +7916,9 @@ Response:
5432 5432
], ],
"Expiration": 10101, "Expiration": 10101,
"UnsealedCid": null "UnsealedCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}, },
"PreCommitDeposit": "0", "PreCommitDeposit": "0",
"PreCommitEpoch": 10101 "PreCommitEpoch": 10101