From a2743842ddcd1cf12b6371a0a5e16cb5fb3ac253 Mon Sep 17 00:00:00 2001 From: Rene Vergara Date: Fri, 13 Sep 2024 17:20:31 -0500 Subject: [PATCH] docs: update OpenRPC spec for sendmany --- zenith-openrpc.json | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/zenith-openrpc.json b/zenith-openrpc.json index d87f2e5..f5e733b 100644 --- a/zenith-openrpc.json +++ b/zenith-openrpc.json @@ -593,12 +593,16 @@ { "name": "sendmany", "summary": "Send transaction(s)", - "description": "Send one or more transactions ", - "tags": [{"$ref": "#/components/tags/draft"}], - "params": [], + "description": "Send one or more transactions by specifying the source account, the recipient address, the amount, the shielded memo (optional) and the privacy policy (optional).", + "tags": [{"$ref": "#/components/tags/draft"},{"$ref": "#/components/tags/wip"}], + "params": [ + { "$ref": "#/components/contentDescriptors/AccountId"}, + { "$ref": "#/components/contentDescriptors/TxRequest"} + ], "result": { "name": "Operation ID", "schema": { + "$ref": "#/components/contentDescriptors/OperationId" } } }, @@ -684,8 +688,22 @@ "schema" : { "type": "string" } + }, + "TxRequest": { + "name": "Transaction Request", + "summary": "A proposed transaction", + "description": "A description of a proposed new outgoing transaction, including the recipient's address, the amount in ZEC, the optional shielded memo, and the optional privacy level.", + "required": true, + "schema": { + "type": "object", + "properties": { + "address": { "type": "string", "description": "Recipient's address (unified, Sapling or transparent)" }, + "amount": { "type": "number", "description": "The amount to send in ZEC"}, + "memo": { "type": "string", "description": "The shielded memo to include, if applicable", "required": false}, + "privacy": { "type": "string", "enum": ["None", "Medium", "Full"], "description": "The privacy policy to use for the transaction. Full policy allows shielded funds to be transferred within their shielded pools. Medium policy allows shielded funds to cross shielded pools and deshielding transactions. None allows for transparent funds to be spent.", "required": false } + } + } } - }, "schemas": { "ZenithInfo": {