dao-treasury 0.0.32__cp310-cp310-musllinux_1_2_i686.whl → 0.0.33__cp310-cp310-musllinux_1_2_i686.whl

dao_treasury/.grafana/provisioning/dashboards/treasury/Operating Cashflow.json

@@ -0,0 +1,491 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 1,
+  "links": [],
+  "liveNow": false,
+  "panels": [
+    {
+      "datasource": "SQLite",
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 4,
+        "w": 6,
+        "x": 0,
+        "y": 0
+      },
+      "id": 1,
+      "options": {
+        "colorMode": "value",
+        "graphMode": "area",
+        "justifyMode": "auto",
+        "orientation": "auto",
+        "reduceOptions": {
+          "calcs": [
+            "lastNotNull"
+          ],
+          "fields": "",
+          "values": false
+        },
+        "textMode": "auto"
+      },
+      "pluginVersion": "10.2.0",
+      "targets": [
+        {
+          "datasource": "SQLite",
+          "queryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Revenue' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "queryType": "table",
+          "rawQueryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Revenue' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "refId": "A",
+          "timeColumns": [
+            "time",
+            "ts"
+          ]
+        }
+      ],
+      "title": "Revenue",
+      "type": "stat"
+    },
+    {
+      "datasource": "SQLite",
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 4,
+        "w": 6,
+        "x": 6,
+        "y": 0
+      },
+      "id": 3,
+      "options": {
+        "colorMode": "value",
+        "graphMode": "area",
+        "justifyMode": "auto",
+        "orientation": "auto",
+        "reduceOptions": {
+          "calcs": [
+            "lastNotNull"
+          ],
+          "fields": "",
+          "values": false
+        },
+        "textMode": "auto"
+      },
+      "pluginVersion": "10.2.0",
+      "targets": [
+        {
+          "datasource": "SQLite",
+          "queryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Cost of Revenue' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "queryType": "table",
+          "rawQueryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Cost of Revenue' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "refId": "A",
+          "timeColumns": [
+            "time",
+            "ts"
+          ]
+        }
+      ],
+      "title": "Cost of Revenue",
+      "type": "stat"
+    },
+    {
+      "datasource": "SQLite",
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 4,
+        "w": 6,
+        "x": 12,
+        "y": 0
+      },
+      "id": 2,
+      "options": {
+        "colorMode": "value",
+        "graphMode": "area",
+        "justifyMode": "auto",
+        "orientation": "auto",
+        "reduceOptions": {
+          "calcs": [
+            "lastNotNull"
+          ],
+          "fields": "",
+          "values": false
+        },
+        "textMode": "auto"
+      },
+      "pluginVersion": "10.2.0",
+      "targets": [
+        {
+          "datasource": "SQLite",
+          "queryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Expenses' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "queryType": "table",
+          "rawQueryText": "SELECT SUM(t.value_usd) AS total_revenue FROM general_ledger t JOIN txgroup_hierarchy gh USING (txgroup_id) WHERE gh.top_category = 'Expenses' AND t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "refId": "A",
+          "timeColumns": [
+            "time",
+            "ts"
+          ]
+        }
+      ],
+      "title": "Expenses",
+      "type": "stat"
+    },
+    {
+      "datasource": "SQLite",
+      "description": "",
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "thresholds"
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 4,
+        "w": 6,
+        "x": 18,
+        "y": 0
+      },
+      "id": 10,
+      "options": {
+        "colorMode": "value",
+        "graphMode": "area",
+        "justifyMode": "auto",
+        "orientation": "auto",
+        "reduceOptions": {
+          "calcs": [
+            "lastNotNull"
+          ],
+          "fields": "",
+          "values": false
+        },
+        "textMode": "auto"
+      },
+      "pluginVersion": "10.2.0",
+      "targets": [
+        {
+          "datasource": "SQLite",
+          "queryText": "SELECT (\n  SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END)\n  - SUM(CASE WHEN gh.top_category = 'Cost of Revenue' THEN t.value_usd ELSE 0 END)\n  - SUM(CASE WHEN gh.top_category = 'Expenses' THEN t.value_usd ELSE 0 END)\n) AS total_net\nFROM general_ledger t\nJOIN txgroup_hierarchy gh USING (txgroup_id)\nWHERE t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "queryType": "table",
+          "rawQueryText": "SELECT (\n  SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END)\n  - SUM(CASE WHEN gh.top_category = 'Cost of Revenue' THEN t.value_usd ELSE 0 END)\n  - SUM(CASE WHEN gh.top_category = 'Expenses' THEN t.value_usd ELSE 0 END)\n) AS total_net\nFROM general_ledger t\nJOIN txgroup_hierarchy gh USING (txgroup_id)\nWHERE t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000",
+          "refId": "A",
+          "timeColumns": [
+            "time",
+            "ts"
+          ]
+        }
+      ],
+      "title": "Operating Total",
+      "type": "stat"
+    },
+    {
+      "datasource": "SQLite",
+      "description": "",
+      "fieldConfig": {
+        "defaults": {
+          "color": {
+            "mode": "palette-classic"
+          },
+          "custom": {
+            "axisBorderShow": false,
+            "axisCenteredZero": false,
+            "axisColorMode": "text",
+            "axisLabel": "",
+            "axisPlacement": "auto",
+            "barAlignment": 0,
+            "drawStyle": "bars",
+            "fillOpacity": 70,
+            "gradientMode": "none",
+            "hideFrom": {
+              "legend": false,
+              "tooltip": false,
+              "viz": false
+            },
+            "insertNulls": false,
+            "lineInterpolation": "linear",
+            "lineWidth": 1,
+            "pointSize": 5,
+            "scaleDistribution": {
+              "type": "linear"
+            },
+            "showPoints": "auto",
+            "spanNulls": false,
+            "stacking": {
+              "group": "A",
+              "mode": "normal"
+            },
+            "thresholdsStyle": {
+              "mode": "off"
+            }
+          },
+          "mappings": [],
+          "thresholds": {
+            "mode": "absolute",
+            "steps": [
+              {
+                "color": "green",
+                "value": null
+              },
+              {
+                "color": "red",
+                "value": 80
+              }
+            ]
+          }
+        },
+        "overrides": [
+          {
+            "matcher": {
+              "id": "byName",
+              "options": "Net (sum)"
+            },
+            "properties": [
+              {
+                "id": "custom.drawStyle",
+                "value": "line"
+              },
+              {
+                "id": "custom.stacking",
+                "value": {
+                  "group": "A",
+                  "mode": "none"
+                }
+              },
+              {
+                "id": "custom.fillOpacity",
+                "value": 19
+              }
+            ]
+          }
+        ]
+      },
+      "gridPos": {
+        "h": 12,
+        "w": 24,
+        "x": 0,
+        "y": 4
+      },
+      "id": 11,
+      "options": {
+        "legend": {
+          "calcs": [],
+          "displayMode": "list",
+          "placement": "bottom",
+          "showLegend": true
+        },
+        "tooltip": {
+          "mode": "single",
+          "sort": "none"
+        }
+      },
+      "targets": [
+        {
+          "datasource": "SQLite",
+          "queryText": "SELECT t.timestamp,\r\n       SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END) AS \"Total Revenue\",\r\n       SUM(CASE WHEN gh.top_category in ('Cost of Revenue','Expenses') THEN t.value_usd ELSE 0 END) * -1 AS \"Total Expenses\",\r\n       SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END) - SUM(CASE WHEN gh.top_category in ('Cost of Revenue','Expenses') THEN t.value_usd ELSE 0 END) AS \"Net\"\r\nFROM general_ledger AS t\r\nJOIN txgroup_hierarchy gh ON t.txgroup_id = gh.txgroup_id\r\nWHERE t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000\r\nGROUP BY timestamp\r\nORDER BY timestamp;",
+          "queryType": "table",
+          "rawQueryText": "SELECT t.timestamp,\r\n       SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END) AS \"Total Revenue\",\r\n       SUM(CASE WHEN gh.top_category in ('Cost of Revenue','Expenses') THEN t.value_usd ELSE 0 END) * -1 AS \"Total Expenses\",\r\n       SUM(CASE WHEN gh.top_category = 'Revenue' THEN t.value_usd ELSE 0 END) - SUM(CASE WHEN gh.top_category in ('Cost of Revenue','Expenses') THEN t.value_usd ELSE 0 END) AS \"Net\"\r\nFROM general_ledger AS t\r\nJOIN txgroup_hierarchy gh ON t.txgroup_id = gh.txgroup_id\r\nWHERE t.timestamp >= $__from/1000 AND t.timestamp <= $__to/1000\r\nGROUP BY timestamp\r\nORDER BY timestamp;",
+          "refId": "A",
+          "timeColumns": [
+            "timestamp"
+          ]
+        }
+      ],
+      "title": "Weekly Cashflow",
+      "transformations": [
+        {
+          "id": "formatTime",
+          "options": {
+            "outputFormat": "YYYY-WW",
+            "timeField": "timestamp",
+            "timezone": "browser",
+            "useTimezone": true
+          }
+        },
+        {
+          "id": "convertFieldType",
+          "options": {
+            "conversions": [
+              {
+                "destinationType": "time",
+                "targetField": "timestamp"
+              }
+            ],
+            "fields": {}
+          }
+        },
+        {
+          "id": "groupBy",
+          "options": {
+            "fields": {
+              "Cost of Revenue": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Expenses": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Net": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Other Expenses": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Other Income": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Revenue": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Timestamp": {
+                "aggregations": [],
+                "operation": "groupby"
+              },
+              "Total Expenses": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "Total Revenue": {
+                "aggregations": [
+                  "sum"
+                ],
+                "operation": "aggregate"
+              },
+              "timestamp": {
+                "aggregations": [],
+                "operation": "groupby"
+              }
+            }
+          }
+        }
+      ],
+      "type": "timeseries"
+    }
+  ],
+  "refresh": "",
+  "schemaVersion": 38,
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6M",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "Operating Cashflow Summary",
+  "uid": "fdf9969c-357a-4203-ae7b-12816e87bc7e",
+  "version": 1,
+  "weekStart": ""
+}

dao_treasury/db.py

@@ -119,13 +119,13 @@ class Chain(DbEntity):
     chainid = Required(int, unique=True)
     """Numeric chain ID matching the connected RPC via :data:`~y.constants.CHAINID`."""
 
-    addresses = Set("Address", reverse="chain")
+    addresses = Set("Address", reverse="chain", lazy=True)
     """Relationship to address records on this chain."""
 
-    tokens = Set("Token", reverse="chain")
+    tokens = Set("Token", reverse="chain", lazy=True)
     """Relationship to token records on this chain."""
 
-    treasury_txs = Set("TreasuryTx")
+    treasury_txs = Set("TreasuryTx", lazy=True)
     """Relationship to treasury transactions on this chain."""
 
     @staticmethod
@@ -184,7 +184,7 @@ class Address(DbEntity):
     address_id = PrimaryKey(int, auto=True)
     """Auto-incremented primary key for the addresses table."""
 
-    chain = Required(Chain, reverse="addresses")
+    chain = Required(Chain, reverse="addresses", lazy=True)
     """Reference to the chain on which this address resides."""
 
     address = Required(str, index=True)
@@ -193,7 +193,7 @@ class Address(DbEntity):
     nickname = Optional(str)
     """Optional human-readable label (e.g., contract name or token name)."""
 
-    is_contract = Required(bool, index=True)
+    is_contract = Required(bool, index=True, lazy=True)
     """Flag indicating whether the address is a smart contract."""
 
     composite_key(address, chain)
@@ -204,22 +204,22 @@ class Address(DbEntity):
         treasury_tx_from: Set["TreasuryTx"]
         treasury_tx_to: Set["TreasuryTx"]
 
-    token = Optional("Token", index=True)
+    token = Optional("Token", index=True, lazy=True)
     """Optional back-reference to a Token if this address is one."""
-    # partners_tx = Set('PartnerHarvestEvent', reverse='wrapper')
+    # partners_tx = Set('PartnerHarvestEvent', reverse='wrapper', lazy=True)
 
-    treasury_tx_from = Set("TreasuryTx", reverse="from_address")
+    treasury_tx_from = Set("TreasuryTx", reverse="from_address", lazy=True)
     """Inverse relation for transactions sent from this address."""
 
-    treasury_tx_to = Set("TreasuryTx", reverse="to_address")
+    treasury_tx_to = Set("TreasuryTx", reverse="to_address", lazy=True)
     """Inverse relation for transactions sent to this address."""
 
-    streams_from = Set("Stream", reverse="from_address")
-    streams_to = Set("Stream", reverse="to_address")
-    streams = Set("Stream", reverse="contract")
-    # vesting_escrows = Set("VestingEscrow", reverse="address")
-    # vests_received = Set("VestingEscrow", reverse="recipient")
-    # vests_funded = Set("VestingEscrow", reverse="funder")
+    streams_from = Set("Stream", reverse="from_address", lazy=True)
+    streams_to = Set("Stream", reverse="to_address", lazy=True)
+    streams = Set("Stream", reverse="contract", lazy=True)
+    # vesting_escrows = Set("VestingEscrow", reverse="address", lazy=True)
+    # vests_received = Set("VestingEscrow", reverse="recipient", lazy=True)
+    # vests_funded = Set("VestingEscrow", reverse="funder", lazy=True)
 
     def __eq__(self, other: Union["Address", ChecksumAddress, "Token"]) -> bool:  # type: ignore [override]
         if isinstance(other, str):
@@ -367,30 +367,30 @@ class Token(DbEntity):
     token_id = PrimaryKey(int, auto=True)
     """Auto-incremented primary key for the tokens table."""
 
-    chain = Required(Chain, index=True)
+    chain = Required(Chain, index=True, lazy=True)
     """Foreign key linking to :class:`~dao_treasury.db.Chain`."""
 
-    symbol = Required(str, index=True)
+    symbol = Required(str, index=True, lazy=True)
     """Short ticker symbol for the token."""
 
-    name = Required(str)
+    name = Required(str, lazy=True)
     """Full human-readable name of the token."""
 
-    decimals = Required(int)
+    decimals = Required(int, lazy=True)
     """Number of decimals used for value scaling."""
 
     if TYPE_CHECKING:
         treasury_tx: Set["TreasuryTx"]
 
-    treasury_tx = Set("TreasuryTx", reverse="token")
+    treasury_tx = Set("TreasuryTx", reverse="token", lazy=True)
     """Inverse relation for treasury transactions involving this token."""
-    # partner_harvest_event = Set('PartnerHarvestEvent', reverse="vault")
+    # partner_harvest_event = Set('PartnerHarvestEvent', reverse="vault", lazy=True)
 
     address = Required(Address, column="address_id")
     """Foreign key to the address record for this token contract."""
 
-    streams = Set("Stream", reverse="token")
-    # vesting_escrows = Set("VestingEscrow", reverse="token")
+    streams = Set("Stream", reverse="token", lazy=True)
+    # vesting_escrows = Set("VestingEscrow", reverse="token", lazy=True)
 
     def __eq__(self, other: Union["Token", Address, ChecksumAddress]) -> bool:  # type: ignore [override]
         if isinstance(other, str):
@@ -533,7 +533,7 @@ class TxGroup(DbEntity):
     name = Required(str)
     """Name of the grouping category, e.g., 'Revenue', 'Expenses'."""
 
-    treasury_tx = Set("TreasuryTx", reverse="txgroup")
+    treasury_tx = Set("TreasuryTx", reverse="txgroup", lazy=True)
     """Inverse relation for treasury transactions assigned to this group."""
 
     parent_txgroup = Optional("TxGroup", reverse="child_txgroups")
@@ -541,13 +541,13 @@ class TxGroup(DbEntity):
 
     composite_key(name, parent_txgroup)
 
-    child_txgroups = Set("TxGroup", reverse="parent_txgroup")
+    child_txgroups = Set("TxGroup", reverse="parent_txgroup", lazy=True)
     """Set of nested child groups."""
 
-    streams = Set("Stream", reverse="txgroup")
+    streams = Set("Stream", reverse="txgroup", lazy=True)
 
     # TODO: implement this
-    # vesting_escrows = Set("VestingEscrow", reverse="txgroup")
+    # vesting_escrows = Set("VestingEscrow", reverse="txgroup", lazy=True)
 
     @property
     def fullname(self) -> str:
@@ -623,7 +623,7 @@ class TxGroup(DbEntity):
         return txgroup  # type: ignore [no-any-return]
 
 
-@lru_cache(100)
+@lru_cache(500)
 def get_transaction(txhash: str) -> TransactionReceipt:
     """Fetch and cache a transaction receipt from the connected chain.
 
@@ -905,6 +905,7 @@ class TreasuryTx(DbEntity):
     def __set_txgroup(treasury_tx_dbid: int, txgroup_dbid: TxGroupDbid) -> None:
         with db_session:
             TreasuryTx[treasury_tx_dbid].txgroup = txgroup_dbid
+            commit()
 
 
 _stream_metadata_cache: Final[Dict[HexStr, Tuple[ChecksumAddress, date]]] = {}
@@ -925,9 +926,9 @@ class Stream(DbEntity):
     status = Required(str, default="Active")
     txgroup = Optional("TxGroup", reverse="streams")
 
-    streamed_funds = Set("StreamedFunds")
+    streamed_funds = Set("StreamedFunds", lazy=True)
 
-    scale = int(1e20)
+    scale = 10**20
 
     @property
     def is_alive(self) -> bool:
@@ -1089,7 +1090,7 @@ def create_stream_ledger_view() -> None:
                 symbol as token, 
                 d.address AS "from", 
                 d.nickname as from_nickname, 
-                e.address as "to", 
+                e.address AS "to", 
                 e.nickname as to_nickname, 
                 amount, 
                 price, 
@@ -1108,6 +1109,31 @@ def create_stream_ledger_view() -> None:
     )
 
 
+def create_txgroup_hierarchy_view() -> None:
+    """Create or replace the SQL view `txgroup_hierarchy` for recursive txgroup hierarchy.
+
+    This view exposes txgroup_id, top_category, and parent_txgroup for all txgroups,
+    matching the recursive CTE logic used in dashboards.
+    """
+    db.execute("DROP VIEW IF EXISTS txgroup_hierarchy;")
+    db.execute(
+        """
+        CREATE VIEW txgroup_hierarchy AS
+        WITH RECURSIVE group_hierarchy (txgroup_id, top_category, parent_txgroup) AS (
+            SELECT txgroup_id, name AS top_category, parent_txgroup
+            FROM txgroups
+            WHERE parent_txgroup IS NULL
+            UNION ALL
+            SELECT child.txgroup_id, parent.top_category, child.parent_txgroup
+            FROM txgroups AS child
+            JOIN group_hierarchy AS parent
+                ON child.parent_txgroup = parent.txgroup_id
+        )
+        SELECT * FROM group_hierarchy;
+        """
+    )
+
+
 def create_vesting_ledger_view() -> None:
     """Create or replace the SQL view `vesting_ledger` for vesting escrow reporting.
 
@@ -1250,6 +1276,7 @@ def create_monthly_pnl_view() -> None:
 
 with db_session:
     create_stream_ledger_view()
+    create_txgroup_hierarchy_view()
     # create_vesting_ledger_view()
     create_general_ledger_view()
     create_unsorted_txs_view()