mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
78 lines
1.9 KiB
JSON
78 lines
1.9 KiB
JSON
|
{
|
||
|
|
"$schema": "../rpc-schema-draft.json",
|
||
|
|
"type": "object",
|
||
|
|
"additionalProperties": false,
|
||
|
|
"rpc": "sendonionmessage",
|
||
|
|
"title": "low-level command to send an onion message",
|
||
|
|
"warning": "experimental-onion-messages only",
|
||
|
|
"description": [
|
||
|
|
"The **sendonionmessage** RPC command can be used to send a message via the lightning network. These are currently used by *offers* to request and receive invoices."
|
||
|
|
],
|
||
|
|
"request": {
|
||
|
|
"required": [
|
||
|
|
"first_id",
|
||
|
|
"blinding",
|
||
|
|
"hops"
|
||
|
|
],
|
||
|
|
"properties": {
|
||
|
|
"first_id": {
|
||
|
|
"type": "pubkey",
|
||
|
|
"description": [
|
||
|
|
"The (presumably well-known) public key of the start of the path."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"blinding": {
|
||
|
|
"type": "pubkey",
|
||
|
|
"description": [
|
||
|
|
"Blinding factor for this path."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"hops": {
|
||
|
|
"type": "array",
|
||
|
|
"description": [
|
||
|
|
"",
|
||
|
|
""
|
||
|
|
],
|
||
|
|
"items": {
|
||
|
|
"type": "object",
|
||
|
|
"additionalProperties": false,
|
||
|
|
"required": [
|
||
|
|
"node",
|
||
|
|
"tlv"
|
||
|
|
],
|
||
|
|
"properties": {
|
||
|
|
"node": {
|
||
|
|
"type": "pubkey",
|
||
|
|
"description": [
|
||
|
|
"Public key of the node."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"tlv": {
|
||
|
|
"type": "u8",
|
||
|
|
"description": [
|
||
|
|
"Contains a hexadecimal TLV to include."
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"required": [],
|
||
|
|
"properties": {}
|
||
|
|
},
|
||
|
|
"author": [
|
||
|
|
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
|
||
|
|
],
|
||
|
|
"see_also": [
|
||
|
|
"lightning-fetchinvoice(7)",
|
||
|
|
"lightning-offer(7)"
|
||
|
|
],
|
||
|
|
"resources": [
|
||
|
|
"Main web site: <https://github.com/ElementsProject/lightning>",
|
||
|
|
"",
|
||
|
|
"[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md"
|
||
|
|
]
|
||
|
|
}
|