summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-05-18 09:53:06 -0300
committerTorsten Grote <t@grobox.de>2020-05-18 09:53:06 -0300
commit07b15dd14a52805b8c7c6f2621182c750e1dcc62 (patch)
treea21dbbc598999e78cbe7ee2af28413977773b5df /taler-wallet.rst
parentb4e641db6d18897018f198834e731574b2770084 (diff)
downloaddocs-07b15dd14a52805b8c7c6f2621182c750e1dcc62.tar.gz
docs-07b15dd14a52805b8c7c6f2621182c750e1dcc62.tar.bz2
docs-07b15dd14a52805b8c7c6f2621182c750e1dcc62.zip
wallet API clarifications
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index 82296e5..0308e57 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -106,17 +106,17 @@ Balances are the amounts of digital cash held by the wallet.
currency?: string;
// The total Amount that is currently available to be spent
- // excluding amounts tied up in ongoing refresh operations. These are hidden from the user.
+ // including amounts tied up in ongoing refresh operations. These are hidden from the user.
// If the user tries to spend coins locked up this way,
// the wallet will give an error message different from "insufficient balance".
available: Amount;
// the total incoming amount that will be added to the available balance
- // when all pending transactions succeed (excluding internal refreshes)
+ // when all pending transactions succeed (including internal refreshes)
pendingIncoming: Amount;
// the total outgoing amount that will be subtracted from the available balance
- // when all pending transactions succeed (excluding internal refreshes)
+ // when all pending transactions succeed (including internal refreshes)
pendingOutgoing: Amount;
// true if the balance has pending transactions
@@ -151,7 +151,8 @@ Transactions are all operations or events that are affecting the balance.
// a list of past and pending transactions sorted by pending, timestamp and transactionId.
// In case two events are both pending and have the same timestamp,
// they are sorted by the transactionId
- // (lexically ascending and locale-independent comparison).
+ // (i.e. pending before non-pending transactions, newer before older
+ // and if all equal transactionId lexically ascending).
transactions: Transaction[];
}