From d86d0ecaddc27b85053758fab55c3f72562dfd2a Mon Sep 17 00:00:00 2001
From: uvok
Date: Tue, 15 Apr 2025 13:34:53 +0200
Subject: Documentation
---
ledger_action.py | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
(limited to 'ledger_action.py')
diff --git a/ledger_action.py b/ledger_action.py
index 751d6b8..952692b 100644
--- a/ledger_action.py
+++ b/ledger_action.py
@@ -1,9 +1,23 @@
from dataclasses import dataclass
from decimal import Decimal
-from typing import Optional
@dataclass
class LedgerAction:
+ """
+ A structured representation of a ledger row for cryptocurrency transactions.
+
+ The `LedgerAction` class encapsulates details of each action recorded in the ledger,
+ whether it's a deposit, trade, or other types of transactions.
+
+ Attributes:
+ type (str): The type of action, e.g., "trade" or "deposit".
+ asset (str): The cryptocurrency or fiat asset associated with the action.
+ amount (Decimal): The amount involved in the action. Positive for deposits, negative for withdrawals.
+ fee (Decimal): The transaction fee (if applicable).
+ date (str): The date of the action in string format (typically "YYYY-MM-DD").
+ refid (str): A reference ID used to group related rows (e.g., EUR-crypto trades).
+ """
+
type: str
asset: str
amount: Decimal
--
cgit v1.2.3