taler-docs

commit fef36ff01241803b3eddbe5d053afe47b17b71f7
parent a2d2d69a880de766a2487f557f124aae7baa37f8
Author: Florian Dold <florian@dold.me>
Date:   Wed,  4 Dec 2024 22:50:51 +0100

update wallet-core docs

Diffstat:
M
wallet/wallet-core.md
 | 
84
+++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------

1 file changed, 57 insertions(+), 27 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -395,8 +395,18 @@ export type GetMaxDepositAmountOp = {
 ```
 ```typescript
 export interface GetMaxDepositAmountRequest {
+  /**
+   * Currency to deposit.
+   */
   currency: string;
+  /**
+   * Target bank account to deposit into.
+   */
   depositPaytoUri?: string;
+  /**
+   * Restrict the deposit to a certain scope.
+   */
+  restrictScope?: ScopeInfo;
 }
 
 ```
@@ -404,6 +414,14 @@ export interface GetMaxDepositAmountRequest {
 export interface GetMaxDepositAmountResponse {
   effectiveAmount: AmountString;
   rawAmount: AmountString;
+  /**
+   * Account restrictions that affect the max deposit amount.
+   */
+  depositRestrictions?: {
+    [exchangeBaseUrl: string]: {
+      [paytoUri: string]: AccountRestriction[];
+    };
+  };
 }
 
 ```
@@ -3066,13 +3084,29 @@ export type WithdrawTestBalanceOp = {
 ```
 ```typescript
 export interface WithdrawTestBalanceRequest {
+  /**
+   * Amount to withdraw.
+   */
   amount: AmountString;
   /**
    * Corebank API base URL.
    */
   corebankApiBaseUrl: string;
+  /**
+   * Exchange to use for withdrawal.
+   */
   exchangeBaseUrl: string;
+  /**
+   * Force the usage of a particular denomination selection.
+   *
+   * Only useful for testing.
+   */
   forcedDenomSel?: ForcedDenomSel;
+  /**
+   * If set to true, treat the account created during
+   * the withdrawal as a foreign withdrawal account.
+   */
+  useForeignAccount?: boolean;
 }
 
 ```
@@ -3698,6 +3732,29 @@ export type AmountString =
   | LitAmountString;
 ```
 ```typescript
+export type AccountRestriction =
+  | RegexAccountRestriction
+  | DenyAllAccountRestriction;
+```
+```typescript
+export interface RegexAccountRestriction {
+  type: "regex";
+  payto_regex: string;
+  human_hint: string;
+  human_hint_i18n?: InternationalizedString;
+}
+```
+```typescript
+export interface InternationalizedString {
+  [lang_tag: string]: string;
+}
+```
+```typescript
+export interface DenyAllAccountRestriction {
+  type: "deny";
+}
+```
+```typescript
 export interface TransactionsResponse {
   transactions: Transaction[];
 }
@@ -4046,29 +4103,6 @@ export interface CurrencySpecification {
 }
 ```
 ```typescript
-export type AccountRestriction =
-  | RegexAccountRestriction
-  | DenyAllAccountRestriction;
-```
-```typescript
-export interface RegexAccountRestriction {
-  type: "regex";
-  payto_regex: string;
-  human_hint: string;
-  human_hint_i18n?: InternationalizedString;
-}
-```
-```typescript
-export interface InternationalizedString {
-  [lang_tag: string]: string;
-}
-```
-```typescript
-export interface DenyAllAccountRestriction {
-  type: "deny";
-}
-```
-```typescript
 interface WithdrawalDetailsForTalerBankIntegrationApi {
   type: WithdrawalType.TalerBankIntegrationApi;
   /**
@@ -4102,10 +4136,6 @@ export interface TransactionPayment extends TransactionCommon {
    */
   info: OrderShortInfo;
   /**
-   * Wallet-internal end-to-end identifier for the payment.
-   */
-  proposalId: string;
-  /**
    * Amount that must be paid for the contract
    */
   amountRaw: AmountString;