lnbits-exts/castle
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions
No description
134 commits 2 branches 2 tags 2 MiB
Find a file
padreug a3c3e44e5f Implement hybrid approach for balance assertions 
Balance assertions now use a hybrid architecture where Beancount is the source
of truth for validation, while Castle stores metadata for UI convenience.

Backend changes:
- Add format_balance() function to beancount_format.py for formatting balance directives
- Update POST /api/v1/assertions to write balance directive to Beancount first (via Fava)
- Store metadata in Castle DB (created_by, tolerance, notes) for UI features
- Validate assertions immediately by querying Fava for actual balance

Frontend changes:
- Update dialog description to explain Beancount validation
- Update button tooltip to clarify balance assertions are written to Beancount
- Update empty state message to mention Beancount checkpoints

Benefits:
- Single source of truth (Beancount ledger file)
- Automatic validation by Beancount
- Best of both worlds: robust validation + friendly UI

See misc-docs/BALANCE-ASSERTIONS-HYBRID-APPROACH.md for full documentation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-10 20:46:12 +01:00
core Removes core balance calculation logic 2025-11-10 01:06:51 +01:00
docs Refactors journal entry lines to use single amount 2025-11-08 11:48:08 +01:00
helper Improves Beancount entry generation and sanitization 2025-11-10 11:35:41 +01:00
static Removes redundant payment recording 2025-11-10 11:13:25 +01:00
templates/castle Implement hybrid approach for balance assertions 2025-11-10 20:46:12 +01:00
.gitignore initial commit 2025-10-22 12:33:45 +02:00
__init__.py Initializes Fava client on startup 2025-11-10 01:06:51 +01:00
account_utils.py Removes parent-only accounts 2025-11-07 23:24:11 +01:00
beancount_format.py Implement hybrid approach for balance assertions 2025-11-10 20:46:12 +01:00
CLAUDE.md update CLAUDE.md 2025-11-10 19:32:00 +01:00
config.json initial commit 2025-10-22 12:33:45 +02:00
crud.py drop old db tables and remove old functions 2025-11-10 20:02:01 +01:00
description.md initial commit 2025-10-22 12:33:45 +02:00
fava_client.py Fix add_account to use PUT /api/source endpoint 2025-11-10 20:38:07 +01:00
manifest.json initial commit 2025-10-22 12:33:45 +02:00
migrations.py drop old db tables and remove old functions 2025-11-10 20:02:01 +01:00
models.py Removes voided/flagged entry flags 2025-11-10 01:06:51 +01:00
README.md initial commit 2025-10-22 12:33:45 +02:00
services.py Creates default user accounts on wallet setup 2025-11-08 23:41:17 +01:00
tasks.py Refactors duplicate payment check in Fava 2025-11-10 10:25:05 +01:00
views.py Adds admin permissions management page 2025-11-07 18:05:30 +01:00
views_api.py Implement hybrid approach for balance assertions 2025-11-10 20:46:12 +01:00

README.md

Castle Accounting Extension for LNbits

A full-featured double-entry accounting system for collective projects, integrated with LNbits Lightning payments.

Overview

Castle Accounting enables collectives like co-living spaces, makerspaces, and community projects to:

  • Track expenses and revenue with proper accounting
  • Manage individual member balances
  • Record contributions as equity or reimbursable expenses
  • Track accounts receivable (what members owe)
  • Generate Lightning invoices for settlements

Installation

This extension is designed to be installed in the lnbits/extensions/ directory.

cd lnbits/extensions/
# Copy or clone the castle directory here

Enable the extension through the LNbits admin interface or by adding it to your configuration.

Usage

For Members

  1. Add an Expense: Record money you spent on behalf of the collective

    • Choose "Liability" if you want reimbursement
    • Choose "Equity" if it's a contribution

  2. View Your Balance: See if the Castle owes you money or vice versa

  3. Pay Outstanding Balance: Generate a Lightning invoice to settle what you owe

For Admins

  1. Create Accounts Receivable: Record when someone owes the collective money

  2. Record Revenue: Track income received by the collective

  3. View All Transactions: See complete accounting history

  4. Make Payments: Record payments to members

Architecture

Data Models

  • Account: Individual accounts in the chart of accounts
  • JournalEntry: Transaction header with description and date
  • EntryLine: Individual debit/credit lines (always balanced)

Account Types

  • Assets: Things the Castle owns (Cash, Bank, Accounts Receivable)
  • Liabilities: What the Castle owes (Accounts Payable to members)
  • Equity: Member contributions and retained earnings
  • Revenue: Income streams
  • Expenses: Operating costs

Database Schema

The extension creates three tables:

  • castle.accounts - Chart of accounts
  • castle.journal_entries - Transaction headers
  • castle.entry_lines - Debit/credit lines

API Reference

See description.md for full API documentation.

Development

To modify this extension:

  1. Edit models in models.py
  2. Add database migrations in migrations.py
  3. Implement business logic in crud.py
  4. Create API endpoints in views_api.py
  5. Update UI in templates/castle/index.html

Contributing

Contributions welcome! Please ensure:

  • Journal entries always balance
  • User permissions are properly checked
  • Database transactions are atomic

License

MIT License - feel free to use and modify for your collective!