Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RPCs to bookkeeper so you can update/set a description on an event #7604

Merged
merged 5 commits into from
Nov 11, 2024
+1,548 −59
Merged

Add RPCs to bookkeeper so you can update/set a description on an event #7604

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b94229d
bkpr: refactor out the add_events logic for json stuff
niftynei Aug 22, 2024
315f7ed
bkpr: add new json RPC "bkpr-editdescriptionbypaymentid"
niftynei Aug 22, 2024
6277888
bkpr: add new RPC bkpr-editdescriptionbyoutpoint
niftynei Aug 22, 2024
bb0b68e
bkpr: add tests for new edit description RPC calls
niftynei Aug 23, 2024
d31e6c6
bkpr: add examples for new edit description RPC calls
evansmj Aug 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
625 changes: 619 additions & 6 deletions contrib/msggen/msggen/schema.json
View file

Large diffs are not rendered by default.

309 changes: 309 additions & 0 deletions doc/schemas/lightning-bkpr-editdescriptionbyoutpoint.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,309 @@
{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "bkpr-editdescriptionbyoutpoint",
"title": "Command to change the description for events with {outpoint} after they're made",
"description": [
"The **bkpr-editdescriptionbyoutpoint** RPC command updates all chain and channel events that match the {outpoint} with the provided {description}"
],
"request": {
"required": [
"outpoint",
"description"
],
"properties": {
"outpoint": {
"type": "string",
"description": [
"The outpoint to update the description for."
]
},
"description": {
"type": "string",
"description": [
"The description to update to"
]
}
}
},
"response": {
"required": [
"updated"
],
"properties": {
"updated": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"required": [
"account",
"type",
"tag",
"credit_msat",
"debit_msat",
"currency",
"timestamp",
"description"
],
"properties": {
"account": {
"type": "string",
"description": [
"The account name. If the account is a channel, the channel_id."
]
},
"type": {
"type": "string",
"enum": [
"chain",
"channel"
],
"description": [
"Coin movement type."
]
},
"tag": {
"type": "string",
"description": [
"Description of movement."
]
},
"credit_msat": {
"type": "msat",
"description": [
"Amount credited."
]
},
"debit_msat": {
"type": "msat",
"description": [
"Amount debited."
]
},
"currency": {
"type": "string",
"description": [
"Human-readable bech32 part for this coin type."
]
},
"timestamp": {
"type": "u32",
"description": [
"Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp."
]
},
"description": {
"type": "string",
"description": [
"The description of this event"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"type": "string",
"enum": [
"chain"
]
}
}
},
"then": {
"properties": {
"account": {},
"type": {},
"tag": {},
"credit_msat": {},
"debit_msat": {},
"currency": {},
"timestamp": {},
"description": {
"type": "string",
"description": [
"A description of this outpoint."
]
},
"outpoint": {
"type": "string",
"description": [
"The txid:outnum for this event."
]
},
"blockheight": {
"type": "u32",
"description": [
"For chain events, blockheight this occured at."
]
},
"origin": {
"type": "string",
"description": [
"The account this movement originated from."
]
},
"payment_id": {
"type": "hex",
"description": [
"Lightning payment identifier. For an htlc, this will be the preimage."
]
},
"txid": {
"type": "txid",
"description": [
"The txid of the transaction that created this event."
]
}
},
"required": [
"outpoint",
"blockheight"
],
"additionalProperties": false
}
},
{
"if": {
"properties": {
"type": {
"type": "string",
"enum": [
"onchain_fee"
]
}
}
},
"then": {
"properties": {
"account": {},
"type": {},
"tag": {},
"credit_msat": {},
"debit_msat": {},
"currency": {},
"timestamp": {},
"description": {},
"txid": {
"type": "txid",
"description": [
"The txid of the transaction that created this event."
]
}
},
"required": [
"txid"
],
"additionalProperties": false
}
},
{
"if": {
"properties": {
"type": {
"type": "string",
"enum": [
"channel"
]
}
}
},
"then": {
"properties": {
"account": {},
"type": {},
"tag": {},
"credit_msat": {},
"debit_msat": {},
"currency": {},
"timestamp": {},
"description": {},
"fees_msat": {
"type": "msat",
"description": [
"Amount paid in fees."
]
},
"is_rebalance": {
"type": "boolean",
"description": [
"Is this payment part of a rebalance."
]
},
"payment_id": {
"type": "hex",
"description": [
"Lightning payment identifier. For an htlc, this will be the preimage."
]
},
"part_id": {
"type": "u32",
"description": [
"Counter for multi-part payments."
]
}
},
"additionalProperties": false
}
}
]
}
}
}
},
"author": [
"Lisa Neigut <<[email protected]>> is mainly responsible."
],
"see_also": [
"lightning-bkpr-editdescriptionbypaymentid(7)",
"lightning-bkpr-listaccountevents(7)",
"lightning-bkpr-listincome(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:bkpr-editdescriptionbyoutpoint#1",
"method": "bkpr-editdescriptionbyoutpoint",
"params": {
"outpoint": "55edd73a01f08057e1f5f61788477c0d7551d5d1aa2f2907bf9d03b6370bbacf:1",
"description": "edited utxo description"
}
},
"response": {
"updated": [
{
"account": "wallet",
"type": "chain",
"tag": "deposit",
"credit_msat": 200000000000,
"debit_msat": 0,
"currency": "bcrt",
"outpoint": "55edd73a01f08057e1f5f61788477c0d7551d5d1aa2f2907bf9d03b6370bbacf:1",
"timestamp": 1724554221,
"blockheight": 105,
"description": "edited utxo description"
}
]
}
},
{
"request": {
"id": "example:bkpr-editdescriptionbyoutpoint#2",
"method": "bkpr-editdescriptionbyoutpoint",
"params": {
"outpoint": "6472b4c9d39d8478ed9c848df7a62a512d953a4b2e6e7b09902d76a7bbb761ca:1",
"description": "edited utxo description"
}
},
"response": {
"updated": []
}
}
]
}
Loading