commit e69d507a90b51984a92550b38140a8258b92936d
parent da24ce8a77e8aac371ad05837a14319328b2fc98
Author: Sebastian <sebasjm@gmail.com>
Date: Tue, 13 Feb 2024 12:12:21 -0300
update wallet core docs
Diffstat:
| M | wallet/wallet-core.md | | | 146 | +++++++++++++++++++++++++------------------------------------------------------ |
1 file changed, 46 insertions(+), 100 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -46,9 +46,6 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
* [AddGlobalCurrencyAuditorOp](#addglobalcurrencyauditorop)
* [RemoveGlobalCurrencyExchangeOp](#removeglobalcurrencyexchangeop)
* [RemoveGlobalCurrencyAuditorOp](#removeglobalcurrencyauditorop)
-### Rewards
-* [PrepareTipOp](#preparetipop)
-* [AcceptTipOp](#accepttipop)
### Exchange Management
* [ListExchangesOp](#listexchangesop)
* [ListExchangesForScopedCurrencyOp](#listexchangesforscopedcurrencyop)
@@ -389,9 +386,17 @@ export type GetTransactionsOp = {
export interface TransactionsRequest {
/**
* return only transactions in the given currency
+ *
+ * it will be removed in next release
+ *
+ * @deprecated use scopeInfo
*/
currency?: string;
/**
+ * return only transactions in the given scopeInfo
+ */
+ scopeInfo?: ScopeInfo;
+ /**
* if present, results will be limited to transactions related to the given search string
*/
search?: string;
@@ -423,6 +428,18 @@ export type ListAssociatedRefreshesOp = {
// ListAssociatedRefreshes = "listAssociatedRefreshes"
```
+```typescript
+export interface ListAssociatedRefreshesRequest {
+ transactionId: string;
+}
+
+```
+```typescript
+export interface ListAssociatedRefreshesResponse {
+ transactionIds: string[];
+}
+
+```
### TestingGetSampleTransactionsOp
```typescript
@@ -917,7 +934,7 @@ export interface ConfirmPayRequest {
* @deprecated use transactionId instead
*/
proposalId?: string;
- transactionId?: string;
+ transactionId?: TransactionIdStr;
sessionId?: string;
forcedCoinSel?: ForcedCoinSel;
}
@@ -968,6 +985,9 @@ export interface PrepareRefundRequest {
```
```typescript
export interface StartRefundQueryForUriResponse {
+ /**
+ * Transaction id of the *payment* where the refund query was started.
+ */
transactionId: TransactionIdStr;
}
@@ -1108,96 +1128,6 @@ export interface RemoveGlobalCurrencyAuditorRequest {
```
-### PrepareTipOp
-```typescript
-/**
- * Query and store information about a reward.
- */
-export type PrepareTipOp = {
- op: WalletApiOperation.PrepareReward;
- request: PrepareRewardRequest;
- response: PrepareRewardResult;
-};
-// PrepareReward = "prepareReward"
-
-```
-```typescript
-export interface PrepareRewardRequest {
- talerRewardUri: string;
-}
-
-```
-```typescript
-export interface PrepareTipResult {
- /**
- * Unique ID for the tip assigned by the wallet.
- * Typically different from the merchant-generated tip ID.
- *
- * @deprecated use transactionId instead
- */
- walletRewardId: string;
- /**
- * Tip transaction ID.
- */
- transactionId: string;
- /**
- * Has the tip already been accepted?
- */
- accepted: boolean;
- /**
- * Amount that the merchant gave.
- */
- rewardAmountRaw: AmountString;
- /**
- * Amount that arrived at the wallet.
- * Might be lower than the raw amount due to fees.
- */
- rewardAmountEffective: AmountString;
- /**
- * Base URL of the merchant backend giving then tip.
- */
- merchantBaseUrl: string;
- /**
- * Base URL of the exchange that is used to withdraw the tip.
- * Determined by the merchant, the wallet/user has no choice here.
- */
- exchangeBaseUrl: string;
- /**
- * Time when the tip will expire. After it expired, it can't be picked
- * up anymore.
- */
- expirationTimestamp: TalerProtocolTimestamp;
-}
-
-```
-
-### AcceptTipOp
-```typescript
-/**
- * Accept a reward.
- */
-export type AcceptTipOp = {
- op: WalletApiOperation.AcceptReward;
- request: AcceptRewardRequest;
- response: AcceptTipResponse;
-};
-// AcceptReward = "acceptReward"
-
-```
-```typescript
-export interface AcceptRewardRequest {
- walletRewardId: string;
-}
-
-```
-```typescript
-export interface AcceptTipResponse {
- transactionId: TransactionIdStr;
- next_url?: string;
-}
-
-```
-
### ListExchangesOp
```typescript
/**
@@ -1720,7 +1650,7 @@ export interface CreateDepositGroupRequest {
* that occur while the operation has been created but
* before the creation request has returned.
*/
- transactionId?: string;
+ transactionId?: TransactionIdStr;
depositPaytoUri: string;
amount: AmountString;
}
@@ -2236,7 +2166,7 @@ export interface PreparePeerPushCreditResponse {
contractTerms: PeerContractTerms;
amountRaw: AmountString;
amountEffective: AmountString;
- transactionId: string;
+ transactionId: TransactionIdStr;
exchangeBaseUrl: string;
/**
* @deprecated use transaction ID instead.
@@ -2373,7 +2303,7 @@ export interface PreparePeerPullDebitResponse {
amountRaw: AmountString;
amountEffective: AmountString;
peerPullDebitId: string;
- transactionId: string;
+ transactionId: TransactionIdStr;
}
```
@@ -2399,7 +2329,7 @@ export interface ConfirmPeerPullDebitRequest {
* @deprecated use transactionId instead
*/
peerPullDebitId?: string;
- transactionId?: string;
+ transactionId?: TransactionIdStr;
}
```
@@ -2451,6 +2381,12 @@ export type ImportDbOp = {
// ImportDb = "importDb"
```
+```typescript
+export interface ImportDbRequest {
+ dump: any;
+}
+
+```
### ClearDbOp
```typescript
@@ -3241,7 +3177,7 @@ export type TestingWaitTransactionStateOp = {
```
```typescript
export interface TestingWaitTransactionRequest {
- transactionId: string;
+ transactionId: TransactionIdStr;
txState: TransactionState;
}
@@ -3374,7 +3310,8 @@ export type Transaction =
| TransactionPeerPullDebit
| TransactionPeerPushCredit
| TransactionPeerPushDebit
- | TransactionInternalWithdrawal;
+ | TransactionInternalWithdrawal
+ | TransactionRecoup;
```
```typescript
/**
@@ -3444,6 +3381,7 @@ export declare enum TransactionType {
PeerPushCredit = "peer-push-credit",
PeerPullDebit = "peer-pull-debit",
PeerPullCredit = "peer-pull-credit",
+ Recoup = "recoup",
}
```
```typescript
@@ -4060,6 +3998,14 @@ export interface TransactionInternalWithdrawal extends TransactionCommon {
}
```
```typescript
+/**
+ * The exchange revoked a key and the wallet recoups funds.
+ */
+export interface TransactionRecoup extends TransactionCommon {
+ type: TransactionType.Recoup;
+}
+```
+```typescript
export interface AbortTransactionRequest {
transactionId: TransactionIdStr;
}
