docs(rpc): update OpenRPC spec for deshieldfunds

This commit is contained in:
Rene Vergara 2024-12-19 14:11:37 -06:00
parent 9546613e0f
commit d53bb092d1
Signed by: pitmutt
SSH key fingerprint: SHA256:vNa8FIqbBZjV9hOCkXyOzd7gqWCMCfkcfiPH2zaGfQ0
4 changed files with 21 additions and 6 deletions

View file

@ -67,7 +67,7 @@ main = do
zebraPort zebraPort
(zgb_net chainInfo) (zgb_net chainInfo)
threadDelay 90000000 threadDelay 90000000
putStrLn "Zenith RPC Server 0.7.0.0-beta" putStrLn "Zenith RPC Server 0.8.0.0-beta"
putStrLn "------------------------------" putStrLn "------------------------------"
putStrLn $ putStrLn $
"Connected to " ++ "Connected to " ++

View file

@ -532,7 +532,7 @@ zenithServer state = getinfo :<|> handleRPC
getinfo = getinfo =
return $ return $
object object
[ "version" .= ("0.7.0.0-beta" :: String) [ "version" .= ("0.8.0.0-beta" :: String)
, "network" .= ("testnet" :: String) , "network" .= ("testnet" :: String)
] ]
handleRPC :: Bool -> RpcCall -> Handler ZenithResponse handleRPC :: Bool -> RpcCall -> Handler ZenithResponse

@ -1 +1 @@
Subproject commit d350c2e7844a526ff9b21bb14e1723fce9b0b46b Subproject commit 7d3ae36d2b48b8ed91a70e40a77fb7efe57765a0

View file

@ -674,7 +674,7 @@
"name": "shieldnotes", "name": "shieldnotes",
"summary": "Shield all transparent notes into the Orchard pool for the given account", "summary": "Shield all transparent notes into the Orchard pool for the given account",
"description": "Creates one or more transactions, grouping all the unspent transparent notes for the given account by their transparent address to avoid associating different transparent addresses. These notes are sent to the given account's internal change address as shielded Orchard notes.", "description": "Creates one or more transactions, grouping all the unspent transparent notes for the given account by their transparent address to avoid associating different transparent addresses. These notes are sent to the given account's internal change address as shielded Orchard notes.",
"tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}], "tags": [],
"params": [ "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"} { "$ref": "#/components/contentDescriptors/AccountId"}
], ],
@ -735,12 +735,18 @@
"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": "",
"tags": [{ "$ref": "#/components/tags/draft"}], "tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}],
"params": [], "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"},
{ "$ref": "#/components/contentDescriptors/Address"}
],
"paramStructure": "by-position", "paramStructure": "by-position",
"result": { "result": {
}, },
"errors": [ "errors": [
{ "$ref": "#/components/errors/ZebraNotAvailable" },
{ "$ref": "#/components/errors/ZenithBusy" },
{ "$ref": "#/components/errors/InvalidAccount" }
] ]
} }
], ],
@ -773,6 +779,15 @@
"type": "string" "type": "string"
} }
}, },
"Amount": {
"name": "A numeric amount",
"summary": "A numeric amount",
"description": "A number that represents an amount to be used by a function as an input",
"required": true,
"schema": {
"type": "number"
}
},
"Name": { "Name": {
"name": "Name", "name": "Name",
"summary": "A user-friendly name", "summary": "A user-friendly name",