← Watch feed
doc: provide realistic example for bkpr-report.
Public commit record
60/100 · Adequate
What the developer wrote
Authored by Rusty Russell
doc: provide realistic example for bkpr-report.
This should make the accountants happy!
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
✓ Descriptive subject✓ Names a concrete action or component✓ Provides an explanatory body
What changed, and why it matters
This commit only adds example request/response documentation for the bkpr-report RPC command. It changes two JSON schema files to show accountants how the report output looks, with no code logic changes.
Recommended action
No security action needed. This is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds an ‘examples’ block to contrib/msggen/msggen/schema.json and doc/schemas/bkpr-report.json. The example demonstrates a realistic bkpr-report RPC call with CSV headers, a format string, escape mode, and a sample response containing deposit, invoice, and onchain_fee rows. No executable code, parsing logic, or behavior is modified.
Changed components
doc/schemas/bkpr-report.jsoncontrib/msggen/msggen/schema.jsonInspect captured patch +48 / −0
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
index 3728d08d..6f2e8586 100644
--- a/contrib/msggen/msggen/schema.json
+++ b/contrib/msggen/msggen/schema.json
@@ -5227,6 +5227,30 @@
}
}
},
+ "examples": [
+ {
+ "request": {
+ "id": "example:bkpr-report#1",
+ "method": "bkpr-report",
+ "params": {
+ "headers": [
+ "Date,Tag,Account,Description,Credit,Debit,BTC/USD,Credit (USD),Debit(USD)"
+ ],
+ "format": "{localtime},{tag},{account},{description?Invoice description {description}:{outpoint?Onchain output {outpoint}:{txid?Onchain transaction {txid}}}},{credit?+{credit}:0},{debit?-{debit}:0},{currencyrate},${currencycredit},${currencydebit}",
+ "escape": "csv"
+ }
+ },
+ "response": {
+ "report": [
+ "Date,Tag,Account,Description,Credit,Debit,BTC/USD,Credit (USD),Debit(USD)",
+ "2026-04-02 12:42:03,deposit,wallet,Onchain output 37562cf0b3a5d6783ae02925bcc486bb89afe156abf15e692736e5da9a060018:1,+0.02000000000,0,67140.89,$1342.81,$0.00",
+ "2026-04-02 12:42:04,invoice,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Invoice description test_bkpr_report_invoice,0,-0.00000123456,67140.89,$0.00,$0.08",
+ "2026-04-02 12:42:04,onchain_fee,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Onchain transaction f464ff0a67e99a36e83ba3ae12115a57e104fbc97b3bcfdbdec83d00c814319b,0,-0.00004927000,67140.89,$0.00,$3.30"
+ ],
+ "format-hint": "simple"
+ }
+ }
+ ],
"author": [
"Rusty Russell [rusty@rustcorp.com.au](mailto:rusty@rustcorp.com.au) is mainly responsible."
],
diff --git a/doc/schemas/bkpr-report.json b/doc/schemas/bkpr-report.json
index 1ae87b4f..430d5019 100644
--- a/doc/schemas/bkpr-report.json
+++ b/doc/schemas/bkpr-report.json
@@ -113,6 +113,30 @@
}
}
},
+ "examples": [
+ {
+ "request": {
+ "id": "example:bkpr-report#1",
+ "method": "bkpr-report",
+ "params": {
+ "headers": [
+ "Date,Tag,Account,Description,Credit,Debit,BTC/USD,Credit (USD),Debit(USD)"
+ ],
+ "format": "{localtime},{tag},{account},{description?Invoice description {description}:{outpoint?Onchain output {outpoint}:{txid?Onchain transaction {txid}}}},{credit?+{credit}:0},{debit?-{debit}:0},{currencyrate},${currencycredit},${currencydebit}",
+ "escape": "csv"
+ }
+ },
+ "response": {
+ "report": [
+ "Date,Tag,Account,Description,Credit,Debit,BTC/USD,Credit (USD),Debit(USD)",
+ "2026-04-02 12:42:03,deposit,wallet,Onchain output 37562cf0b3a5d6783ae02925bcc486bb89afe156abf15e692736e5da9a060018:1,+0.02000000000,0,67140.89,$1342.81,$0.00",
+ "2026-04-02 12:42:04,invoice,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Invoice description test_bkpr_report_invoice,0,-0.00000123456,67140.89,$0.00,$0.08",
+ "2026-04-02 12:42:04,onchain_fee,9b3114c8003dc8dedbcf3b7bc9fb04e1575a1112aea33be8369ae9670aff64f4,Onchain transaction f464ff0a67e99a36e83ba3ae12115a57e104fbc97b3bcfdbdec83d00c814319b,0,-0.00004927000,67140.89,$0.00,$3.30"
+ ],
+ "format-hint": "simple"
+ }
+ }
+ ],
"author": [
"Rusty Russell [rusty@rustcorp.com.au](mailto:rusty@rustcorp.com.au) is mainly responsible."
],
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.