feat(cli): add a list retrievals command
Currently, there is no way to inspect retrievals on a client. This adds said command, allow with corresponding APIs
This commit is contained in:
@@ -44,11 +44,13 @@
|
||||
* [ClientGetDealInfo](#ClientGetDealInfo)
|
||||
* [ClientGetDealStatus](#ClientGetDealStatus)
|
||||
* [ClientGetDealUpdates](#ClientGetDealUpdates)
|
||||
* [ClientGetRetrievalUpdates](#ClientGetRetrievalUpdates)
|
||||
* [ClientHasLocal](#ClientHasLocal)
|
||||
* [ClientImport](#ClientImport)
|
||||
* [ClientListDataTransfers](#ClientListDataTransfers)
|
||||
* [ClientListDeals](#ClientListDeals)
|
||||
* [ClientListImports](#ClientListImports)
|
||||
* [ClientListRetrievals](#ClientListRetrievals)
|
||||
* [ClientMinerQueryOffer](#ClientMinerQueryOffer)
|
||||
* [ClientQueryAsk](#ClientQueryAsk)
|
||||
* [ClientRemoveImport](#ClientRemoveImport)
|
||||
@@ -1199,6 +1201,54 @@ Response:
|
||||
}
|
||||
```
|
||||
|
||||
### ClientGetRetrievalUpdates
|
||||
ClientGetRetrievalUpdates returns status of updated retrieval deals
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response:
|
||||
```json
|
||||
{
|
||||
"PayloadCID": {
|
||||
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
||||
},
|
||||
"ID": 5,
|
||||
"PieceCID": null,
|
||||
"PricePerByte": "0",
|
||||
"UnsealPrice": "0",
|
||||
"Status": 0,
|
||||
"Message": "string value",
|
||||
"Provider": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
||||
"BytesReceived": 42,
|
||||
"BytesPaidFor": 42,
|
||||
"TotalPaid": "0",
|
||||
"TransferChannelID": {
|
||||
"Initiator": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
||||
"Responder": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
||||
"ID": 3
|
||||
},
|
||||
"DataTransfer": {
|
||||
"TransferID": 3,
|
||||
"Status": 1,
|
||||
"BaseCID": {
|
||||
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
||||
},
|
||||
"IsInitiator": true,
|
||||
"IsSender": true,
|
||||
"Voucher": "string value",
|
||||
"Message": "string value",
|
||||
"OtherPeer": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
||||
"Transferred": 42,
|
||||
"Stages": {
|
||||
"Stages": null
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### ClientHasLocal
|
||||
ClientHasLocal indicates whether a certain CID is locally stored.
|
||||
|
||||
@@ -1266,6 +1316,16 @@ Response: `null`
|
||||
ClientListImports lists imported files and their root CIDs
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `null`
|
||||
|
||||
### ClientListRetrievals
|
||||
ClientListRetrievals returns information about retrievals made by the local client
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
@@ -377,6 +377,7 @@ COMMANDS:
|
||||
find Find data in the network
|
||||
retrieve Retrieve data from network
|
||||
cancel-retrieval Cancel a retrieval deal by deal ID; this also cancels the associated transfer
|
||||
list-retrievals List retrieval market deals
|
||||
STORAGE:
|
||||
deal Initialize storage deal with a miner
|
||||
query-ask Find a miners ask
|
||||
@@ -521,6 +522,27 @@ OPTIONS:
|
||||
|
||||
```
|
||||
|
||||
### lotus client list-retrievals
|
||||
```
|
||||
NAME:
|
||||
lotus client list-retrievals - List retrieval market deals
|
||||
|
||||
USAGE:
|
||||
lotus client list-retrievals [command options] [arguments...]
|
||||
|
||||
CATEGORY:
|
||||
RETRIEVAL
|
||||
|
||||
OPTIONS:
|
||||
--verbose, -v print verbose deal details (default: false)
|
||||
--color use color in display output (default: true)
|
||||
--show-failed show failed/failing deals (default: false)
|
||||
--completed show completed retrievals (default: false)
|
||||
--watch watch deal updates in real-time, rather than a one time list (default: false)
|
||||
--help, -h show help (default: false)
|
||||
|
||||
```
|
||||
|
||||
### lotus client deal
|
||||
```
|
||||
NAME:
|
||||
|
||||
Reference in New Issue
Block a user