[taler-docs] branch master updated: wallet-core api docs

[gnunet]

This is an automated email from the git hooks/post-receive script.

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new d407e3ed wallet-core api docs
d407e3ed is described below

commit d407e3ed76fb75fcbb3e9bd7020070b43ca3e847
Author: Florian Dold <florian@dold.me>
AuthorDate: Thu May 16 13:24:25 2024 +0200

    wallet-core api docs
---
 wallet/wallet-core.md | 258 ++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 238 insertions(+), 20 deletions(-)

diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
index 8c600081..56388f82 100644
--- a/wallet/wallet-core.md
+++ b/wallet/wallet-core.md
@@ -3,8 +3,10 @@ This file is auto-generated from 
[wallet-core](https://git.taler.net/wallet-core
 ## Overview
 ### Unknown Group
 * [InitWalletOp](#initwalletop)
+* [ShutdownOp](#shutdownop)
 * [SetWalletRunConfigOp](#setwalletrunconfigop)
 * [GetVersionOp](#getversionop)
+* [HintNetworkAvailabilityOp](#hintnetworkavailabilityop)
 ###  Basic Wallet Information
 * [GetBalancesOp](#getbalancesop)
 * [GetBalancesDetailOp](#getbalancesdetailop)
@@ -30,11 +32,14 @@ This file is auto-generated from 
[wallet-core](https://git.taler.net/wallet-core
 ###  Withdrawals
 * [GetWithdrawalDetailsForAmountOp](#getwithdrawaldetailsforamountop)
 * [GetWithdrawalDetailsForUriOp](#getwithdrawaldetailsforuriop)
+* [PrepareBankIntegratedWithdrawalOp](#preparebankintegratedwithdrawalop)
+* [ConfirmWithdrawalOp](#confirmwithdrawalop)
 * [AcceptBankIntegratedWithdrawalOp](#acceptbankintegratedwithdrawalop)
 * [AcceptManualWithdrawalOp](#acceptmanualwithdrawalop)
 ###  Merchant Payments
 * [PreparePayForUriOp](#preparepayforuriop)
 * [SharePaymentOp](#sharepaymentop)
+* [CheckPayForTemplateOp](#checkpayfortemplateop)
 * [PreparePayForTemplateOp](#preparepayfortemplateop)
 * [GetContractTermsDetailsOp](#getcontracttermsdetailsop)
 * [ConfirmPayOp](#confirmpayop)
@@ -92,6 +97,7 @@ This file is auto-generated from 
[wallet-core](https://git.taler.net/wallet-core
 * [ConfirmPeerPullDebitOp](#confirmpeerpulldebitop)
 ###  Data Validation
 * [ValidateIbanOp](#validateibanop)
+* [CanonicalizeBaseUrlOp](#canonicalizebaseurlop)
 ###  Database Management
 * [ExportDbOp](#exportdbop)
 * [ImportDbOp](#importdbop)
@@ -111,9 +117,11 @@ This file is auto-generated from 
[wallet-core](https://git.taler.net/wallet-core
 * [TestingSetTimetravelOp](#testingsettimetravelop)
 * [TestingListTasksForTransactionOp](#testinglisttasksfortransactionop)
 * [TestingWaitTransactionsFinalOp](#testingwaittransactionsfinalop)
+* [TestingWaitTasksDoneOp](#testingwaittasksdoneop)
 * [TestingWaitRefreshesFinalOp](#testingwaitrefreshesfinalop)
 * [TestingWaitTransactionStateOp](#testingwaittransactionstateop)
 * [TestingPingOp](#testingpingop)
+* [TestingGetReserveHistoryOp](#testinggetreservehistoryop)
 * [TestingGetDenomStatsOp](#testinggetdenomstatsop)
 * [SetCoinSuspendedOp](#setcoinsuspendedop)
 * [ForceRefreshOp](#forcerefreshop)
@@ -134,6 +142,17 @@ export type InitWalletOp = {
 
 ```
 
+### ShutdownOp
+```typescript
+export type ShutdownOp = {
+  op: WalletApiOperation.Shutdown;
+  request: EmptyObject;
+  response: EmptyObject;
+};
+// Shutdown = "shutdown"
+
+```
+
 ### SetWalletRunConfigOp
 ```typescript
 /**
@@ -161,6 +180,23 @@ export type GetVersionOp = {
 
 ```
 
+### HintNetworkAvailabilityOp
+```typescript
+export type HintNetworkAvailabilityOp = {
+  op: WalletApiOperation.HintNetworkAvailability;
+  request: HintNetworkAvailabilityRequest;
+  response: EmptyObject;
+};
+// HintNetworkAvailability = "hintNetworkAvailability"
+
+```
+```typescript
+export interface HintNetworkAvailabilityRequest {
+  isNetworkAvailable: boolean;
+}
+
+```
+
 ### GetBalancesOp
 ```typescript
 /**
@@ -645,6 +681,18 @@ export interface GetWithdrawalDetailsForAmountRequest {
   exchangeBaseUrl: string;
   amount: AmountString;
   restrictAge?: number;
+  /**
+   * ID provided by the client to cancel the request.
+   *
+   * If the same request is made again with the same clientCancellationId,
+   * all previous requests are cancelled.
+   *
+   * The cancelled request will receive an error response with
+   * an error code that indicates the cancellation.
+   *
+   * The cancellation is best-effort, responses might still arrive.
+   */
+  clientCancellationId?: string;
 }
 
 ```
@@ -711,7 +759,6 @@ export type GetWithdrawalDetailsForUriOp = {
 export interface GetWithdrawalDetailsForUriRequest {
   talerWithdrawUri: string;
   restrictAge?: number;
-  notifyChangeFromPendingTimeoutMs?: number;
 }
 
 ```
@@ -735,10 +782,61 @@ export type WithdrawalOperationStatus =
 
 ```
 
+### PrepareBankIntegratedWithdrawalOp
+```typescript
+/**
+ * Prepare a bank-integrated withdrawal operation.
+ */
+export type PrepareBankIntegratedWithdrawalOp = {
+  op: WalletApiOperation.PrepareBankIntegratedWithdrawal;
+  request: PrepareBankIntegratedWithdrawalRequest;
+  response: PrepareBankIntegratedWithdrawalResponse;
+};
+// PrepareBankIntegratedWithdrawal = "prepareBankIntegratedWithdrawal"
+
+```
+```typescript
+export interface PrepareBankIntegratedWithdrawalRequest {
+  talerWithdrawUri: string;
+  exchangeBaseUrl: string;
+  forcedDenomSel?: ForcedDenomSel;
+  restrictAge?: number;
+}
+
+```
+```typescript
+export interface PrepareBankIntegratedWithdrawalResponse {
+  transactionId: string;
+}
+
+```
+
+### ConfirmWithdrawalOp
+```typescript
+/**
+ * Confirm a withdrawal transaction.
+ */
+export type ConfirmWithdrawalOp = {
+  op: WalletApiOperation.ConfirmWithdrawal;
+  request: ConfirmWithdrawalRequest;
+  response: EmptyObject;
+};
+// ConfirmWithdrawal = "confirmWithdrawal"
+
+```
+```typescript
+export interface ConfirmWithdrawalRequest {
+  transactionId: string;
+}
+
+```
+
 ### AcceptBankIntegratedWithdrawalOp
 ```typescript
 /**
  * Accept a bank-integrated withdrawal.
+ *
+ * @deprecated in favor of prepare/confirm withdrawal.
  */
 export type AcceptBankIntegratedWithdrawalOp = {
   op: WalletApiOperation.AcceptBankIntegratedWithdrawal;
@@ -784,6 +882,14 @@ export interface AcceptManualWithdrawalRequest {
   exchangeBaseUrl: string;
   amount: AmountString;
   restrictAge?: number;
+  /**
+   * Instead of generating a fresh, random reserve key pair,
+   * use the provided reserve private key.
+   *
+   * Use with caution.  Usage of this field may be restricted
+   * to developer mode.
+   */
+  forceReservePriv?: EddsaPrivateKeyString;
 }
 
 ```
@@ -849,6 +955,53 @@ export interface SharePaymentResult {
 
 ```
 
+### CheckPayForTemplateOp
+```typescript
+export type CheckPayForTemplateOp = {
+  op: WalletApiOperation.CheckPayForTemplate;
+  request: CheckPayTemplateRequest;
+  response: TalerMerchantApi.WalletTemplateDetails;
+};
+// CheckPayForTemplate = "checkPayForTemplate"
+
+```
+```typescript
+export interface CheckPayTemplateRequest {
+  talerPayTemplateUri: string;
+}
+
+```
+```typescript
+export interface WalletTemplateDetails {
+  template_contract: TemplateContractDetails;
+  editable_defaults?: TemplateContractDetailsDefaults;
+  required_currency?: string;
+}
+
+```
+```typescript
+export interface TemplateContractDetails {
+  summary?: string;
+  currency?: string;
+  amount?: AmountString;
+  minimum_age: Integer;
+  pay_duration: RelativeTime;
+}
+
+```
+```typescript
+export interface TemplateContractDetailsDefaults {
+  summary?: string;
+  currency?: string;
+  /**
+   * Amount *or* a plain currency string.
+   */
+  amount?: string;
+  minimum_age?: Integer;
+}
+
+```
+
 ### PreparePayForTemplateOp
 ```typescript
 /**
@@ -882,7 +1035,8 @@ export type GetContractTermsDetailsOp = {
 ```
 ```typescript
 export interface GetContractTermsDetailsRequest {
-  proposalId: string;
+  proposalId?: string;
+  transactionId?: string;
 }
 
 ```
@@ -2374,6 +2528,29 @@ export interface ValidateIbanResponse {
 
 ```
 
+### CanonicalizeBaseUrlOp
+```typescript
+export type CanonicalizeBaseUrlOp = {
+  op: WalletApiOperation.CanonicalizeBaseUrl;
+  request: CanonicalizeBaseUrlRequest;
+  response: CanonicalizeBaseUrlResponse;
+};
+// CanonicalizeBaseUrl = "canonicalizeBaseUrl"
+
+```
+```typescript
+export interface CanonicalizeBaseUrlRequest {
+  url: string;
+}
+
+```
+```typescript
+export interface CanonicalizeBaseUrlResponse {
+  url: string;
+}
+
+```
+
 ### ExportDbOp
 ```typescript
 /**
@@ -2596,10 +2773,27 @@ export type GetPendingTasksOp = {
 export type GetActiveTasksOp = {
   op: WalletApiOperation.GetActiveTasks;
   request: EmptyObject;
-  response: GetActiveTasks;
+  response: GetActiveTasksResponse;
 };
 // GetActiveTasks = "getActiveTasks"
 
+```
+```typescript
+export interface GetActiveTasksResponse {
+  tasks: ActiveTask[];
+}
+
+```
+```typescript
+export interface ActiveTask {
+  taskId: string;
+  transaction: TransactionIdStr | undefined;
+  firstTry: AbsoluteTime | undefined;
+  nextTry: AbsoluteTime | undefined;
+  retryCounter: number | undefined;
+  lastError: TalerErrorDetail | undefined;
+}
+
 ```
 
 ### DumpCoinsOp
@@ -2819,6 +3013,20 @@ export type TestingWaitTransactionsFinalOp = {
 
 ```
 
+### TestingWaitTasksDoneOp
+```typescript
+/**
+ * Wait until all transactions are in a final state.
+ */
+export type TestingWaitTasksDoneOp = {
+  op: WalletApiOperation.TestingWaitTasksDone;
+  request: EmptyObject;
+  response: EmptyObject;
+};
+// TestingWaitTasksDone = "testingWaitTasksDone"
+
+```
+
 ### TestingWaitRefreshesFinalOp
 ```typescript
 /**
@@ -2865,6 +3073,17 @@ export type TestingPingOp = {
 
 ```
 
+### TestingGetReserveHistoryOp
+```typescript
+export type TestingGetReserveHistoryOp = {
+  op: WalletApiOperation.TestingGetReserveHistory;
+  request: EmptyObject;
+  response: any;
+};
+// TestingGetReserveHistory = "testingGetReserveHistory"
+
+```
+
 ### TestingGetDenomStatsOp
 ```typescript
 /**
@@ -2954,6 +3173,7 @@ export interface PartialWalletRunConfig {
   builtin?: Partial<WalletRunConfig["builtin"]>;
   testing?: Partial<WalletRunConfig["testing"]>;
   features?: Partial<WalletRunConfig["features"]>;
+  lazyTaskLoop?: Partial<WalletRunConfig["lazyTaskLoop"]>;
 }
 ```
 ```typescript
@@ -2987,6 +3207,15 @@ export interface WalletRunConfig {
   features: {
     allowHttp: boolean;
   };
+  /**
+   * Start processing tasks only when explicitly required, even after
+   * init has been called.
+   *
+   * Useful when the wallet is started to make single read-only request,
+   * as otherwise wallet-core starts making network request and process
+   * unrelated pending tasks.
+   */
+  lazyTaskLoop: boolean;
 }
 ```
 ```typescript
@@ -3032,9 +3261,11 @@ export interface WalletCoreVersion {
 export type ScopeInfo = ScopeInfoGlobal | ScopeInfoExchange | ScopeInfoAuditor;
 ```
 ```typescript
-export type AmountString = string & {
-  [__amount_str]: true;
-};
+export type AmountString =
+  | (string & {
+      [__amount_str]: true;
+    })
+  | LitAmountString;
 ```
 ```typescript
 /**
@@ -3076,7 +3307,6 @@ export type Transaction =
   | TransactionWithdrawal
   | TransactionPayment
   | TransactionRefund
-  | TransactionReward
   | TransactionRefresh
   | TransactionDeposit
   | TransactionPeerPullCredit
@@ -3149,7 +3379,6 @@ export declare enum TransactionType {
   Payment = "payment",
   Refund = "refund",
   Refresh = "refresh",
-  Reward = "reward",
   Deposit = "deposit",
   PeerPushDebit = "peer-push-debit",
   PeerPushCredit = "peer-push-credit",
@@ -3243,6 +3472,7 @@ export declare enum TransactionMinorState {
   RefundAvailable = "refund-available",
   AcceptRefund = "accept-refund",
   PaidByOther = "paid-by-other",
+  CompletedByOtherWallet = "completed-by-other-wallet",
 }
 ```
 ```typescript
@@ -3551,17 +3781,6 @@ export interface RefundPaymentInfo {
 }
 ```
 ```typescript
-export interface TransactionReward extends TransactionCommon {
-  type: TransactionType.Reward;
-  amountRaw: AmountString;
-  /**
-   * More information about the merchant
-   */
-  amountEffective: AmountString;
-  merchantBaseUrl: string;
-}
-```
-```typescript
 /**
  * A transaction shown for refreshes.
  * Only shown for (1) refreshes not associated with other transactions
@@ -4066,7 +4285,6 @@ export interface AddExchangeRequest {
    * @deprecated use a separate API call to start a forced exchange update 
instead
    */
   forceUpdate?: boolean;
-  masterPub?: string;
 }
 ```
 ```typescript

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.