docs: update OpenRPC spec for sendmany

This commit is contained in:
Rene Vergara 2024-09-13 17:20:31 -05:00
parent e46cd01f41
commit a2743842dd
Signed by: pitmutt
GPG key ID: 65122AD495A7F5B2

View file

@ -593,12 +593,16 @@
{ {
"name": "sendmany", "name": "sendmany",
"summary": "Send transaction(s)", "summary": "Send transaction(s)",
"description": "Send one or more transactions ", "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"}], "tags": [{"$ref": "#/components/tags/draft"},{"$ref": "#/components/tags/wip"}],
"params": [], "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"},
{ "$ref": "#/components/contentDescriptors/TxRequest"}
],
"result": { "result": {
"name": "Operation ID", "name": "Operation ID",
"schema": { "schema": {
"$ref": "#/components/contentDescriptors/OperationId"
} }
} }
}, },
@ -684,8 +688,22 @@
"schema" : { "schema" : {
"type": "string" "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": { "schemas": {
"ZenithInfo": { "ZenithInfo": {