Vergara_Tech/zenith
Vergara_Tech/zenith
2
0
Fork 0
Code Issues 32 Pull requests Projects Releases 6 Packages Wiki Activity

docs: update the sendmany spec

Browse source
This commit is contained in:
Rene Vergara 2024-09-14 08:54:12 -05:00
parent c9a42572d3
commit 4aad9cb57f
Signed by: pitmutt
GPG key ID: 65122AD495A7F5B2
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
zenith-openrpc.json
View file

@ -598,10 +598,7 @@
"params": [ "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"}, { "$ref": "#/components/contentDescriptors/AccountId"},
{ "name": "Transaction requests", { "name": "Transaction requests",
"schema": { "schema": { "$ref": "#/components/contentDescriptors/TxRequest"}
"type": "array",
"items": { "$ref": "#/components/contentDescriptors/TxRequest"}
}
} }
], ],
"paramStructure": "by-position", "paramStructure": "by-position",
@ -732,18 +729,14 @@
"type": "string" "type": "string"
} }
}, },
"TxRequest": { "TxRequestArray": {
"name": "Transaction Request", "name": "Transaction Request Array",
"summary": "A proposed transaction", "summary": "An array of proposed transactions",
"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.", "description": "An array of proposed new outgoing transactions, including the recipient's address, the amount in ZEC, the optional shielded memo, and the optional privacy level.",
"required": true, "required": true,
"schema": { "schema": {
"type": "object", "type": "array",
"properties": { "items": { "$ref": "#/components/schemas/TxRequest"}
"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"},
"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."}
} }
} }
} }
@ -818,6 +811,14 @@
"status": {"type": "string", "enum": ["Processing", "Failed", "Successful"], "description": "If the operation has started it will show Processing, once it completes it will show Failed or Successful depending on the outcome"}, "status": {"type": "string", "enum": ["Processing", "Failed", "Successful"], "description": "If the operation has started it will show Processing, once it completes it will show Failed or Successful depending on the outcome"},
"result": {"type": ["string", "null"], "description": "For a succesful transaction operation, the transaction ID. For failed operations, the error message. For pending operations, this field is null."} "result": {"type": ["string", "null"], "description": "For a succesful transaction operation, the transaction ID. For failed operations, the error message. For pending operations, this field is null."}
} }
},
"TxRequest": {
"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"},
"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."}
} }
}, },
"examples": {}, "examples": {},