Vergara_Tech/zenith
Vergara_Tech/zenith
2
0
Fork 0
Code Issues 24 Pull requests Projects Releases 8 Packages Wiki Activity

docs(rpc): update the deshieldfunds method

Browse source
This commit is contained in:
Rene Vergara 2024-12-20 09:11:09 -06:00
parent b1cc8a4116
commit 9226dea598
Signed by: pitmutt
SSH key fingerprint: SHA256:vNa8FIqbBZjV9hOCkXyOzd7gqWCMCfkcfiPH2zaGfQ0
1 changed files with 44 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
zenith-openrpc.json
View file

@ -732,7 +732,7 @@
{ {
"name": "deshieldfunds", "name": "deshieldfunds",
"summary": "De-shield the given amount of ZEC from the given account", "summary": "De-shield the given amount of ZEC from the given account",
"description": "", "description": "Creates a new internal transaction with the requested amount of ZEC to the transparent pool.",
"tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}], "tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}],
"params": [ "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"}, { "$ref": "#/components/contentDescriptors/AccountId"},
@ -740,12 +740,52 @@
], ],
"paramStructure": "by-position", "paramStructure": "by-position",
"result": { "result": {
"name": "Operation ID(s)", "name": "Operation ID",
"schema": { "schema": {
"type": "array", "$ref": "#/components/contentDescriptors/OperationId"
"items": { "$ref": "#/components/contentDescriptors/OperationId"}
} }
}, },
"examples": [
{
"name": "De-Shield funds",
"summary": "De-shield funds",
"description": "Move the given amount of ZEC for the given acount from the shielded pool to the transparent pool",
"params": [
{
"name": "Account index",
"summary": "The index for the account to use",
"value": "3"
},
{
"name": "Amount",
"summary": "The amount of ZEC to use",
"value": 1.23
}
],
"result": {
"name": "Deshield funds result",
"value": "ab350df0-9f57-44c0-9e0d-f7b8af1f4231"
}
},
{
"name": "No transparent funds",
"summary": "Shield transparent notes with no transparent funds",
"description": "Attempt to shield the transparent notes in a given account, when account has none",
"params": [
{
"name": "Account index",
"summary": "The index for the account to use",
"value": "3"
}
],
"result": {
"name": "ShieldNotes result",
"value": [
"InsufficientFunds"
]
}
}
],
"errors": [ "errors": [
{ "$ref": "#/components/errors/ZebraNotAvailable" }, { "$ref": "#/components/errors/ZebraNotAvailable" },
{ "$ref": "#/components/errors/ZenithBusy" }, { "$ref": "#/components/errors/ZenithBusy" },