diff options
author | Florian Dold <florian@dold.me> | 2024-03-31 16:50:56 +0200 |
---|---|---|
committer | Florian Dold <florian@dold.me> | 2024-03-31 16:50:56 +0200 |
commit | f357ebe854c38ea838cda428d0ac32ecad51b886 (patch) | |
tree | be65c1b528f660c1d06f83192b3ee14cc31f0346 | |
parent | e3a10d229d100d51ce96cdf9a181d67f9f4c8cad (diff) | |
download | docs-f357ebe854c38ea838cda428d0ac32ecad51b886.tar.gz docs-f357ebe854c38ea838cda428d0ac32ecad51b886.tar.bz2 docs-f357ebe854c38ea838cda428d0ac32ecad51b886.zip |
wallet-core docs
-rw-r--r-- | wallet/wallet-core.md | 61 |
1 files changed, 50 insertions, 11 deletions
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md index 2960fafe..01c9d3da 100644 --- a/wallet/wallet-core.md +++ b/wallet/wallet-core.md @@ -463,8 +463,13 @@ export interface TransactionsRequest { * Sort order of the transaction items. * By default, items are sorted ascending by their * main timestamp. + * + * ascending: ascending by timestamp, but pending transactions first + * descending: ascending by timestamp, but pending transactions first + * stable-ascending: ascending by timestamp, with pending transactions amidst other transactions + * (stable in the sense of: pending transactions don't jump around) */ - sort?: "ascending" | "descending"; + sort?: "ascending" | "descending" | "stable-ascending"; /** * If true, include all refreshes in the transactions list. */ @@ -1564,6 +1569,8 @@ export interface ExchangeWireAccount { credit_restrictions: AccountRestriction[]; debit_restrictions: AccountRestriction[]; master_sig: EddsaSignatureString; + bank_label?: string; + priority?: number; } ``` @@ -3042,7 +3049,8 @@ export type Transaction = | TransactionPeerPushCredit | TransactionPeerPushDebit | TransactionInternalWithdrawal - | TransactionRecoup; + | TransactionRecoup + | TransactionDenomLoss; ``` ```typescript /** @@ -3113,6 +3121,7 @@ export declare enum TransactionType { PeerPullDebit = "peer-pull-debit", PeerPullCredit = "peer-pull-credit", Recoup = "recoup", + DenomLoss = "denom-loss", } ``` ```typescript @@ -3289,16 +3298,9 @@ export interface WithdrawalExchangeAccountDetails { * Transfer amount. Might be in a different currency than the requested * amount for withdrawal. * - * Redundant with the amount in paytoUri, just included to avoid parsing. + * Absent if this is a conversion account and the conversion failed. */ - transferAmount: AmountString; - /** - * Beneficiary name of the exchange's bank account. - * Optional in general, mandatory for "iban" and "x-taler-bank" (and others). - * - * Redundant with the beneficiary-name in paytoUri, just included to avoid parsing. - */ - beneficiaryName?: string; + transferAmount?: AmountString; /** * Currency specification for the external currency. * @@ -3311,6 +3313,11 @@ export interface WithdrawalExchangeAccountDetails { */ creditRestrictions?: AccountRestriction[]; /** + * Label given to the account or the account's bank by the exchange. + */ + bankLabel?: string; + priority?: number; + /** * Error that happened when attempting to request the conversion rate. */ conversionError?: TalerErrorDetail; @@ -3743,6 +3750,24 @@ export interface TransactionRecoup extends TransactionCommon { } ``` ```typescript +/** + * A transaction to indicate financial loss due to denominations + * that became unusable for deposits. + */ +export interface TransactionDenomLoss extends TransactionCommon { + type: TransactionType.DenomLoss; + lossEventType: DenomLossEventType; + exchangeBaseUrl: string; +} +``` +```typescript +export declare enum DenomLossEventType { + DenomExpired = "denom-expired", + DenomVanished = "denom-vanished", + DenomUnoffered = "denom-unoffered", +} +``` +```typescript export interface AbortTransactionRequest { transactionId: TransactionIdStr; } @@ -3760,6 +3785,15 @@ export interface ExchangeListItem { exchangeEntryStatus: ExchangeEntryStatus; exchangeUpdateStatus: ExchangeUpdateStatus; ageRestrictionOptions: number[]; + /** + * P2P payments are disabled with this exchange + * (e.g. because no global fees are configured). + */ + peerPaymentsDisabled: boolean; + /** + * Set to true if this exchange doesn't charge any fees. + */ + noFees: boolean; scopeInfo: ScopeInfo | undefined; lastUpdateTimestamp: TalerPreciseTimestamp | undefined; /** @@ -3936,6 +3970,11 @@ export interface PaymentInsufficientBalanceDetails { balanceReceiverAcceptable: AmountString; balanceReceiverDepositable: AmountString; maxEffectiveSpendAmount: AmountString; + /** + * Exchange doesn't have global fees configured for the relevant year, + * p2p payments aren't possible. + */ + missingGlobalFees: boolean; }; }; } |