summaryrefslogtreecommitdiff
path: root/core/api-exchange.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2022-10-15 22:15:33 +0200
committerChristian Grothoff <christian@grothoff.org>2022-10-15 22:15:33 +0200
commit6bac387380e919efb59d35edfcf5e357e8583478 (patch)
tree82cf9c19199e9e18d46e26bf4349f8dc7a919215 /core/api-exchange.rst
parent9bcd38bb77f935f9eaf83d86e2b1df900c11e563 (diff)
downloaddocs-6bac387380e919efb59d35edfcf5e357e8583478.tar.gz
docs-6bac387380e919efb59d35edfcf5e357e8583478.tar.bz2
docs-6bac387380e919efb59d35edfcf5e357e8583478.zip
-update docs
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r--core/api-exchange.rst80
1 files changed, 57 insertions, 23 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 7fc86a2d..79f82d6e 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1348,6 +1348,8 @@ exchange.
| ReserveWithdrawTransaction
| ReserveCreditTransaction
| ReserveClosingTransaction
+ | ReserveOpenRequestTransaction
+ | ReserveCloseRequestTransaction
| PurseMergeTransaction;
.. ts:def:: PurseMergeTransaction
@@ -1556,27 +1558,64 @@ exchange.
}
- .. ts:def:: ReserveRecoupTransaction
+ .. ts:def:: ReserveOpenRequestTransaction
- interface ReserveRecoupTransaction {
- type: "RECOUP";
+ interface ReserveOpenRequestTransaction {
+ type: "OPEN";
- // Amount paid back.
- amount: Amount;
+ // Open fee paid from the reserve.
+ open_fee: Amount;
// This is a signature over
- // a struct `TALER_RecoupConfirmationPS` with purpose
- // ``TALER_SIGNATURE_EXCHANGE_CONFIRM_RECOUP``.
- exchange_sig: EddsaSignature;
+ // a struct `TALER_ReserveOpenPS` with purpose
+ // ``TALER_SIGNATURE_WALLET_RESERVE_OPEN``.
+ reserve_sig: EddsaSignature;
- // Public key used to create 'exchange_sig'.
- exchange_pub: EddsaPublicKey;
+ // Timestamp of the open request.
+ request_timestamp: Timestamp;
- // Time when the funds were paid back into the reserve.
- timestamp: Timestamp;
+ // Requested expiration.
+ requested_expiration: Timestamp;
- // Public key of the coin that was paid back.
- coin_pub: CoinPublicKey;
+ // Requested number of free open purses.
+ requested_min_purses: Integer;
+
+ }
+
+ .. ts:def:: ReserveCloseRequestTransaction
+
+ interface ReserveCloseRequestTransaction {
+ type: "CLOSE";
+
+ // This is a signature over
+ // a struct `TALER_ReserveClosePS` with purpose
+ // ``TALER_SIGNATURE_WALLET_RESERVE_CLOSE``.
+ reserve_sig: EddsaSignature;
+
+ // Target account ``payto://``, optional.
+ h_payto?: string;
+
+ // Timestamp of the close request.
+ request_timestamp: Timestamp;
+ }
+
+ .. ts:def:: ReserveCreditTransaction
+
+ interface ReserveCreditTransaction {
+ type: "CREDIT";
+
+ // Amount deposited.
+ amount: Amount;
+
+ // Sender account ``payto://`` URL.
+ sender_account_url: string;
+
+ // Opaque identifier internal to the exchange that
+ // uniquely identifies the wire transfer that credited the reserve.
+ wire_reference: Integer;
+
+ // Timestamp of the incoming wire transfer.
+ timestamp: Timestamp;
}
@@ -2131,10 +2170,10 @@ proof to the seller for the escrow of sufficient fund.
// CAVEAT: THIS IS WORK IN PROGRESS
// (Optional) policy for the deposit.
// This might be a refund, auction or escrow policy.
- //
+ //
// Note that support for policies is an optional feature of the exchange.
// Optional features are so called "extensions" in Taler. The exchange
- // provides the list of supported extensions, including policies, in the
+ // provides the list of supported extensions, including policies, in the
// `ExtensionsManifestsResponse` response to the ``/keys`` endpoint.
policy?: DepositPolicy;
@@ -2226,7 +2265,7 @@ proof to the seller for the escrow of sufficient fund.
commitment: Amount;
// Date until the auction must have been successfully executed and
- // a valid transcript provided to the
+ // a valid transcript provided to the
// ``/extensions/policy_brandt_vickrey_auction``-endpoint of the
// exchange.
//
@@ -2257,7 +2296,7 @@ proof to the seller for the escrow of sufficient fund.
// This integer m refers to the (m+1)-type of the Brandt-Vickrey-auction.
// - Type 0 refers to an auction with one highest-price winner,
- // - Type 1 refers to an auction with one winner, paying the second
+ // - Type 1 refers to an auction with one winner, paying the second
// highest price,
// - Type 2 refers to an auction with two winners, paying
// the third-highest price,
@@ -2627,11 +2666,6 @@ proof to the seller for the escrow of sufficient fund.
// fee will be waived.
refund_fee: Amount;
- // Share of the purse fee charged to this coin.
- // The sum of all purse fee shares will match the
- // total purse fee.
- purse_fee_share: Amount;
-
// Public key of the purse that expired.
purse_pub: EddsaPublicKey;