docs: add examples for sendmany
OpenRPC
This commit is contained in:
parent
a2743842dd
commit
932d79ad57
1 changed files with 52 additions and 8 deletions
|
@ -597,14 +597,54 @@
|
|||
"tags": [{"$ref": "#/components/tags/draft"},{"$ref": "#/components/tags/wip"}],
|
||||
"params": [
|
||||
{ "$ref": "#/components/contentDescriptors/AccountId"},
|
||||
{ "$ref": "#/components/contentDescriptors/TxRequest"}
|
||||
{ "type": "array",
|
||||
"items": { "$ref": "#/components/contentDescriptors/TxRequest"}
|
||||
}
|
||||
],
|
||||
"paramStructure": "by-position",
|
||||
"result": {
|
||||
"name": "Operation ID(s)",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": { "$ref": "#/components/contentDescriptors/OperationId"}
|
||||
}
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
"name": "Send a transaction",
|
||||
"summary": "Send one transaction",
|
||||
"description": "Send a single transaction",
|
||||
"params": [
|
||||
{
|
||||
"name": "Account index",
|
||||
"summary": "The index for the account to use",
|
||||
"value": "1"
|
||||
},
|
||||
{
|
||||
"name": "Transaction request",
|
||||
"summary": "The transaction to attempt",
|
||||
"value": [
|
||||
{
|
||||
"address": "utest13dq4u4dnf3yddw8lq2n6zdclshra6xsp8zgkc5ydyu6k20zrsscmuex46qa4vh84rgd78sqnlleapznnz7mnzx9wv0unts8pv32paj8se5ca3kves2u4a89uy6e8cf4hnarxydxh7hq2e9uu39punfmm53k5h45xn9k3dx35la8j7munh9td7774m8gkqgc4mn40t69w20uu2gtks7a",
|
||||
"amount": 2.45,
|
||||
"memo": "Simple transaction"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"result": {
|
||||
"name": "Operation ID",
|
||||
"schema": {
|
||||
"$ref": "#/components/contentDescriptors/OperationId"
|
||||
"name": "SendMany result",
|
||||
"value": [
|
||||
"3cc31c07-07cf-4a6e-9190-156c4b8c4088"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"errors": [
|
||||
{ "$ref": "#/components/errors/ZebraNotAvailable" },
|
||||
{ "$ref": "#/components/errors/InvalidRecipient" },
|
||||
{ "$ref": "#/components/errors/InvalidAccount" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "getoperationstatus",
|
||||
|
@ -700,7 +740,7 @@
|
|||
"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 }
|
||||
"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 }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -826,6 +866,10 @@
|
|||
"InternalError": {
|
||||
"code": -32010,
|
||||
"message": "Varies"
|
||||
},
|
||||
"InvalidRecipient": {
|
||||
"code": -32011,
|
||||
"message": "The provided recipient address is not valid."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue