docs: update the sendmany
spec
This commit is contained in:
parent
c9a42572d3
commit
4aad9cb57f
1 changed files with 15 additions and 14 deletions
|
@ -598,10 +598,7 @@
|
|||
"params": [
|
||||
{ "$ref": "#/components/contentDescriptors/AccountId"},
|
||||
{ "name": "Transaction requests",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": { "$ref": "#/components/contentDescriptors/TxRequest"}
|
||||
}
|
||||
"schema": { "$ref": "#/components/contentDescriptors/TxRequest"}
|
||||
}
|
||||
],
|
||||
"paramStructure": "by-position",
|
||||
|
@ -732,18 +729,14 @@
|
|||
"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.",
|
||||
"TxRequestArray": {
|
||||
"name": "Transaction Request Array",
|
||||
"summary": "An array of proposed transactions",
|
||||
"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,
|
||||
"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"},
|
||||
"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."}
|
||||
"type": "array",
|
||||
"items": { "$ref": "#/components/schemas/TxRequest"}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -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"},
|
||||
"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": {},
|
||||
|
|
Loading…
Reference in a new issue