3e841b358e
Changelog-Fixed: Ensure documentation renders correctly when adding/updating new RPCs by detecting non-MDX-compatible pages.
386 lines
13 KiB
JSON
386 lines
13 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"rpc": "listchannelmoves",
|
|
"title": "Command to get the audit list of all channel coin movements.",
|
|
"added": "v25.09",
|
|
"description": [
|
|
"The **listchannelmoves** command returns the confirmed balance changes within lightning channels over time."
|
|
],
|
|
"categories": [
|
|
"readonly"
|
|
],
|
|
"request": {
|
|
"required": [],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"index": {
|
|
"type": "string",
|
|
"enum": [
|
|
"created"
|
|
],
|
|
"description": [
|
|
"How to interpret `start` and `limit`"
|
|
]
|
|
},
|
|
"start": {
|
|
"type": "u64",
|
|
"description": [
|
|
"If `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)."
|
|
]
|
|
},
|
|
"limit": {
|
|
"type": "u32",
|
|
"description": [
|
|
"If `index` is specified, `limit` can be used to specify the maximum number of entries to return."
|
|
]
|
|
}
|
|
},
|
|
"dependentUpon": {
|
|
"index": [
|
|
"start",
|
|
"limit"
|
|
]
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [
|
|
"channelmoves"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"channelmoves": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"created_index",
|
|
"account_id",
|
|
"primary_tag",
|
|
"credit_msat",
|
|
"debit_msat",
|
|
"timestamp",
|
|
"fees_msat"
|
|
],
|
|
"properties": {
|
|
"created_index": {
|
|
"type": "u64",
|
|
"description": [
|
|
"1-based index indicating order this move was created in."
|
|
]
|
|
},
|
|
"account_id": {
|
|
"type": "string",
|
|
"description": [
|
|
"The channel_id corresponding to the channel involved."
|
|
]
|
|
},
|
|
"credit_msat": {
|
|
"type": "msat",
|
|
"description": [
|
|
"Amount credited (one of this or debit_msat is zero)"
|
|
]
|
|
},
|
|
"debit_msat": {
|
|
"type": "msat",
|
|
"description": [
|
|
"Amount debited (one of this or credit_msat is zero)"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "u64",
|
|
"description": [
|
|
"Time of this event in seconds since January 1 1970 UTC"
|
|
]
|
|
},
|
|
"primary_tag": {
|
|
"type": "string",
|
|
"enum": [
|
|
"invoice",
|
|
"routed",
|
|
"pushed",
|
|
"lease_fee",
|
|
"channel_proposed",
|
|
"penalty_adj",
|
|
"journal_entry"
|
|
],
|
|
"description": [
|
|
"A set of one or more tags defining the nature of the change"
|
|
]
|
|
},
|
|
"payment_hash": {
|
|
"type": "hash",
|
|
"description": [
|
|
"The hash associated with this payment (not present for leases or push funding)"
|
|
]
|
|
},
|
|
"part_id": {
|
|
"type": "u64",
|
|
"description": [
|
|
"The part_id for the payment (the `payment_hash`, `group_id`, `part_id` tuple will be unique)"
|
|
]
|
|
},
|
|
"group_id": {
|
|
"type": "u64",
|
|
"description": [
|
|
"The group_id for the payment (the `payment_hash`, `group_id`, `part_id` tuple will be unique)"
|
|
]
|
|
},
|
|
"fees_msat": {
|
|
"type": "msat",
|
|
"description": [
|
|
"The fees paid for this payment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"errors": [
|
|
"On failure, one of the following error codes may be returned:",
|
|
"",
|
|
"- -32602: Error in given parameters."
|
|
],
|
|
"resources": [
|
|
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:listchannelmoves#1",
|
|
"method": "listchannelmoves",
|
|
"params": {}
|
|
},
|
|
"response": {
|
|
"channelmoves": [
|
|
{
|
|
"created_index": 1,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 500000000,
|
|
"debit_msat": 0,
|
|
"timestamp": 1738520000,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "paymenthashdelpay10101010101010101010101010101010101010101010101",
|
|
"fees_msat": 0
|
|
},
|
|
{
|
|
"created_index": 2,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 500000000,
|
|
"timestamp": 1738520000,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "8a46ab91013146df39e98ad7c89505fbb5419f110e928f7a393e8304f3057df7",
|
|
"part_id": 0,
|
|
"group_id": 1,
|
|
"fees_msat": 0
|
|
},
|
|
{
|
|
"created_index": 3,
|
|
"account_id": "f8fc83a432cbfb2fffe222cc06727fdd977b5dd10ebd6707158e799e6f522d9f",
|
|
"credit_msat": 0,
|
|
"debit_msat": 500000000,
|
|
"timestamp": 1758192801,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "88969daaf02214a1928e6eb62a237a8ee557f3da93b2c44f3901432c88f4334b",
|
|
"part_id": 0,
|
|
"group_id": 1,
|
|
"fees_msat": 0
|
|
},
|
|
{
|
|
"created_index": 4,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10000,
|
|
"timestamp": 1758192801,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashinvl0310031003100310031003100310031003100310031003100",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 5,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10001,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192801,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashinvl0310031003100310031003100310031003100310031003100",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 6,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10000,
|
|
"timestamp": 1758192801,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey01k101k101k101k101k101k101k101k101k101k101k101k101",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 7,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10001,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192801,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey01k101k101k101k101k101k101k101k101k101k101k101k101",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 8,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10000101,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey02k201k201k201k201k201k201k201k201k201k201k201k201",
|
|
"fees_msat": 101
|
|
},
|
|
{
|
|
"created_index": 9,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10000202,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey02k201k201k201k201k201k201k201k201k201k201k201k201",
|
|
"fees_msat": 101
|
|
},
|
|
{
|
|
"created_index": 10,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10000,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey03k301k301k301k301k301k301k301k301k301k301k301k301",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 11,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10001,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey03k301k301k301k301k301k301k301k301k301k301k301k301",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 12,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 50000,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashinvl0320032003200320032003200320032003200320032003200",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 13,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 50001,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashinvl0320032003200320032003200320032003200320032003200",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 14,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 100000,
|
|
"timestamp": 1758192803,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "paymenthashinvl0330033003300330033003300330033003300330033003300",
|
|
"part_id": 0,
|
|
"group_id": 1,
|
|
"fees_msat": 0
|
|
},
|
|
{
|
|
"created_index": 15,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10001,
|
|
"timestamp": 1758192803,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "61b929204f4db4f38e0412b2bd4c3c03668dad3575fb05f4e15a2214046c2bff",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 16,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10002,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192803,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "61b929204f4db4f38e0412b2bd4c3c03668dad3575fb05f4e15a2214046c2bff",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 17,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 0,
|
|
"debit_msat": 1000000,
|
|
"timestamp": 1758192821,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "paymenthashsdinvsi10si10si10si10si10si10si10si10si10si10si10si10",
|
|
"part_id": 0,
|
|
"group_id": 1,
|
|
"fees_msat": 0
|
|
},
|
|
{
|
|
"created_index": 18,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 1000,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192821,
|
|
"primary_tag": "invoice",
|
|
"payment_hash": "paymenthashinvl0270027002700270027002700270027002700270027002700",
|
|
"fees_msat": 0
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:listchannelmoves#2",
|
|
"method": "listchannelmoves",
|
|
"params": {
|
|
"index": "created",
|
|
"start": 10,
|
|
"limit": 2
|
|
}
|
|
},
|
|
"response": {
|
|
"channelmoves": [
|
|
{
|
|
"created_index": 10,
|
|
"account_id": "a397dd9b3e44afcb67f3f3ce1d649b74a8ade63e35505985e4cc1828634f69a2",
|
|
"credit_msat": 0,
|
|
"debit_msat": 10000,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey03k301k301k301k301k301k301k301k301k301k301k301k301",
|
|
"fees_msat": 1
|
|
},
|
|
{
|
|
"created_index": 11,
|
|
"account_id": "252d1b0a1e57895e84137f28cf19ab2c35847e284c112fefdecc7afeaa5c1de7",
|
|
"credit_msat": 10001,
|
|
"debit_msat": 0,
|
|
"timestamp": 1758192802,
|
|
"primary_tag": "routed",
|
|
"payment_hash": "paymenthashkey03k301k301k301k301k301k301k301k301k301k301k301k301",
|
|
"fees_msat": 1
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|