/* This file is part of GNU Taler (C) 2015-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 */ /** * High-level wallet operations that should be indepentent from the underlying * browser extension interface. */ /** * Imports. */ import { CryptoWorkerFactory } from "./crypto/workers/cryptoApi"; import { HttpRequestLibrary } from "./util/http"; import { Database } from "./util/query"; import { AmountJson } from "./util/amounts"; import * as Amounts from "./util/amounts"; import { getWithdrawDetailsForUri, getExchangeWithdrawalInfo, } from "./operations/withdraw"; import { abortFailedPayment, preparePay, confirmPay, processDownloadProposal, processPurchasePay, } from "./operations/pay"; import { CoinRecord, CurrencyRecord, DenominationRecord, ExchangeRecord, ProposalRecord, PurchaseRecord, ReserveRecord, Stores, ReserveRecordStatus, } from "./types/dbTypes"; import { MerchantRefundPermission } from "./types/talerTypes"; import { BenchmarkResult, ConfirmPayResult, ConfirmReserveRequest, CreateReserveRequest, CreateReserveResponse, ReturnCoinsRequest, SenderWireInfos, TipStatus, WalletBalance, PreparePayResult, WithdrawDetails, AcceptWithdrawalResponse, PurchaseDetails, ExchangeWithdrawDetails, RefreshReason, } from "./types/walletTypes"; import { Logger } from "./util/logging"; import { assertUnreachable } from "./util/assertUnreachable"; import { updateExchangeFromUrl, getExchangeTrust, getExchangePaytoUri, acceptExchangeTermsOfService, } from "./operations/exchanges"; import { processReserve, createTalerWithdrawReserve } from "./operations/reserves"; import { InternalWalletState } from "./operations/state"; import { createReserve, confirmReserve } from "./operations/reserves"; import { processRefreshGroup, createRefreshGroup } from "./operations/refresh"; import { processWithdrawSession } from "./operations/withdraw"; import { getHistory } from "./operations/history"; import { getPendingOperations } from "./operations/pending"; import { getBalances } from "./operations/balance"; import { acceptTip, getTipStatus, processTip } from "./operations/tip"; import { payback } from "./operations/payback"; import { TimerGroup } from "./util/timer"; import { AsyncCondition } from "./util/promiseUtils"; import { AsyncOpMemoSingle } from "./util/asyncMemo"; import { PendingOperationInfo, PendingOperationsResponse, PendingOperationType, } from "./types/pending"; import { WalletNotification, NotificationType } from "./types/notifications"; import { HistoryQuery, HistoryEvent } from "./types/history"; import { processPurchaseQueryRefund, processPurchaseApplyRefund, getFullRefundFees, applyRefund, } from "./operations/refund"; import { durationMin, Duration } from "./util/time"; const builtinCurrencies: CurrencyRecord[] = [ { auditors: [ { auditorPub: "BW9DC48PHQY4NH011SHHX36DZZ3Q22Y6X7FZ1VD1CMZ2PTFZ6PN0", baseUrl: "https://auditor.demo.taler.net/", expirationStamp: new Date(2027, 1).getTime(), }, ], exchanges: [], fractionalDigits: 2, name: "KUDOS", }, ]; const logger = new Logger("wallet.ts"); /** * The platform-independent wallet implementation. */ export class Wallet { private ws: InternalWalletState; private timerGroup: TimerGroup = new TimerGroup(); private latch = new AsyncCondition(); private stopped: boolean = false; private memoRunRetryLoop = new AsyncOpMemoSingle(); get db(): Database { return this.ws.db; } constructor( db: Database, http: HttpRequestLibrary, cryptoWorkerFactory: CryptoWorkerFactory, ) { this.ws = new InternalWalletState(db, http, cryptoWorkerFactory); } getExchangePaytoUri(exchangeBaseUrl: string, supportedTargetTypes: string[]) { return getExchangePaytoUri(this.ws, exchangeBaseUrl, supportedTargetTypes); } getWithdrawDetailsForAmount( exchangeBaseUrl: string, amount: AmountJson, ): Promise { return getExchangeWithdrawalInfo(this.ws, exchangeBaseUrl, amount); } addNotificationListener(f: (n: WalletNotification) => void): void { this.ws.addNotificationListener(f); } /** * Execute one operation based on the pending operation info record. */ async processOnePendingOperation( pending: PendingOperationInfo, forceNow: boolean = false, ): Promise { console.log("running pending", pending); switch (pending.type) { case PendingOperationType.Bug: // Nothing to do, will just be displayed to the user return; case PendingOperationType.ExchangeUpdate: await updateExchangeFromUrl(this.ws, pending.exchangeBaseUrl, forceNow); break; case PendingOperationType.Refresh: await processRefreshGroup(this.ws, pending.refreshGroupId, forceNow); break; case PendingOperationType.Reserve: await processReserve(this.ws, pending.reservePub, forceNow); break; case PendingOperationType.Withdraw: await processWithdrawSession( this.ws, pending.withdrawSessionId, forceNow, ); break; case PendingOperationType.ProposalChoice: // Nothing to do, user needs to accept/reject break; case PendingOperationType.ProposalDownload: await processDownloadProposal(this.ws, pending.proposalId, forceNow); break; case PendingOperationType.TipChoice: // Nothing to do, user needs to accept/reject break; case PendingOperationType.TipPickup: await processTip(this.ws, pending.tipId, forceNow); break; case PendingOperationType.Pay: await processPurchasePay(this.ws, pending.proposalId, forceNow); break; case PendingOperationType.RefundQuery: await processPurchaseQueryRefund(this.ws, pending.proposalId, forceNow); break; case PendingOperationType.RefundApply: await processPurchaseApplyRefund(this.ws, pending.proposalId, forceNow); break; default: assertUnreachable(pending); } } /** * Process pending operations. */ public async runPending(forceNow: boolean = false): Promise { const onlyDue = !forceNow; const pendingOpsResponse = await this.getPendingOperations(onlyDue); for (const p of pendingOpsResponse.pendingOperations) { try { await this.processOnePendingOperation(p, forceNow); } catch (e) { console.error(e); } } } /** * Run the wallet until there are no more pending operations that give * liveness left. The wallet will be in a stopped state when this function * returns without resolving to an exception. */ public async runUntilDone(): Promise { const p = new Promise((resolve, reject) => { // Run this asynchronously this.addNotificationListener(n => { if ( n.type === NotificationType.WaitingForRetry && n.numGivingLiveness == 0 ) { logger.trace("no liveness-giving operations left, stopping"); this.stop(); } }); this.runRetryLoop().catch(e => { console.log("exception in wallet retry loop"); reject(e); }); }); await p; } /** * Process pending operations and wait for scheduled operations in * a loop until the wallet is stopped explicitly. */ public async runRetryLoop(): Promise { // Make sure we only run one main loop at a time. return this.memoRunRetryLoop.memo(async () => { try { await this.runRetryLoopImpl(); } catch (e) { console.error("error during retry loop execution", e); throw e; } }); } private async runRetryLoopImpl(): Promise { while (!this.stopped) { console.log("running wallet retry loop iteration"); let pending = await this.getPendingOperations(true); if (pending.pendingOperations.length === 0) { const allPending = await this.getPendingOperations(false); let numPending = 0; let numGivingLiveness = 0; for (const p of allPending.pendingOperations) { numPending++; if (p.givesLifeness) { numGivingLiveness++; } } let dt: Duration; if ( allPending.pendingOperations.length === 0 || allPending.nextRetryDelay.d_ms === Number.MAX_SAFE_INTEGER ) { // Wait for 5 seconds dt = { d_ms: 5000 }; } else { dt = durationMin({ d_ms: 5000}, allPending.nextRetryDelay); } const timeout = this.timerGroup.resolveAfter(dt); this.ws.notify({ type: NotificationType.WaitingForRetry, numGivingLiveness, numPending, }); await Promise.race([timeout, this.latch.wait()]); console.log("timeout done"); } else { logger.trace("running pending operations that are due"); // FIXME: maybe be a bit smarter about executing these // operations in parallel? for (const p of pending.pendingOperations) { try { console.log("running", p); await this.processOnePendingOperation(p); } catch (e) { console.error(e); } this.ws.notify({ type: NotificationType.Wildcard }); } } } logger.trace("exiting wallet retry loop"); } /** * Insert the hard-coded defaults for exchanges, coins and * auditors into the database, unless these defaults have * already been applied. */ async fillDefaults() { await this.db.runWithWriteTransaction( [Stores.config, Stores.currencies], async tx => { let applied = false; await tx.iter(Stores.config).forEach(x => { if (x.key == "currencyDefaultsApplied" && x.value == true) { applied = true; } }); if (!applied) { for (let c of builtinCurrencies) { await tx.put(Stores.currencies, c); } } }, ); } /** * Check if a payment for the given taler://pay/ URI is possible. * * If the payment is possible, the signature are already generated but not * yet send to the merchant. */ async preparePay(talerPayUri: string): Promise { return preparePay(this.ws, talerPayUri); } /** * Add a contract to the wallet and sign coins, and send them. */ async confirmPay( proposalId: string, sessionIdOverride: string | undefined, ): Promise { try { return await confirmPay(this.ws, proposalId, sessionIdOverride); } finally { this.latch.trigger(); } } /** * First fetch information requred to withdraw from the reserve, * then deplete the reserve, withdrawing coins until it is empty. * * The returned promise resolves once the reserve is set to the * state DORMANT. */ async processReserve(reservePub: string): Promise { try { return await processReserve(this.ws, reservePub); } finally { this.latch.trigger(); } } /** * Create a reserve, but do not flag it as confirmed yet. * * Adds the corresponding exchange as a trusted exchange if it is neither * audited nor trusted already. */ async createReserve( req: CreateReserveRequest, ): Promise { try { return createReserve(this.ws, req); } finally { this.latch.trigger(); } } /** * Mark an existing reserve as confirmed. The wallet will start trying * to withdraw from that reserve. This may not immediately succeed, * since the exchange might not know about the reserve yet, even though the * bank confirmed its creation. * * A confirmed reserve should be shown to the user in the UI, while * an unconfirmed reserve should be hidden. */ async confirmReserve(req: ConfirmReserveRequest): Promise { try { return confirmReserve(this.ws, req); } finally { this.latch.trigger(); } } /** * Check if and how an exchange is trusted and/or audited. */ async getExchangeTrust( exchangeInfo: ExchangeRecord, ): Promise<{ isTrusted: boolean; isAudited: boolean }> { return getExchangeTrust(this.ws, exchangeInfo); } async getWithdrawDetailsForUri( talerWithdrawUri: string, maybeSelectedExchange?: string, ): Promise { return getWithdrawDetailsForUri( this.ws, talerWithdrawUri, maybeSelectedExchange, ); } /** * Update or add exchange DB entry by fetching the /keys and /wire information. * Optionally link the reserve entry to the new or existing * exchange entry in then DB. */ async updateExchangeFromUrl( baseUrl: string, force: boolean = false, ): Promise { try { return updateExchangeFromUrl(this.ws, baseUrl, force); } finally { this.latch.trigger(); } } /** * Get detailed balance information, sliced by exchange and by currency. */ async getBalances(): Promise { return this.ws.memoGetBalance.memo(() => getBalances(this.ws)); } async refresh(oldCoinPub: string): Promise { try { const refreshGroupId = await this.db.runWithWriteTransaction( [Stores.refreshGroups], async tx => { return await createRefreshGroup( tx, [{ coinPub: oldCoinPub }], RefreshReason.Manual, ); }, ); await processRefreshGroup(this.ws, refreshGroupId.refreshGroupId); } catch (e) { this.latch.trigger(); } } async findExchange( exchangeBaseUrl: string, ): Promise { return await this.db.get(Stores.exchanges, exchangeBaseUrl); } /** * Retrive the full event history for this wallet. */ async getHistory( historyQuery?: HistoryQuery, ): Promise<{ history: HistoryEvent[] }> { return getHistory(this.ws, historyQuery); } async getPendingOperations( onlyDue: boolean = false, ): Promise { return this.ws.memoGetPending.memo(() => getPendingOperations(this.ws, onlyDue), ); } async acceptExchangeTermsOfService( exchangeBaseUrl: string, etag: string | undefined, ) { return acceptExchangeTermsOfService(this.ws, exchangeBaseUrl, etag); } async getDenoms(exchangeUrl: string): Promise { const denoms = await this.db .iterIndex(Stores.denominations.exchangeBaseUrlIndex, exchangeUrl) .toArray(); return denoms; } async getExchanges(): Promise { return await this.db.iter(Stores.exchanges).toArray(); } async getCurrencies(): Promise { return await this.db.iter(Stores.currencies).toArray(); } async updateCurrency(currencyRecord: CurrencyRecord): Promise { logger.trace("updating currency to", currencyRecord); await this.db.put(Stores.currencies, currencyRecord); } async getReserves(exchangeBaseUrl: string): Promise { return await this.db .iter(Stores.reserves) .filter(r => r.exchangeBaseUrl === exchangeBaseUrl); } async getCoinsForExchange(exchangeBaseUrl: string): Promise { return await this.db .iter(Stores.coins) .filter(c => c.exchangeBaseUrl === exchangeBaseUrl); } async getCoins(): Promise { return await this.db.iter(Stores.coins).toArray(); } async payback(coinPub: string): Promise { return payback(this.ws, coinPub); } async getPaybackReserves(): Promise { return await this.db.iter(Stores.reserves).filter(r => r.hasPayback); } /** * Stop ongoing processing. */ stop() { this.stopped = true; this.timerGroup.stopCurrentAndFutureTimers(); this.ws.cryptoApi.stop(); } async getSenderWireInfos(): Promise { const m: { [url: string]: Set } = {}; await this.db.iter(Stores.exchanges).forEach(x => { const wi = x.wireInfo; if (!wi) { return; } const s = (m[x.baseUrl] = m[x.baseUrl] || new Set()); Object.keys(wi.feesForType).map(k => s.add(k)); }); const exchangeWireTypes: { [url: string]: string[] } = {}; Object.keys(m).map(e => { exchangeWireTypes[e] = Array.from(m[e]); }); const senderWiresSet: Set = new Set(); await this.db.iter(Stores.senderWires).forEach(x => { senderWiresSet.add(x.paytoUri); }); const senderWires: string[] = Array.from(senderWiresSet); return { exchangeWireTypes, senderWires, }; } /** * Trigger paying coins back into the user's account. */ async returnCoins(req: ReturnCoinsRequest): Promise { throw Error("not implemented"); } /** * Accept a refund, return the contract hash for the contract * that was involved in the refund. */ async applyRefund(talerRefundUri: string): Promise { return applyRefund(this.ws, talerRefundUri); } async getPurchase( contractTermsHash: string, ): Promise { return this.db.get(Stores.purchases, contractTermsHash); } async getFullRefundFees( refundPermissions: MerchantRefundPermission[], ): Promise { return getFullRefundFees(this.ws, refundPermissions); } async acceptTip(talerTipUri: string): Promise { try { return acceptTip(this.ws, talerTipUri); } catch (e) { this.latch.trigger(); } } async getTipStatus(talerTipUri: string): Promise { return getTipStatus(this.ws, talerTipUri); } async abortFailedPayment(contractTermsHash: string): Promise { try { return abortFailedPayment(this.ws, contractTermsHash); } finally { this.latch.trigger(); } } /** * Inform the wallet that the status of a reserve has changed (e.g. due to a * confirmation from the bank.). */ public async handleNotifyReserve() { const reserves = await this.db.iter(Stores.reserves).toArray(); for (const r of reserves) { if (r.reserveStatus === ReserveRecordStatus.WAIT_CONFIRM_BANK) { try { this.processReserve(r.reservePub); } catch (e) { console.error(e); } } } } /** * Remove unreferenced / expired data from the wallet's database * based on the current system time. */ async collectGarbage() { // FIXME(#5845) // We currently do not garbage-collect the wallet database. This might change // after the feature has been properly re-designed, and we have come up with a // strategy to test it. } async acceptWithdrawal( talerWithdrawUri: string, selectedExchange: string, ): Promise { try { return createTalerWithdrawReserve(this.ws, talerWithdrawUri, selectedExchange); } finally { this.latch.trigger(); } } async getPurchaseDetails(hc: string): Promise { const purchase = await this.db.get(Stores.purchases, hc); if (!purchase) { throw Error("unknown purchase"); } const refundsDoneAmounts = Object.values( purchase.refundState.refundsDone, ).map(x => Amounts.parseOrThrow(x.perm.refund_amount)); const refundsPendingAmounts = Object.values( purchase.refundState.refundsPending, ).map(x => Amounts.parseOrThrow(x.perm.refund_amount)); const totalRefundAmount = Amounts.sum([ ...refundsDoneAmounts, ...refundsPendingAmounts, ]).amount; const refundsDoneFees = Object.values( purchase.refundState.refundsDone, ).map(x => Amounts.parseOrThrow(x.perm.refund_amount)); const refundsPendingFees = Object.values( purchase.refundState.refundsPending, ).map(x => Amounts.parseOrThrow(x.perm.refund_amount)); const totalRefundFees = Amounts.sum([ ...refundsDoneFees, ...refundsPendingFees, ]).amount; const totalFees = totalRefundFees; return { contractTerms: purchase.contractTermsRaw, hasRefund: purchase.timestampLastRefundStatus !== undefined, totalRefundAmount: totalRefundAmount, totalRefundAndRefreshFees: totalFees, }; } benchmarkCrypto(repetitions: number): Promise { return this.ws.cryptoApi.benchmark(repetitions); } }