commit 477b26f1cdd78569e2665141333b2be455ccdcae
parent ca1873efadb470d4469a321a6916fa2a9dedacc3
Author: Florian Dold <florian@dold.me>
Date: Tue, 18 Feb 2025 12:28:11 +0100
update wallet-core docs
Diffstat:
1 file changed, 27 insertions(+), 9 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -4809,6 +4809,19 @@ export interface PaymentInsufficientBalanceDetails {
*/
amountRequested: AmountString;
/**
+ * Wire method for the requested payment, only applicable
+ * for merchant payments.
+ */
+ wireMethod?: string | undefined;
+ /**
+ * Hint as to why the balance is insufficient.
+ *
+ * If this hint is not provided, the balance hints of
+ * the individual exchanges should be shown, as the overall
+ * reason might be a combination of the reasons for different exchanges.
+ */
+ causeHint?: InsufficientBalanceHint;
+ /**
* Balance of type "available" (see balance.ts for definition).
*/
balanceAvailable: AmountString;
@@ -4847,7 +4860,7 @@ export interface PaymentInsufficientBalanceDetails {
* Exchange doesn't have global fees configured for the relevant year,
* p2p payments aren't possible.
*
- * @deprecated use causeHint instead
+ * @deprecated (2025-02-18) use causeHint instead
*/
missingGlobalFees: boolean;
/**
@@ -4875,24 +4888,29 @@ export declare enum InsufficientBalanceHint {
* the age restriction on coins causes the spendable
* balance to be insufficient.
*/
- MerchantAgeRestricted = "merchant-age-restricted",
- /**
- * While in principle the balance is sufficient,
- * the age restriction on coins causes the spendable
- * balance to be insufficient.
- */
- PeerAgeRestricted = "peer-age-restricted",
+ AgeRestricted = "age-restricted",
/**
* Wallet has enough available funds,
* but the material funds are insufficient. Usually because there is a
* pending refresh operation.
*/
- WalletMateriallyInsufficient = "wallet-materially-insufficient",
+ WalletBalanceMaterialInsufficient = "wallet-balance-material-insufficient",
+ /**
+ * The wallet simply doesn't have enough available funds.
+ * This is the "obvious" case of insufficient balance.
+ */
+ WalletBalanceAvailableInsufficient = "wallet-balance-available-insufficient",
/**
* Exchange is missing the global fee configuration, thus fees are unknown
* and funds from this exchange can't be used for p2p payments.
*/
ExchangeMissingGlobalFees = "exchange-missing-global-fees",
+ /**
+ * Even though the balance looks sufficient for the instructed amount,
+ * the fees can be covered by neither the merchant nor the remaining wallet
+ * balance.
+ */
+ FeesNotCovered = "fees-not-covered",
}
```
```typescript
