mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity

doc: fix up added versions for notification schemas.

Browse Source 
The *schemas* were added in v24.05, but the actual fields are much older.  Unfortunately,
fixing this required a manual edit of the .msggen.json file, as msggen won't let the
added version change (for good reason).

Versions when these notifications were originally added:
connect: v0.6.3
channel_opened: v0.7.2.1:
channel_state_changed: v0.9.1
channel_open_failed: v0.9.3
block_added: v22.11
custommsg: v24.02

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2024-06-28 11:16:32 +09:30 committed by ShahanaFarooqui
parent 05f5976a9c
commit 418887b24a
8 changed files with 81 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
.msggen.json
View File

@ -11401,87 +11401,87 @@
"deprecated": false "deprecated": false
}, },
"block_added": { "block_added": {
"added": "v24.05", "added": "v22.11",
"deprecated": null "deprecated": null
}, },
"block_added.hash": { "block_added.hash": {
"added": "v24.05", "added": "v22.11",
"deprecated": false "deprecated": false
}, },
"block_added.height": { "block_added.height": {
"added": "v24.05", "added": "v22.11",
"deprecated": false "deprecated": false
}, },
"channel_open_failed": { "channel_open_failed": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": null "deprecated": null
}, },
"channel_open_failed.channel_id": { "channel_open_failed.channel_id": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"channel_opened": { "channel_opened": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": null "deprecated": null
}, },
"channel_opened.channel_ready": { "channel_opened.channel_ready": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"channel_opened.funding_msat": { "channel_opened.funding_msat": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"channel_opened.funding_txid": { "channel_opened.funding_txid": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"channel_opened.id": { "channel_opened.id": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect": { "connect": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": null "deprecated": null
}, },
"connect.address": { "connect.address": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.address.address": { "connect.address.address": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.address.port": { "connect.address.port": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.address.socket": { "connect.address.socket": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.address.type": { "connect.address.type": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.direction": { "connect.direction": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"connect.id": { "connect.id": {
"added": "v24.05", "added": "pre-v0.10.1",
"deprecated": false "deprecated": false
}, },
"custommsg": { "custommsg": {
"added": "v24.05", "added": "v24.02",
"deprecated": null "deprecated": null
}, },
"custommsg.payload": { "custommsg.payload": {
"added": "v24.05", "added": "v24.02",
"deprecated": false "deprecated": false
}, },
"custommsg.peer_id": { "custommsg.peer_id": {
"added": "v24.05", "added": "v24.02",
"deprecated": false "deprecated": false
}, },
"multifundchannel": { "multifundchannel": {

56
contrib/msggen/msggen/schema.json
View File

@ -31003,7 +31003,7 @@
"description": [ "description": [
"The **block_added** notification is sent whenever the node receives a new block from the blockchain." "The **block_added** notification is sent whenever the node receives a new block from the blockchain."
], ],
"added": "v24.05", "added": "v22.11",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31016,14 +31016,14 @@
"description": [ "description": [
"The hash of the block." "The hash of the block."
], ],
"added": "v24.05" "added": "v22.11"
}, },
"height": { "height": {
"type": "u32", "type": "u32",
"description": [ "description": [
"The total block height." "The total block height."
], ],
"added": "v24.05" "added": "v22.11"
} }
} }
} }
@ -31037,7 +31037,7 @@
"description": [ "description": [
"The **channel_open_failed** notification is sent whenever the channel opening request is failed." "The **channel_open_failed** notification is sent whenever the channel opening request is failed."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31049,7 +31049,7 @@
"description": [ "description": [
"The channel id of the channel." "The channel id of the channel."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
} }
} }
} }
@ -31063,7 +31063,7 @@
"description": [ "description": [
"The **channel_opened** notification is sent whenever the channel opened successfully." "The **channel_opened** notification is sent whenever the channel opened successfully."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31078,28 +31078,28 @@
"description": [ "description": [
"The id of the peer which opened the channel" "The id of the peer which opened the channel"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"funding_msat": { "funding_msat": {
"type": "msat", "type": "msat",
"description": [ "description": [
"The amount of the funding transaction" "The amount of the funding transaction"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"funding_txid": { "funding_txid": {
"type": "txid", "type": "txid",
"description": [ "description": [
"The transaction id of the funding transaction" "The transaction id of the funding transaction"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"channel_ready": { "channel_ready": {
"type": "boolean", "type": "boolean",
"description": [ "description": [
"true if the channel is ready" "true if the channel is ready"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
} }
} }
} }
@ -31113,7 +31113,7 @@
"description": [ "description": [
"The **channel_state_changed** informs whenever the state of the channel has been updated." "The **channel_state_changed** informs whenever the state of the channel has been updated."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31132,28 +31132,28 @@
"description": [ "description": [
"The peer id of the channel." "The peer id of the channel."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
"description": [ "description": [
"The channel id of the channel." "The channel id of the channel."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"short_channel_id": { "short_channel_id": {
"type": "short_channel_id", "type": "short_channel_id",
"description": [ "description": [
"The short channel id of the channel. If the channel is not yet confirmed, this field will be null." "The short channel id of the channel. If the channel is not yet confirmed, this field will be null."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"timestamp": { "timestamp": {
"type": "string", "type": "string",
"description": [ "description": [
"The timestamp of the state change." "The timestamp of the state change."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"old_state": { "old_state": {
"type": "string", "type": "string",
@ -31176,7 +31176,7 @@
"description": [ "description": [
"The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" "The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"new_state": { "new_state": {
"type": "string", "type": "string",
@ -31199,7 +31199,7 @@
"description": [ "description": [
"The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" "The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"cause": { "cause": {
"type": "string", "type": "string",
@ -31214,14 +31214,14 @@
"description": [ "description": [
"The cause of the state change." "The cause of the state change."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"message": { "message": {
"type": "string", "type": "string",
"description": [ "description": [
"The state change message." "The state change message."
], ],
"added": "v24.05" "added": "pre-v0.10.1"
} }
} }
} }
@ -31235,7 +31235,7 @@
"The **connect** informs whenever the node is connected to a peer." "The **connect** informs whenever the node is connected to a peer."
], ],
"additionalProperties": false, "additionalProperties": false,
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31249,7 +31249,7 @@
"description": [ "description": [
"The id of the peer which sent the custom message" "The id of the peer which sent the custom message"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"direction": { "direction": {
"type": "string", "type": "string",
@ -31260,14 +31260,14 @@
"description": [ "description": [
"Direction of the connection" "Direction of the connection"
], ],
"added": "v24.05" "added": "pre-v0.10.1"
}, },
"address": { "address": {
"type": "object", "type": "object",
"description": [ "description": [
"Address information (mainly useful if **direction** is *out*)" "Address information (mainly useful if **direction** is *out*)"
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"additionalProperties": true, "additionalProperties": true,
"required": [ "required": [
"type" "type"
@ -31275,6 +31275,7 @@
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"enum": [ "enum": [
"local socket", "local socket",
"ipv4", "ipv4",
@ -31308,6 +31309,7 @@
"type": {}, "type": {},
"socket": { "socket": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"description": [ "description": [
"Socket filename" "Socket filename"
] ]
@ -31339,12 +31341,14 @@
"type": {}, "type": {},
"address": { "address": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"description": [ "description": [
"Address in expected format for **type**" "Address in expected format for **type**"
] ]
}, },
"port": { "port": {
"type": "u16", "type": "u16",
"added": "pre-v0.10.1",
"description": [ "description": [
"Port number" "Port number"
] ]
@ -31366,7 +31370,7 @@
"description": [ "description": [
"The **custommsg** notifies whenever the node receives a custom message from a peer." "The **custommsg** notifies whenever the node receives a custom message from a peer."
], ],
"added": "v24.05", "added": "v24.02",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -31379,14 +31383,14 @@
"description": [ "description": [
"The id of the peer which sent the custom message" "The id of the peer which sent the custom message"
], ],
"added": "v24.05" "added": "v24.02"
}, },
"payload": { "payload": {
"type": "hex", "type": "hex",
"description": [ "description": [
"The hex-encoded payload. The first 2 bytes represent the BOLT-8 message type followed by the message content" "The hex-encoded payload. The first 2 bytes represent the BOLT-8 message type followed by the message content"
], ],
"added": "v24.05" "added": "v24.02"
} }
} }
} }

6
doc/schemas/notification/block_added.json
View File

@ -7,7 +7,7 @@
"description": [ "description": [
"The **block_added** notification is sent whenever the node receives a new block from the blockchain." "The **block_added** notification is sent whenever the node receives a new block from the blockchain."
], ],
"added": "v24.05", "added": "v22.11",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -20,14 +20,14 @@
"description": [ "description": [
"The hash of the block." "The hash of the block."
], ],
"added" : "v24.05" "added": "v22.11"
}, },
"height": { "height": {
"type": "u32", "type": "u32",
"description": [ "description": [
"The total block height." "The total block height."
], ],
"added" : "v24.05" "added": "v22.11"
} }
} }
} }

4
doc/schemas/notification/channel_open_failed.json
View File

@ -7,7 +7,7 @@
"description": [ "description": [
"The **channel_open_failed** notification is sent whenever the channel opening request is failed." "The **channel_open_failed** notification is sent whenever the channel opening request is failed."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -19,7 +19,7 @@
"description": [ "description": [
"The channel id of the channel." "The channel id of the channel."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
} }
} }
} }

10
doc/schemas/notification/channel_opened.json
View File

@ -7,7 +7,7 @@
"description": [ "description": [
"The **channel_opened** notification is sent whenever the channel opened successfully." "The **channel_opened** notification is sent whenever the channel opened successfully."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -22,28 +22,28 @@
"description": [ "description": [
"The id of the peer which opened the channel" "The id of the peer which opened the channel"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"funding_msat": { "funding_msat": {
"type": "msat", "type": "msat",
"description": [ "description": [
"The amount of the funding transaction" "The amount of the funding transaction"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"funding_txid": { "funding_txid": {
"type": "txid", "type": "txid",
"description": [ "description": [
"The transaction id of the funding transaction" "The transaction id of the funding transaction"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"channel_ready": { "channel_ready": {
"type": "boolean", "type": "boolean",
"description": [ "description": [
"true if the channel is ready" "true if the channel is ready"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
} }
} }
} }

18
doc/schemas/notification/channel_state_changed.json
View File

@ -7,7 +7,7 @@
"description": [ "description": [
"The **channel_state_changed** informs whenever the state of the channel has been updated." "The **channel_state_changed** informs whenever the state of the channel has been updated."
], ],
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -26,28 +26,28 @@
"description": [ "description": [
"The peer id of the channel." "The peer id of the channel."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
"description": [ "description": [
"The channel id of the channel." "The channel id of the channel."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"short_channel_id": { "short_channel_id": {
"type": "short_channel_id", "type": "short_channel_id",
"description": [ "description": [
"The short channel id of the channel. If the channel is not yet confirmed, this field will be null." "The short channel id of the channel. If the channel is not yet confirmed, this field will be null."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"timestamp": { "timestamp": {
"type": "string", "type": "string",
"description": [ "description": [
"The timestamp of the state change." "The timestamp of the state change."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"old_state": { "old_state": {
"type": "string", "type": "string",
@ -70,7 +70,7 @@
"description": [ "description": [
"The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" "The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"new_state": { "new_state": {
"type": "string", "type": "string",
@ -93,7 +93,7 @@
"description": [ "description": [
"The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" "The channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"cause": { "cause": {
"type": "string", "type": "string",
@ -108,14 +108,14 @@
"description": [ "description": [
"The cause of the state change." "The cause of the state change."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"message": { "message": {
"type": "string", "type": "string",
"description": [ "description": [
"The state change message." "The state change message."
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
} }
} }
} }

12
doc/schemas/notification/connect.json
View File

@ -7,7 +7,7 @@
"The **connect** informs whenever the node is connected to a peer." "The **connect** informs whenever the node is connected to a peer."
], ],
"additionalProperties": false, "additionalProperties": false,
"added": "v24.05", "added": "pre-v0.10.1",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -21,7 +21,7 @@
"description": [ "description": [
"The id of the peer which sent the custom message" "The id of the peer which sent the custom message"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"direction": { "direction": {
"type": "string", "type": "string",
@ -32,14 +32,14 @@
"description": [ "description": [
"Direction of the connection" "Direction of the connection"
], ],
"added" : "v24.05" "added": "pre-v0.10.1"
}, },
"address": { "address": {
"type": "object", "type": "object",
"description": [ "description": [
"Address information (mainly useful if **direction** is *out*)" "Address information (mainly useful if **direction** is *out*)"
], ],
"added" : "v24.05", "added": "pre-v0.10.1",
"additionalProperties": true, "additionalProperties": true,
"required": [ "required": [
"type" "type"
@ -47,6 +47,7 @@
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"enum": [ "enum": [
"local socket", "local socket",
"ipv4", "ipv4",
@ -80,6 +81,7 @@
"type": {}, "type": {},
"socket": { "socket": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"description": [ "description": [
"Socket filename" "Socket filename"
] ]
@ -111,12 +113,14 @@
"type": {}, "type": {},
"address": { "address": {
"type": "string", "type": "string",
"added": "pre-v0.10.1",
"description": [ "description": [
"Address in expected format for **type**" "Address in expected format for **type**"
] ]
}, },
"port": { "port": {
"type": "u16", "type": "u16",
"added": "pre-v0.10.1",
"description": [ "description": [
"Port number" "Port number"
] ]

6
doc/schemas/notification/custommsg.json
View File

@ -7,7 +7,7 @@
"description": [ "description": [
"The **custommsg** notifies whenever the node receives a custom message from a peer." "The **custommsg** notifies whenever the node receives a custom message from a peer."
], ],
"added": "v24.05", "added": "v24.02",
"request": {}, "request": {},
"response": { "response": {
"required": [ "required": [
@ -20,14 +20,14 @@
"description": [ "description": [
"The id of the peer which sent the custom message" "The id of the peer which sent the custom message"
], ],
"added" : "v24.05" "added": "v24.02"
}, },
"payload": { "payload": {
"type": "hex", "type": "hex",
"description": [ "description": [
"The hex-encoded payload. The first 2 bytes represent the BOLT-8 message type followed by the message content" "The hex-encoded payload. The first 2 bytes represent the BOLT-8 message type followed by the message content"
], ],
"added" : "v24.05" "added": "v24.02"
} }
} }
} }