get_node_daily_balance.py

# This code gets your daily node balance
# Dependencies: Balance of Satoshis (BOS)
# Use with crontab
# 0 0 * * * /usr/bin/python3 /home/<user>/get_node_daily_balance.py >> /home/<user>/node-balance.log 2>&1


import subprocess
import csv
from datetime import datetime

NODE_NAME = "Your-node-name"

# Please check if it is the right path for your BOS Binary
FULL_PATH_BOS = "/home/<user>/.npm-global/lib/node_modules/balanceofsatoshis/"

TOTAL_OTHERS = 0
TOTAL_OTHER_FEES = 0
OTHER_FEES = ""

def execute_command(command):
    # Execute the command and capture the output
    output = subprocess.check_output(command, shell=True, text=True)
    return output

def process_csv(csv_data, notes_filter=None):
    # Initialize sum of Amount
    global TOTAL_OTHER_FEES
    global OTHER_FEES
    total_amount = 0

    # Read CSV data
    csv_reader = csv.DictReader(csv_data.splitlines())
    for row in csv_reader:
        # Check if a filter on Notes is specified and apply it
        if notes_filter is None or row['Notes'] == notes_filter:
            # Sum the Amount column
            total_amount += float(row['Amount'])
        if row['Notes'] != None and row['Notes'] != "Circular payment routing fee" and row['Type'] == "fee:network":
            OTHER_FEES += f"  Type:{row['Notes']} : {float(row['Amount']):.2f} SATS Transaction Type: {row['Type']}\n"
            TOTAL_OTHER_FEES += float(row['Amount'])

    return total_amount

def process_invoice_csv(csv_data):
    # Filter and print relevant information
    #print("Others Income:")
    global TOTAL_OTHERS
    csv_reader = csv.DictReader(csv_data.splitlines())
    for row in csv_reader:
        if row['Notes'] != "":
            print(f"  Type:{row['Notes']} : {float(row['Amount']):.2f} SATS Transaction Type: {row['Type']}")
            TOTAL_OTHERS += float(row['Amount'])

def process_onchain_csv(csv_data):
    # Filter and print relevant information
    #print("Others Income:")
    csv_reader = csv.DictReader(csv_data.splitlines())
    for row in csv_reader:
        print(f"  Type:{row['Notes']} : {float(row['Amount']):.2f} SATS Transaction Type: {row['Type']}")

if __name__ == "__main__":
    # Get the current day and month
    current_date = datetime.now()
    day = current_date.day
    month = current_date.month

# Build commands
    rebalance_command = f"{FULL_PATH_BOS}bos accounting 'payments' --date {day} --month {month} --disable-fiat --csv"
    forwards_command = f"{FULL_PATH_BOS}bos accounting 'forwards' --date {day} --month {month} --disable-fiat --csv"
    invoices_command = f"{FULL_PATH_BOS}bos accounting 'invoices' --date {day} --month {month} --disable-fiat --csv"
    chainfees_command=f"{FULL_PATH_BOS}bos accounting 'chain-fees' --date {day} --month {month} --disable-fiat --csv"
    chainsends_command=f"{FULL_PATH_BOS}bos accounting 'chain-sends' --date {day} --month {month} --disable-fiat --csv"
    chainreceives_command=f"{FULL_PATH_BOS}bos accounting 'chain-receives' --date {day} --month {month} --disable-fiat --csv"

    # Execute the commands
    rebalance_output = execute_command(rebalance_command)
    forwards_output = execute_command(forwards_command)
    invoices_output = execute_command(invoices_command)
    chainfees_output = execute_command(chainfees_command)
    chainsends_output = execute_command(chainsends_command)
    chainreceives_output = execute_command(chainreceives_command)

    # Process CSV data and calculate sums
    total_rebalance_costs = process_csv(rebalance_output, notes_filter='Circular payment routing fee')
    total_forwards_income = process_csv(forwards_output)

    # Print the results with user-provided month and day
    print(f'\nNode: {NODE_NAME} - Date: {current_date.strftime("%Y-%m-%d %H:%M:%S")}')
    print(f'Forwards Income: {total_forwards_income:.2f} SATS')
    print(f'Rebalance Costs: {total_rebalance_costs:.2f} SATS')
    print(f'Daily Profit (Forwards and Rebals): {total_forwards_income + total_rebalance_costs:.2f} SATS')
   

   # Off-chain spend
    print("Others Off-Chain Spend:")
    print(OTHER_FEES)
    print(f"Total:{TOTAL_OTHER_FEES:.2f} SATS")
    # Process and print invoice data
    print("Others Off-Chain Incomes:")
    process_invoice_csv(invoices_output)

    print(f"Off-chain Operation Profit: {total_forwards_income + TOTAL_OTHERS + + TOTAL_OTHER_FEES + total_rebalance_costs:.2f} SATS")


    # Process on-chain balance
    print("\nOn-chain Balance:")
    print("On-chain Fees:")
    process_onchain_csv(chainfees_output)
    print("On-chain Sends:")
    process_onchain_csv(chainsends_output)
    print("On-chain Receives:")
    process_onchain_csv(chainreceives_output)