taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit e63fc4c254a2814d7d103867626ebf7559eef837
parent 8ad16486dcc7a55f474c0408511fa3c295437590
Author: Florian Dold <florian@dold.me>
Date:   Wed,  2 Nov 2022 18:26:07 +0100

wallet-core docs

Diffstat:
Mwallet/wallet-core.md | 52+++++++++++++++++++++-------------------------------
1 file changed, 21 insertions(+), 31 deletions(-)

diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md @@ -495,12 +495,12 @@ export interface WalletContractData { merchantSig: string; merchantPub: string; merchant: MerchantInfo; - amount: AmountJson; + amount: AmountString; orderId: string; merchantBaseUrl: string; summary: string; autoRefund: TalerProtocolDuration | undefined; - maxWireFee: AmountJson; + maxWireFee: AmountString; wireFeeAmortization: number; payDeadline: TalerProtocolTimestamp; refundDeadline: TalerProtocolTimestamp; @@ -509,7 +509,7 @@ export interface WalletContractData { timestamp: TalerProtocolTimestamp; wireMethod: string; wireInfoHash: string; - maxDepositFee: AmountJson; + maxDepositFee: AmountString; minimumAge?: number; deliveryDate: TalerProtocolTimestamp | undefined; deliveryLocation: Location | undefined; @@ -1022,7 +1022,7 @@ export interface FeeDescription { group: string; from: AbsoluteTime; until: AbsoluteTime; - fee?: AmountJson; + fee?: AmountString; } ``` @@ -1135,9 +1135,9 @@ export interface GetFeeForDepositRequest { ``` ```typescript export interface DepositGroupFees { - coin: AmountJson; - wire: AmountJson; - refresh: AmountJson; + coin: AmountString; + wire: AmountString; + refresh: AmountString; } ``` @@ -1840,7 +1840,7 @@ export interface PayCoinSelection { /** * Amount requested by the merchant. */ - paymentAmount: AmountJson; + paymentAmount: AmountString; /** * Public keys of the coins that were selected. */ @@ -1848,15 +1848,15 @@ export interface PayCoinSelection { /** * Amount that each coin contributes. */ - coinContributions: AmountJson[]; + coinContributions: AmountString[]; /** * How much of the wire fees is the customer paying? */ - customerWireFees: AmountJson; + customerWireFees: AmountString; /** * How much of the deposit fees is the customer paying? */ - customerDepositFees: AmountJson; + customerDepositFees: AmountString; } ``` @@ -2874,6 +2874,11 @@ export interface ExchangeListItem { * temporarily queried. */ permanent: boolean; + /** + * Information about the last error that occured when trying + * to update the exchange info. + */ + lastUpdateErrorInfo?: OperationErrorInfo; } ``` ```typescript @@ -2893,6 +2898,11 @@ export declare enum ExchangeEntryStatus { } ``` ```typescript +export interface OperationErrorInfo { + error: TalerErrorDetail; +} +``` +```typescript export interface ForcedDenomSel { denoms: { value: AmountString; @@ -3060,26 +3070,6 @@ export interface ExchangeHandle { ``` ```typescript /** - * Non-negative financial amount. Fractional values are expressed as multiples - * of 1e-8. - */ -export interface AmountJson { - /** - * Value, must be an integer. - */ - readonly value: number; - /** - * Fraction, must be an integer. Represent 1/1e8 of a unit. - */ - readonly fraction: number; - /** - * Currency of the amount. - */ - readonly currency: string; -} -``` -```typescript -/** * Forced coin selection for deposits/payments. */ export interface ForcedCoinSel {