add api and cli calls for beneficiary withdrawl

This commit is contained in:
Geoff Stuart
2022-09-14 12:26:35 -04:00
parent c791fe34b9
commit 21906b5a63
15 changed files with 124 additions and 9 deletions
+27
View File
@@ -13,6 +13,8 @@
* [Auth](#Auth)
* [AuthNew](#AuthNew)
* [AuthVerify](#AuthVerify)
* [Beneficiary](#Beneficiary)
* [BeneficiaryWithdrawBalance](#BeneficiaryWithdrawBalance)
* [Check](#Check)
* [CheckProvable](#CheckProvable)
* [Compute](#Compute)
@@ -364,6 +366,31 @@ Response:
]
```
## Beneficiary
### BeneficiaryWithdrawBalance
BeneficiaryWithdrawBalance allows the beneficiary of a miner to withdraw balance from miner actor
Specify amount as "0" to withdraw full balance. This method returns a message CID
and does not wait for message execution
Perms: admin
Inputs:
```json
[
"0"
]
```
Response:
```json
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
```
## Check
+14 -1
View File
@@ -5811,7 +5811,20 @@ Response:
"WindowPoStProofType": 8,
"SectorSize": 34359738368,
"WindowPoStPartitionSectors": 42,
"ConsensusFaultElapsed": 10101
"ConsensusFaultElapsed": 10101,
"Beneficiary": "f01234",
"BeneficiaryTerm": {
"Quota": "0",
"UsedQuota": "0",
"Expiration": 10101
},
"PendingBeneficiaryTerm": {
"NewBeneficiary": "f01234",
"NewQuota": "0",
"NewExpiration": 10101,
"ApprovedByBeneficiary": true,
"ApprovedByNominee": true
}
}
```
+14 -1
View File
@@ -6328,7 +6328,20 @@ Response:
"WindowPoStProofType": 8,
"SectorSize": 34359738368,
"WindowPoStPartitionSectors": 42,
"ConsensusFaultElapsed": 10101
"ConsensusFaultElapsed": 10101,
"Beneficiary": "f01234",
"BeneficiaryTerm": {
"Quota": "0",
"UsedQuota": "0",
"Expiration": 10101
},
"PendingBeneficiaryTerm": {
"NewBeneficiary": "f01234",
"NewQuota": "0",
"NewExpiration": 10101,
"ApprovedByBeneficiary": true,
"ApprovedByNominee": true
}
}
```
+3 -2
View File
@@ -232,7 +232,7 @@ USAGE:
COMMANDS:
set-addresses, set-addrs set addresses that your miner can be publicly dialed on
withdraw withdraw available balance
withdraw withdraw available balance to beneficiary
repay-debt pay down a miner's debt
set-peer-id set the peer id of your miner
set-owner Set owner address (this command should be invoked twice, first with the old owner as the senderAddress, and then with the new owner)
@@ -254,12 +254,13 @@ OPTIONS:
### lotus-miner actor withdraw
```
NAME:
lotus-miner actor withdraw - withdraw available balance
lotus-miner actor withdraw - withdraw available balance to beneficiary
USAGE:
lotus-miner actor withdraw [command options] [amount (FIL)]
OPTIONS:
--beneficiary send withdraw message from the beneficiary address (default: false)
--confidence value number of block confirmations to wait for (default: 5)
```