3e841b358e
Changelog-Fixed: Ensure documentation renders correctly when adding/updating new RPCs by detecting non-MDX-compatible pages.
129 lines
3.2 KiB
JSON
129 lines
3.2 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"added": "v24.11",
|
|
"rpc": "listaddresses",
|
|
"title": "Command to list all addresses issued by the node to date",
|
|
"description": [
|
|
"The **listaddresses** RPC command provides a detailed list of all Bitcoin addresses that have been generated and issued by the Core Lightning node up to the current date."
|
|
],
|
|
"categories": [
|
|
"readonly"
|
|
],
|
|
"request": {
|
|
"required": [],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"address": {
|
|
"type": "string",
|
|
"description": [
|
|
"A Bitcoin accepted type, including a bech32, address for lookup in the list of addresses issued to date."
|
|
]
|
|
},
|
|
"start": {
|
|
"type": "u64",
|
|
"description": [
|
|
"Starting key index for listing addresses or searching for a particular address."
|
|
],
|
|
"default": 1
|
|
},
|
|
"limit": {
|
|
"type": "u32",
|
|
"description": [
|
|
"The maximum number of addresses to return or search for."
|
|
],
|
|
"default": "Total number of addresses issued"
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"addresses"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"keyidx"
|
|
],
|
|
"properties": {
|
|
"keyidx": {
|
|
"type": "u64",
|
|
"description": [
|
|
"The key index of the address issued."
|
|
]
|
|
},
|
|
"bech32": {
|
|
"type": "string",
|
|
"description": [
|
|
"The bech32 (native segwit) address."
|
|
]
|
|
},
|
|
"p2tr": {
|
|
"type": "string",
|
|
"description": [
|
|
"The taproot address."
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"author": [
|
|
"Shahana Farooqui [sfarooqui@blockstream.com](mailto:sfarooqui@blockstream.com) is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-newaddr(7)",
|
|
"lightning-withdraw(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:listaddresses#1",
|
|
"method": "listaddresses",
|
|
"params": [
|
|
"bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
|
|
]
|
|
},
|
|
"response": {
|
|
"addresses": [
|
|
{
|
|
"keyidx": 14,
|
|
"p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:listaddresses#2",
|
|
"method": "listaddresses",
|
|
"params": {
|
|
"start": 6,
|
|
"limit": 2
|
|
}
|
|
},
|
|
"response": {
|
|
"addresses": [
|
|
{
|
|
"keyidx": 6,
|
|
"bech32": "bcrt1qkpw662yvzdy5ttdg8nw4eh4el0uc7m2ythw0h3"
|
|
},
|
|
{
|
|
"keyidx": 7,
|
|
"p2tr": "bcrt1pn45xgkyj54usdu98plm4zgcp4c5jvvfxmyexwcm5kc3gyfsrjmasd6ctsf"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|