commit 79ce73f66f04e85d8beef3f809c0585fe6ef11ae
parent 7074f0bf10e1f8e1ca164b97ad077e50ca5c96c7
Author: Florian Dold <florian@dold.me>
Date: Tue, 18 Jun 2024 08:10:51 +0200
wallet API docs
Diffstat:
| M | wallet/wallet-core.md | | | 98 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------ |
1 file changed, 84 insertions(+), 14 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -99,6 +99,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
### Data Validation
* [ValidateIbanOp](#validateibanop)
* [CanonicalizeBaseUrlOp](#canonicalizebaseurlop)
+* [GetQrCodesForPaytoOp](#getqrcodesforpaytoop)
### Database Management
* [ExportDbOp](#exportdbop)
* [ImportDbOp](#importdbop)
@@ -2641,6 +2642,48 @@ export interface CanonicalizeBaseUrlResponse {
```
+### GetQrCodesForPaytoOp
+```typescript
+export type GetQrCodesForPaytoOp = {
+ op: WalletApiOperation.GetQrCodesForPayto;
+ request: GetQrCodesForPaytoRequest;
+ response: GetQrCodesForPaytoResponse;
+};
+// GetQrCodesForPayto = "getQrCodesForPayto"
+
+```
+```typescript
+export interface GetQrCodesForPaytoRequest {
+ paytoUri: string;
+}
+
+```
+```typescript
+export interface GetQrCodesForPaytoResponse {
+ codes: QrCodeSpec[];
+}
+
+```
+```typescript
+/**
+ * Specification of a QR code that includes payment information.
+ */
+export interface QrCodeSpec {
+ /**
+ * Type of the QR code.
+ *
+ * Depending on the type, different visual styles
+ * might be applied.
+ */
+ type: string;
+ /**
+ * Content of the QR code that should be rendered.
+ */
+ qrContent: string;
+}
+
+```
+
### ExportDbOp
```typescript
/**
@@ -2909,44 +2952,42 @@ export interface CoinDumpJson {
/**
* The coin's denomination's public key.
*/
- denom_pub: DenominationPubKey;
+ denomPub: DenominationPubKey;
/**
* Hash of denom_pub.
*/
- denom_pub_hash: string;
+ denomPubHash: string;
/**
* Value of the denomination (without any fees).
*/
- denom_value: string;
+ denomValue: string;
/**
* Public key of the coin.
*/
- coin_pub: string;
+ coinPub: string;
/**
* Base URL of the exchange for the coin.
*/
- exchange_base_url: string;
+ exchangeBaseUrl: string;
/**
* Public key of the parent coin.
* Only present if this coin was obtained via refreshing.
*/
- refresh_parent_coin_pub: string | undefined;
+ refreshParentCoinPub: string | undefined;
/**
* Public key of the reserve for this coin.
* Only present if this coin was obtained via refreshing.
*/
- withdrawal_reserve_pub: string | undefined;
- coin_status: CoinStatus;
- spend_allocation:
- | {
- id: string;
- amount: AmountString;
- }
- | undefined;
+ withdrawalReservePub: string | undefined;
+ /**
+ * Status of the coin.
+ */
+ coinStatus: CoinStatus;
/**
* Information about the age restriction
*/
ageCommitmentProof: AgeCommitmentProof | undefined;
+ history: WalletCoinHistoryItem[];
}>;
}
@@ -3042,6 +3083,34 @@ export type Edx25519PrivateKeyEnc = FlavorP<
>;
```
+```typescript
+export type WalletCoinHistoryItem =
+ | {
+ type: "withdraw";
+ transactionId: TransactionIdStr;
+ }
+ | {
+ type: "spend";
+ transactionId: TransactionIdStr;
+ amount: AmountString;
+ }
+ | {
+ type: "refresh";
+ transactionId: TransactionIdStr;
+ amount: AmountString;
+ }
+ | {
+ type: "recoup";
+ transactionId: TransactionIdStr;
+ amount: AmountString;
+ }
+ | {
+ type: "refund";
+ transactionId: TransactionIdStr;
+ amount: AmountString;
+ };
+
+```
### TestingSetTimetravelOp
```typescript
@@ -4214,6 +4283,7 @@ export interface ExchangeListItem {
* to update the exchange info.
*/
lastUpdateErrorInfo?: OperationErrorInfo;
+ unavailableReason?: TalerErrorDetail;
}
```
```typescript