commit 9b681de10fb90dc925daa771793c60e41099888a
parent 59b4042e6c254e7b74074b06dfc4bd5d442a0c9a
Author: Florian Dold <florian@dold.me>
Date: Wed, 28 Aug 2024 23:33:25 +0200
update wallet-core API docs
Diffstat:
| M | wallet/wallet-core.md | | | 130 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- |
1 file changed, 129 insertions(+), 1 deletion(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -53,6 +53,8 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
* [RemoveGlobalCurrencyAuditorOp](#removeglobalcurrencyauditorop)
### Exchange Management
* [ListExchangesOp](#listexchangesop)
+* [StartExchangeWalletKycOp](#startexchangewalletkycop)
+* [TestingWaitExchangeWalletKycOp](#testingwaitexchangewalletkycop)
* [ListExchangesForScopedCurrencyOp](#listexchangesforscopedcurrencyop)
* [PrepareWithdrawExchangeOp](#preparewithdrawexchangeop)
* [AddExchangeOp](#addexchangeop)
@@ -99,6 +101,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
* [ValidateIbanOp](#validateibanop)
* [CanonicalizeBaseUrlOp](#canonicalizebaseurlop)
* [GetQrCodesForPaytoOp](#getqrcodesforpaytoop)
+* [GetBankingChoicesForPaytoOp](#getbankingchoicesforpaytoop)
### Database Management
* [ExportDbOp](#exportdbop)
* [ImportDbOp](#importdbop)
@@ -119,6 +122,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
* [TestingWaitTasksDoneOp](#testingwaittasksdoneop)
* [TestingWaitRefreshesFinalOp](#testingwaitrefreshesfinalop)
* [TestingWaitTransactionStateOp](#testingwaittransactionstateop)
+* [TestingWaitExchangeStateOp](#testingwaitexchangestateop)
* [TestingPingOp](#testingpingop)
* [TestingGetReserveHistoryOp](#testinggetreservehistoryop)
* [TestingResetAllRetriesOp](#testingresetallretriesop)
@@ -1301,6 +1305,48 @@ export interface ExchangesListResponse {
```
+### StartExchangeWalletKycOp
+```typescript
+export type StartExchangeWalletKycOp = {
+ op: WalletApiOperation.StartExchangeWalletKyc;
+ request: StartExchangeWalletKycRequest;
+ response: EmptyObject;
+};
+// StartExchangeWalletKyc = "startExchangeWalletKyc"
+
+```
+```typescript
+export interface StartExchangeWalletKycRequest {
+ exchangeBaseUrl: string;
+ amount: AmountString;
+}
+
+```
+
+### TestingWaitExchangeWalletKycOp
+```typescript
+export type TestingWaitExchangeWalletKycOp = {
+ op: WalletApiOperation.TestingWaitExchangeWalletKyc;
+ request: TestingWaitWalletKycRequest;
+ response: EmptyObject;
+};
+// TestingWaitExchangeWalletKyc = "testingWaitWalletKyc"
+
+```
+```typescript
+export interface TestingWaitWalletKycRequest {
+ exchangeBaseUrl: string;
+ amount: AmountString;
+ /**
+ * Do we wait for the KYC to be passed (true),
+ * or do we already return if legitimization is
+ * required (false).
+ */
+ passed: boolean;
+}
+
+```
+
### ListExchangesForScopedCurrencyOp
```typescript
/**
@@ -2750,6 +2796,37 @@ export interface QrCodeSpec {
```
+### GetBankingChoicesForPaytoOp
+```typescript
+export type GetBankingChoicesForPaytoOp = {
+ op: WalletApiOperation.GetBankingChoicesForPayto;
+ request: GetBankingChoicesForPaytoRequest;
+ response: GetBankingChoicesForPaytoResponse;
+};
+// GetBankingChoicesForPayto = "getBankingChoicesForPayto"
+
+```
+```typescript
+export interface GetBankingChoicesForPaytoRequest {
+ paytoUri: string;
+}
+
+```
+```typescript
+export interface GetBankingChoicesForPaytoResponse {
+ choices: BankingChoiceSpec[];
+}
+
+```
+```typescript
+export interface BankingChoiceSpec {
+ label: string;
+ type: "link";
+ uri: string;
+}
+
+```
+
### ExportDbOp
```typescript
/**
@@ -3265,6 +3342,27 @@ export interface TestingWaitTransactionRequest {
```
+### TestingWaitExchangeStateOp
+```typescript
+/**
+ * Wait until an exchange entry is in a particular state.
+ */
+export type TestingWaitExchangeStateOp = {
+ op: WalletApiOperation.TestingWaitTransactionState;
+ request: TestingWaitExchangeStateRequest;
+ response: EmptyObject;
+};
+// TestingWaitTransactionState = "testingWaitTransactionState"
+
+```
+```typescript
+export interface TestingWaitExchangeStateRequest {
+ exchangeBaseUrl: string;
+ walletKycStatus?: ExchangeWalletKycStatus;
+}
+
+```
+
### TestingPingOp
```typescript
export type TestingPingOp = {
@@ -3593,6 +3691,10 @@ export interface TransactionCommon {
type: TransactionType;
timestamp: TalerPreciseTimestamp;
/**
+ * Scope of this tx
+ */
+ scopes: ScopeInfo[];
+ /**
* Transaction state, as per DD37.
*/
txState: TransactionState;
@@ -3614,6 +3716,14 @@ export interface TransactionCommon {
* have the location where the user need to go to complete KYC information.
*/
kycUrl?: string;
+ /**
+ * KYC payto hash. Useful for testing, not so useful for UIs.
+ */
+ kycPaytoHash?: string;
+ /**
+ * KYC access token. Useful for testing, not so useful for UIs.
+ */
+ kycAccessToken?: string;
}
```
```typescript
@@ -3691,8 +3801,9 @@ export declare enum TransactionMinorState {
Unknown = "unknown",
Deposit = "deposit",
KycRequired = "kyc",
- AmlRequired = "aml",
MergeKycRequired = "merge-kyc",
+ BalanceKycRequired = "balance-kyc",
+ BalanceKycInit = "balance-kyc-init",
Track = "track",
SubmitPayment = "submit-payment",
RebindSession = "rebind-session",
@@ -4324,6 +4435,10 @@ export interface ExchangeListItem {
exchangeEntryStatus: ExchangeEntryStatus;
exchangeUpdateStatus: ExchangeUpdateStatus;
ageRestrictionOptions: number[];
+ walletKycStatus?: ExchangeWalletKycStatus;
+ walletKycReservePub?: string;
+ walletKycAccessToken?: string;
+ walletKycUrl?: string;
/**
* P2P payments are disabled with this exchange
* (e.g. because no global fees are configured).
@@ -4370,6 +4485,19 @@ export declare enum ExchangeUpdateStatus {
}
```
```typescript
+export declare enum ExchangeWalletKycStatus {
+ Done = "done",
+ /**
+ * Wallet needs to request KYC status.
+ */
+ LegiInit = "legi-init",
+ /**
+ * User requires KYC or AML.
+ */
+ Legi = "legi",
+}
+```
+```typescript
export interface OperationErrorInfo {
error: TalerErrorDetail;
}
