summaryrefslogtreecommitdiff
path: root/wallet
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2023-11-28 10:52:58 +0100
committerFlorian Dold <florian@dold.me>2023-11-28 10:52:58 +0100
commit4f29bfb50391d477805a3c4fce9979cdf84c3de8 (patch)
treefb0ad9078842ccce0d2175b4aabbea46f30fbb1b /wallet
parent248766c1e60e888d75af32ec705a56c72c05ca75 (diff)
downloaddocs-4f29bfb50391d477805a3c4fce9979cdf84c3de8.tar.gz
docs-4f29bfb50391d477805a3c4fce9979cdf84c3de8.tar.bz2
docs-4f29bfb50391d477805a3c4fce9979cdf84c3de8.zip
wallet-core docs
Diffstat (limited to 'wallet')
-rw-r--r--wallet/wallet-core.md80
1 files changed, 72 insertions, 8 deletions
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
index 4c714bef..4ebd7b43 100644
--- a/wallet/wallet-core.md
+++ b/wallet/wallet-core.md
@@ -168,8 +168,29 @@ export interface WalletBalance {
available: AmountString;
pendingIncoming: AmountString;
pendingOutgoing: AmountString;
+ /**
+ * Does the balance for this currency have a pending
+ * transaction?
+ *
+ * @deprecated use flags and pendingIncoming/pendingOutgoing instead
+ */
hasPendingTransactions: boolean;
+ /**
+ * Is there a transaction that requires user input?
+ *
+ * @deprecated use flags instead
+ */
requiresUserInput: boolean;
+ flags: BalanceFlag[];
+}
+
+```
+```typescript
+export declare enum BalanceFlag {
+ IncomingKyc = "incoming-kyc",
+ IncomingAml = "incoming-aml",
+ IncomingConfirmation = "incoming-confirmation",
+ OutgoingKyc = "outgoing-kyc",
}
```
@@ -569,9 +590,15 @@ export interface ManualWithdrawalDetails {
numCoins: number;
/**
* Ways to pay the exchange.
+ *
+ * @deprecated in favor of withdrawalAccountList
*/
paytoUris: string[];
/**
+ * Ways to pay the exchange, including
+ */
+ withdrawalAccountList: WithdrawalAccountInfo[];
+ /**
* If the exchange supports age-restricted coins it will return
* the array of ages.
*/
@@ -671,6 +698,7 @@ export interface AcceptManualWithdrawalResult {
* Public key of the newly created reserve.
*/
reservePub: string;
+ withdrawalAccountsList: WithdrawalAccountInfo[];
transactionId: TransactionIdStr;
}
@@ -1298,17 +1326,38 @@ export interface ExchangeFullDetails {
```typescript
export interface WireInfo {
feesForType: WireFeeMap;
- accounts: ExchangeAccount[];
+ accounts: ExchangeWireAccount[];
}
```
```typescript
-/**
- * Information about one of the exchange's bank accounts.
- */
-export interface ExchangeAccount {
+export interface ExchangeWireAccount {
payto_uri: string;
- master_sig: string;
+ conversion_url?: string;
+ credit_restrictions: AccountRestriction[];
+ debit_restrictions: AccountRestriction[];
+ master_sig: EddsaSignatureString;
+}
+
+```
+```typescript
+export type AccountRestriction =
+ | RegexAccountRestriction
+ | DenyAllAccountRestriction;
+
+```
+```typescript
+export interface RegexAccountRestriction {
+ type: "regex";
+ payto_regex: string;
+ human_hint: string;
+ human_hint_i18n?: InternationalizedString;
+}
+
+```
+```typescript
+export interface DenyAllAccountRestriction {
+ type: "deny";
}
```
@@ -1910,7 +1959,6 @@ export interface InitiatePeerPushDebitResponse {
pursePub: string;
mergePriv: string;
contractPriv: string;
- talerUri: string;
transactionId: TransactionIdStr;
}
@@ -2430,6 +2478,10 @@ export interface PendingTaskInfoCommon {
* exceeds a number of retries.
*/
retryInfo?: DbRetryInfo;
+ /**
+ * Internal operation status for debugging.
+ */
+ internalOperationStatus?: string;
}
```
@@ -3267,8 +3319,11 @@ interface WithdrawalDetailsForManualTransfer {
* Payto URIs that the exchange supports.
*
* Already contains the amount and message.
+ *
+ * @deprecated in favor of exchangeCreditAccounts
*/
exchangePaytoUris: string[];
+ exchangeCreditAccounts?: WithdrawalAccountInfo[];
reservePub: string;
/**
* Is the reserve ready for withdrawal?
@@ -3277,6 +3332,12 @@ interface WithdrawalDetailsForManualTransfer {
}
```
```typescript
+export interface WithdrawalAccountInfo {
+ paytoUri: string;
+ transferAmount: AmountString;
+}
+```
+```typescript
interface WithdrawalDetailsForTalerBankIntegrationApi {
type: WithdrawalType.TalerBankIntegrationApi;
/**
@@ -3623,8 +3684,11 @@ export interface TransactionPeerPushDebit extends TransactionCommon {
amountEffective: AmountString;
/**
* URI to accept the payment.
+ *
+ * Only present if the transaction is in a state where the other party can
+ * accept the payment.
*/
- talerUri: string;
+ talerUri?: string;
}
```
```typescript