From a4966d0f5a11e2df7379957bd87338f948b7243d Mon Sep 17 00:00:00 2001 From: Rene Vergara Date: Sun, 12 Jan 2025 15:54:43 -0600 Subject: [PATCH] docs(rpc): start `getfullvk` --- zenith-openrpc.json | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/zenith-openrpc.json b/zenith-openrpc.json index ce0dfa5..4bee826 100644 --- a/zenith-openrpc.json +++ b/zenith-openrpc.json @@ -791,6 +791,46 @@ { "$ref": "#/components/errors/ZenithBusy" }, { "$ref": "#/components/errors/InvalidAccount" } ] + }, + { + "name": "getfullvk", + "summary": "De-shield the given amount of ZEC from the given account", + "description": "Creates a new internal transaction with the requested amount of ZEC to the transparent pool. The fee is not included in the given amount.", + "tags": [ + { "$ref": "#/components/tags/draft"}, + { "$ref": "#/components/tags/wip"} + ], + "params": [ + { "$ref": "#/components/contentDescriptors/AccountId"} + ], + "paramStructure": "by-position", + "result": { + "name": "Full viewing key", + "schema": { + "$ref": "#/components/contentDescriptors/ViewingKey" + } + }, + "examples": [ + { + "name": "Get full viewing key", + "summary": "Get the full viewing key", + "description": "Get the full viewing key for the give account, encoded per ZIP-316", + "params": [ + { + "name": "Account index", + "summary": "The index for the account to use", + "value": 1 + } + ], + "result": { + "name": "Full Viewing key", + "value": "uview16qdhd9e283s4y53gmw72ag7adzdrj9f9v96dw89ggv9el0yrf7vkappau69j8luq7uf540sr78ncslnqk6kwpc4qeqgfg5vn4xcmllynyfr32cgq6nx5ptku44kfxtsj99px2g9yp7kyc32quun0elakgltqmqflprwmryuelcfwwt58vqap065as7qwljg02l6mkutsh2y9aefd284dsrj0246fd2n4hra3r03uftsh4njh3w590z78tpnfqhjvvwhgus476zrw3fd69qekru709ghr0zr7h8majy9aclwg7uhakt24lmuec8dd7t270kamcs99rz8jasj3jl6m9y77dvkdn23e2kwuc6kyagpstzrdjnlzdldmgsu4k056v80ucajcjvl99pcf2znjg37vztdp4zr5qrphxs4y7wppxmankmdwwgjxhlmyrjd68z80q0n0t2cyqge6mlc7pd5wre4392pjtdaqvtyeg0denh4ekynnjxnm" + } + } + ], + "errors": [ + { "$ref": "#/components/errors/InvalidAccount" } + ] } ], "components": { @@ -966,6 +1006,10 @@ "amount": { "type": "number", "description": "The amount to send in ZEC"}, "memo": { "type": "string", "description": "The shielded memo to include, if applicable"} } + }, + "ViewingKey": { + "type": "string", + "description": "The viewing key, encoded per ZIP-316" } }, "examples": {},