taler-docs

commit 44f26af9a01c76e7aa9d1ac973630269a6f28bd5
parent 0354eaa48cf1882825396cef315dfb4ccf8e633d
Author: Antoine A <>
Date:   Wed,  8 Nov 2023 17:41:31 +0000

Update bank spec

Diffstat:
M
core/api-corebank.rst
 | 
44
++++++++++++++++++++++++--------------------

1 file changed, 24 insertions(+), 20 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -1055,14 +1055,14 @@ Monitor
     
     // Union discriminated by the "type" field.
     type MonitorResponse =
-      | MonitorJustPayouts
-      | MonitorWithCashout;
+      | MonitorNoConversion
+      | MonitorWithConversion;
 
-  .. ts:def:: MonitorJustPayouts
+  .. ts:def:: MonitorNoConversion
 
     // Monitoring stats when conversion is not supported
-    interface MonitorJustPayouts {
-      type: "just-payouts";
+    interface MonitorNoConversion {
+      type: "no-conversions";
 
       // How many payments were made to a Taler exchange by another
       // internal bank account.
@@ -1070,7 +1070,7 @@ Monitor
 
       // Overall *internal* currency that has been paid to a Taler 
       // exchange by another bank account.
-      talerInInternalVolume: Amount;
+      talerInVolume: Amount;
 
       // How many payments were made by a Taler exchange to another
       // internal bank account.
@@ -1078,33 +1078,37 @@ Monitor
 
       // Overall *internal* currency that has been paid by a Taler 
       // exchange to another bank account.
-      talerOutInternalVolume: Amount;
+      talerOutVolume: Amount;
     }
 
-  .. ts:def:: MonitorWithCashout
+  .. ts:def:: MonitorWithConversion
 
     // Monitoring stats when conversion is supported
-    interface MonitorWithCashout {
-      type: "with-cashout";
+    interface MonitorWithConversion {
+      type: "with-conversions";
 
       // How many cashin operations were confirmed by a 
       // wallet owner. Note: wallet owners
       // are NOT required to be customers of the libeufin-bank.
       cashinCount: number;
 
-      // Overall *external* currency that has been spend to withdraw 
-      // Taler coins in the internal currency.
-      // The exact amount of internal currency being created can be
-      // calculated using the advertised conversion rates.
+      // Overall *internal* currency that has been paid by the internal admin account
+      // to internal bank accounts to fulfill all the confirmed cashin operations.
+      cashinInternalVolume: Amount;
+
+      // Overall *external* currency that has been paid to the external admin account
+      // by external bank accounts to fulfill all the confirmed cashin operations.
       cashinExternalVolume: Amount;
 
       // How many cashout operations were confirmed.
       cashoutCount: number;
 
-      // Overall *external* currency that has been paid by the libeufin-bank
-      // administrator to fulfill all the confirmed cashouts.
-      // The exact amount of internal currency being created can be
-      // calculated using the advertised conversion rates.
+      // Overall *internal* currency that has been paid to the internal admin account
+      // by internal bank accounts to fulfill all the confirmed cashout operations.
+      cashoutInternalVolume: Amount;
+
+      // Overall *external* currency that has been paid by the external admin account
+      // to external bank accounts to fulfill all the confirmed cashout operations.
       cashoutExternalVolume: Amount;
 
       // How many payments were made to a Taler exchange by another
@@ -1113,7 +1117,7 @@ Monitor
 
       // Overall *internal* currency that has been paid to a Taler 
       // exchange by another bank account.
-      talerInInternalVolume: Amount;
+      talerInVolume: Amount;
 
       // How many payments were made by a Taler exchange to another
       // internal bank account.
@@ -1121,7 +1125,7 @@ Monitor
 
       // Overall *internal* currency that has been paid by a Taler 
       // exchange to another bank account.
-      talerOutInternalVolume: Amount;
+      talerOutVolume: Amount;
     }