aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2022-03-23 16:37:40 +0100
committerFlorian Dold <florian@dold.me>2022-03-23 16:38:34 +0100
commitf187c1e13f749dbf929a9644481fa93220068bad (patch)
treeac7a1006188bb2d14629781613642558d556b8e5
parent32f6409ac312f31821f791c3a376168289f0e4f4 (diff)
missing files
-rw-r--r--packages/taler-wallet-core/src/internal-wallet-state.ts257
-rw-r--r--packages/taler-wallet-core/src/operations/common.ts51
2 files changed, 308 insertions, 0 deletions
diff --git a/packages/taler-wallet-core/src/internal-wallet-state.ts b/packages/taler-wallet-core/src/internal-wallet-state.ts
new file mode 100644
index 000000000..904398722
--- /dev/null
+++ b/packages/taler-wallet-core/src/internal-wallet-state.ts
@@ -0,0 +1,257 @@
+/*
+ This file is part of GNU Taler
+ (C) 2019 GNUnet e.V.
+
+ GNU Taler is free software; you can redistribute it and/or modify it under the
+ terms of the GNU General Public License as published by the Free Software
+ Foundation; either version 3, or (at your option) any later version.
+
+ GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along with
+ GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
+ */
+
+/**
+ * Common interface of the internal wallet state. This object is passed
+ * to the various operations (exchange management, withdrawal, refresh, reserve
+ * management, etc.).
+ *
+ * Some operations can be accessed via this state object. This allows mutual
+ * recursion between operations, without having cyclic dependencies between
+ * the respective TypeScript files.
+ *
+ * (You can think of this as a "header file" for the wallet implementation.)
+ */
+
+/**
+ * Imports.
+ */
+import {
+ WalletNotification,
+ BalancesResponse,
+ AmountJson,
+ DenominationPubKey,
+ TalerProtocolTimestamp,
+} from "@gnu-taler/taler-util";
+import { CryptoApi } from "./crypto/workers/cryptoApi.js";
+import { ExchangeDetailsRecord, ExchangeRecord, WalletStoresV1 } from "./db.js";
+import { PendingOperationsResponse } from "./pending-types.js";
+import { AsyncOpMemoMap, AsyncOpMemoSingle } from "./util/asyncMemo.js";
+import { HttpRequestLibrary } from "./util/http.js";
+import { AsyncCondition } from "./util/promiseUtils.js";
+import {
+ DbAccess,
+ GetReadOnlyAccess,
+ GetReadWriteAccess,
+} from "./util/query.js";
+import { TimerGroup } from "./util/timer.js";
+
+export const EXCHANGE_COINS_LOCK = "exchange-coins-lock";
+export const EXCHANGE_RESERVES_LOCK = "exchange-reserves-lock";
+
+export interface TrustInfo {
+ isTrusted: boolean;
+ isAudited: boolean;
+}
+
+export interface MerchantInfo {
+ protocolVersionCurrent: number;
+}
+
+/**
+ * Interface for merchant-related operations.
+ */
+export interface MerchantOperations {
+ getMerchantInfo(
+ ws: InternalWalletState,
+ merchantBaseUrl: string,
+ ): Promise<MerchantInfo>;
+}
+
+export interface ReserveOperations {
+ processReserve(
+ ws: InternalWalletState,
+ reservePub: string,
+ forceNow?: boolean,
+ ): Promise<void>;
+}
+
+/**
+ * Interface for exchange-related operations.
+ */
+export interface ExchangeOperations {
+ // FIXME: Should other operations maybe always use
+ // updateExchangeFromUrl?
+ getExchangeDetails(
+ tx: GetReadOnlyAccess<{
+ exchanges: typeof WalletStoresV1.exchanges;
+ exchangeDetails: typeof WalletStoresV1.exchangeDetails;
+ }>,
+ exchangeBaseUrl: string,
+ ): Promise<ExchangeDetailsRecord | undefined>;
+ getExchangeTrust(
+ ws: InternalWalletState,
+ exchangeInfo: ExchangeRecord,
+ ): Promise<TrustInfo>;
+ updateExchangeFromUrl(
+ ws: InternalWalletState,
+ baseUrl: string,
+ acceptedFormat?: string[],
+ forceNow?: boolean,
+ ): Promise<{
+ exchange: ExchangeRecord;
+ exchangeDetails: ExchangeDetailsRecord;
+ }>;
+}
+
+export interface RecoupOperations {
+ createRecoupGroup(
+ ws: InternalWalletState,
+ tx: GetReadWriteAccess<{
+ recoupGroups: typeof WalletStoresV1.recoupGroups;
+ denominations: typeof WalletStoresV1.denominations;
+ refreshGroups: typeof WalletStoresV1.refreshGroups;
+ coins: typeof WalletStoresV1.coins;
+ }>,
+ coinPubs: string[],
+ ): Promise<string>;
+ processRecoupGroup(
+ ws: InternalWalletState,
+ recoupGroupId: string,
+ forceNow?: boolean,
+ ): Promise<void>;
+}
+
+export interface DenomInfo {
+ /**
+ * Value of one coin of the denomination.
+ */
+ value: AmountJson;
+
+ /**
+ * The denomination public key.
+ */
+ denomPub: DenominationPubKey;
+
+ /**
+ * Hash of the denomination public key.
+ * Stored in the database for faster lookups.
+ */
+ denomPubHash: string;
+
+ /**
+ * Fee for withdrawing.
+ */
+ feeWithdraw: AmountJson;
+
+ /**
+ * Fee for depositing.
+ */
+ feeDeposit: AmountJson;
+
+ /**
+ * Fee for refreshing.
+ */
+ feeRefresh: AmountJson;
+
+ /**
+ * Fee for refunding.
+ */
+ feeRefund: AmountJson;
+
+ /**
+ * Validity start date of the denomination.
+ */
+ stampStart: TalerProtocolTimestamp;
+
+ /**
+ * Date after which the currency can't be withdrawn anymore.
+ */
+ stampExpireWithdraw: TalerProtocolTimestamp;
+
+ /**
+ * Date after the denomination officially doesn't exist anymore.
+ */
+ stampExpireLegal: TalerProtocolTimestamp;
+
+ /**
+ * Data after which coins of this denomination can't be deposited anymore.
+ */
+ stampExpireDeposit: TalerProtocolTimestamp;
+}
+
+export type NotificationListener = (n: WalletNotification) => void;
+
+/**
+ * Internal, shard wallet state that is used by the implementation
+ * of wallet operations.
+ *
+ * FIXME: This should not be exported anywhere from the taler-wallet-core package,
+ * as it's an opaque implementation detail.
+ */
+export interface InternalWalletState {
+ memoProcessReserve: AsyncOpMemoMap<void>;
+ memoMakePlanchet: AsyncOpMemoMap<void>;
+ memoGetPending: AsyncOpMemoSingle<PendingOperationsResponse>;
+ memoGetBalance: AsyncOpMemoSingle<BalancesResponse>;
+ memoProcessRefresh: AsyncOpMemoMap<void>;
+ memoProcessRecoup: AsyncOpMemoMap<void>;
+ memoProcessDeposit: AsyncOpMemoMap<void>;
+ cryptoApi: CryptoApi;
+
+ timerGroup: TimerGroup;
+ stopped: boolean;
+
+ insecureTrustExchange: boolean;
+
+ /**
+ * Asynchronous condition to interrupt the sleep of the
+ * retry loop.
+ *
+ * Used to allow processing of new work faster.
+ */
+ latch: AsyncCondition;
+
+ listeners: NotificationListener[];
+
+ initCalled: boolean;
+
+ merchantInfoCache: Record<string, MerchantInfo>;
+
+ exchangeOps: ExchangeOperations;
+ recoupOps: RecoupOperations;
+ merchantOps: MerchantOperations;
+ reserveOps: ReserveOperations;
+
+ getDenomInfo(
+ ws: InternalWalletState,
+ tx: GetReadOnlyAccess<{
+ denominations: typeof WalletStoresV1.denominations;
+ }>,
+ exchangeBaseUrl: string,
+ denomPubHash: string,
+ ): Promise<DenomInfo | undefined>;
+
+ db: DbAccess<typeof WalletStoresV1>;
+ http: HttpRequestLibrary;
+
+ notify(n: WalletNotification): void;
+
+ addNotificationListener(f: (n: WalletNotification) => void): void;
+
+ /**
+ * Stop ongoing processing.
+ */
+ stop(): void;
+
+ /**
+ * Run an async function after acquiring a list of locks, identified
+ * by string tokens.
+ */
+ runSequentialized<T>(tokens: string[], f: () => Promise<T>): Promise<T>;
+
+ runUntilDone(req?: { maxRetries?: number }): Promise<void>;
+}
diff --git a/packages/taler-wallet-core/src/operations/common.ts b/packages/taler-wallet-core/src/operations/common.ts
new file mode 100644
index 000000000..5525b4deb
--- /dev/null
+++ b/packages/taler-wallet-core/src/operations/common.ts
@@ -0,0 +1,51 @@
+/*
+ This file is part of GNU Taler
+ (C) 2022 GNUnet e.V.
+
+ GNU Taler is free software; you can redistribute it and/or modify it under the
+ terms of the GNU General Public License as published by the Free Software
+ Foundation; either version 3, or (at your option) any later version.
+
+ GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along with
+ GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
+ */
+
+import { TalerErrorDetail, TalerErrorCode } from "@gnu-taler/taler-util";
+import { CryptoApiStoppedError } from "../crypto/workers/cryptoApi.js";
+import { TalerError, getErrorDetailFromException } from "../errors.js";
+
+/**
+ * Run an operation and call the onOpError callback
+ * when there was an exception or operation error that must be reported.
+ * The cause will be re-thrown to the caller.
+ */
+export async function guardOperationException<T>(
+ op: () => Promise<T>,
+ onOpError: (e: TalerErrorDetail) => Promise<void>,
+): Promise<T> {
+ try {
+ return await op();
+ } catch (e: any) {
+ if (e instanceof CryptoApiStoppedError) {
+ throw e;
+ }
+ if (
+ e instanceof TalerError &&
+ e.hasErrorCode(TalerErrorCode.WALLET_PENDING_OPERATION_FAILED)
+ ) {
+ throw e;
+ }
+ const opErr = getErrorDetailFromException(e);
+ await onOpError(opErr);
+ throw TalerError.fromDetail(
+ TalerErrorCode.WALLET_PENDING_OPERATION_FAILED,
+ {
+ innerError: e.errorDetail,
+ },
+ );
+ }
+}