summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2022-11-01 15:33:29 +0100
committerFlorian Dold <florian@dold.me>2022-11-01 15:33:29 +0100
commitb010a415cd3bf837cefc63ec23a82cdc2a5b0c96 (patch)
tree1460cbc6b17ce1f804ef0c48553639393cbef42e
parent8083ad72a9fe238f336ad1bc37cf537b9c79bcfd (diff)
downloaddocs-b010a415cd3bf837cefc63ec23a82cdc2a5b0c96.tar.gz
docs-b010a415cd3bf837cefc63ec23a82cdc2a5b0c96.tar.bz2
docs-b010a415cd3bf837cefc63ec23a82cdc2a5b0c96.zip
update wallet-core API docs
-rw-r--r--wallet/wallet-core.md120
1 files changed, 66 insertions, 54 deletions
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
index 98f22c17..79ffedf1 100644
--- a/wallet/wallet-core.md
+++ b/wallet/wallet-core.md
@@ -1,7 +1,7 @@
# Wallet-Core API Documentation
This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core.git/tree/packages/taler-wallet-core/src/wallet-api-types.ts).
## Overview
-### Initialization
+### Unknown Group
* [InitWalletOp](#initwalletop)
* [GetVersionOp](#getversionop)
### Basic Wallet Information
@@ -88,7 +88,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core
*/
export type InitWalletOp = {
op: WalletApiOperation.InitWallet;
- request: {};
+ request: EmptyObject;
response: InitResponse;
};
// InitWallet = "initWallet"
@@ -105,7 +105,7 @@ export interface InitResponse {
```typescript
export type GetVersionOp = {
op: WalletApiOperation.GetVersion;
- request: {};
+ request: EmptyObject;
response: WalletCoreVersion;
};
// GetVersion = "getVersion"
@@ -119,7 +119,7 @@ export type GetVersionOp = {
*/
export type GetBalancesOp = {
op: WalletApiOperation.GetBalances;
- request: {};
+ request: EmptyObject;
response: BalancesResponse;
};
// GetBalances = "getBalances"
@@ -196,8 +196,8 @@ export interface TransactionByIdRequest {
```typescript
export type RetryPendingNowOp = {
op: WalletApiOperation.RetryPendingNow;
- request: {};
- response: {};
+ request: EmptyObject;
+ response: EmptyObject;
};
// RetryPendingNow = "retryPendingNow"
@@ -211,7 +211,7 @@ export type RetryPendingNowOp = {
export type DeleteTransactionOp = {
op: WalletApiOperation.DeleteTransaction;
request: DeleteTransactionRequest;
- response: {};
+ response: EmptyObject;
};
// DeleteTransaction = "deleteTransaction"
@@ -231,7 +231,7 @@ export interface DeleteTransactionRequest {
export type RetryTransactionOp = {
op: WalletApiOperation.RetryTransaction;
request: RetryTransactionRequest;
- response: {};
+ response: EmptyObject;
};
// RetryTransaction = "retryTransaction"
@@ -421,7 +421,7 @@ export declare type PreparePayResult =
export interface PreparePayResultInsufficientBalance {
status: PreparePayResultType.InsufficientBalance;
proposalId: string;
- contractTerms: ContractTerms;
+ contractTerms: MerchantContractTerms;
amountRaw: string;
noncePriv: string;
}
@@ -430,7 +430,7 @@ export interface PreparePayResultInsufficientBalance {
```typescript
export interface PreparePayResultAlreadyConfirmed {
status: PreparePayResultType.AlreadyConfirmed;
- contractTerms: ContractTerms;
+ contractTerms: MerchantContractTerms;
paid: boolean;
amountRaw: string;
amountEffective: string;
@@ -446,7 +446,7 @@ export interface PreparePayResultAlreadyConfirmed {
export interface PreparePayResultPaymentPossible {
status: PreparePayResultType.PaymentPossible;
proposalId: string;
- contractTerms: ContractTerms;
+ contractTerms: MerchantContractTerms;
contractTermsHash: string;
amountRaw: string;
amountEffective: string;
@@ -565,7 +565,7 @@ export declare type ConfirmPayResult =
*/
export interface ConfirmPayResultDone {
type: ConfirmPayResultType.Done;
- contractTerms: ContractTerms;
+ contractTerms: MerchantContractTerms;
transactionId: string;
}
@@ -587,7 +587,7 @@ export interface ConfirmPayResultPending {
export type AbortPayWithRefundOp = {
op: WalletApiOperation.AbortFailedPayWithRefund;
request: AbortPayWithRefundRequest;
- response: {};
+ response: EmptyObject;
};
// AbortFailedPayWithRefund = "abortFailedPayWithRefund"
@@ -730,7 +730,7 @@ export interface PrepareTipResult {
export type AcceptTipOp = {
op: WalletApiOperation.AcceptTip;
request: AcceptTipRequest;
- response: {};
+ response: EmptyObject;
};
// AcceptTip = "acceptTip"
@@ -749,7 +749,7 @@ export interface AcceptTipRequest {
*/
export type ListExchangesOp = {
op: WalletApiOperation.ListExchanges;
- request: {};
+ request: EmptyObject;
response: ExchangesListResponse;
};
// ListExchanges = "listExchanges"
@@ -770,7 +770,7 @@ export interface ExchangesListResponse {
export type AddExchangeOp = {
op: WalletApiOperation.AddExchange;
request: AddExchangeRequest;
- response: {};
+ response: EmptyObject;
};
// AddExchange = "addExchange"
@@ -862,7 +862,7 @@ export interface PaytoUriBitcoin extends PaytoUriGeneric {
export type AddKnownBankAccountsOp = {
op: WalletApiOperation.AddKnownBankAccounts;
request: AddKnownBankAccountsRequest;
- response: {};
+ response: EmptyObject;
};
// AddKnownBankAccounts = "addKnownBankAccounts"
@@ -881,7 +881,7 @@ export interface AddKnownBankAccountsRequest {
export type ForgetKnownBankAccountsOp = {
op: WalletApiOperation.ForgetKnownBankAccounts;
request: ForgetKnownBankAccountsRequest;
- response: {};
+ response: EmptyObject;
};
// ForgetKnownBankAccounts = "forgetKnownBankAccounts"
@@ -901,7 +901,7 @@ export interface ForgetKnownBankAccountsRequest {
export type SetExchangeTosAcceptedOp = {
op: WalletApiOperation.SetExchangeTosAccepted;
request: AcceptExchangeTosRequest;
- response: {};
+ response: EmptyObject;
};
// SetExchangeTosAccepted = "setExchangeTosAccepted"
@@ -1034,7 +1034,7 @@ export interface FeeDescription {
*/
export type ListCurrenciesOp = {
op: WalletApiOperation.ListCurrencies;
- request: {};
+ request: EmptyObject;
response: WalletCurrencyInfo;
};
// ListCurrencies = "listCurrencies"
@@ -1161,8 +1161,8 @@ export interface PrepareDepositRequest {
```
```typescript
export interface PrepareDepositResponse {
- totalDepositCost: AmountJson;
- effectiveDepositAmount: AmountJson;
+ totalDepositCost: AmountString;
+ effectiveDepositAmount: AmountString;
}
```
@@ -1174,7 +1174,7 @@ export interface PrepareDepositResponse {
*/
export type ExportBackupRecoveryOp = {
op: WalletApiOperation.ExportBackupRecovery;
- request: {};
+ request: EmptyObject;
response: BackupRecovery;
};
// ExportBackupRecovery = "exportBackupRecovery"
@@ -1189,7 +1189,7 @@ export type ExportBackupRecoveryOp = {
export type ImportBackupRecoveryOp = {
op: WalletApiOperation.ImportBackupRecovery;
request: RecoveryLoadRequest;
- response: {};
+ response: EmptyObject;
};
// ImportBackupRecovery = "importBackupRecovery"
@@ -1228,19 +1228,28 @@ export declare enum RecoveryMergeStrategy {
*/
export type RunBackupCycleOp = {
op: WalletApiOperation.RunBackupCycle;
- request: {};
- response: {};
+ request: RunBackupCycleRequest;
+ response: EmptyObject;
};
// RunBackupCycle = "runBackupCycle"
```
+```typescript
+export interface RunBackupCycleRequest {
+ /**
+ * List of providers to backup or empty for all known providers.
+ */
+ providers?: Array<string>;
+}
+
+```
### ExportBackupOp
```typescript
export type ExportBackupOp = {
op: WalletApiOperation.ExportBackup;
- request: {};
- response: {};
+ request: EmptyObject;
+ response: EmptyObject;
};
// ExportBackup = "exportBackup"
@@ -1254,7 +1263,7 @@ export type ExportBackupOp = {
export type AddBackupProviderOp = {
op: WalletApiOperation.AddBackupProvider;
request: AddBackupProviderRequest;
- response: {};
+ response: EmptyObject;
};
// AddBackupProvider = "addBackupProvider"
@@ -1277,7 +1286,7 @@ export interface AddBackupProviderRequest {
export type RemoveBackupProviderOp = {
op: WalletApiOperation.RemoveBackupProvider;
request: RemoveBackupProviderRequest;
- response: {};
+ response: EmptyObject;
};
// RemoveBackupProvider = "removeBackupProvider"
@@ -1296,7 +1305,7 @@ export interface RemoveBackupProviderRequest {
*/
export type GetBackupInfoOp = {
op: WalletApiOperation.GetBackupInfo;
- request: {};
+ request: EmptyObject;
response: BackupInfo;
};
// GetBackupInfo = "getBackupInfo"
@@ -1417,7 +1426,7 @@ export interface ProviderPaymentPending {
export type SetWalletDeviceIdOp = {
op: WalletApiOperation.SetWalletDeviceId;
request: SetWalletDeviceIdRequest;
- response: {};
+ response: EmptyObject;
};
// SetWalletDeviceId = "setWalletDeviceId"
@@ -1439,7 +1448,7 @@ export interface SetWalletDeviceIdRequest {
*/
export type ExportBackupPlainOp = {
op: WalletApiOperation.ExportBackupPlain;
- request: {};
+ request: EmptyObject;
response: WalletBackupContentV1;
};
// ExportBackupPlain = "exportBackupPlain"
@@ -1514,7 +1523,7 @@ export interface CheckPeerPushPaymentResponse {
export type AcceptPeerPushPaymentOp = {
op: WalletApiOperation.AcceptPeerPushPayment;
request: AcceptPeerPushPaymentRequest;
- response: {};
+ response: EmptyObject;
};
// AcceptPeerPushPayment = "acceptPeerPushPayment"
@@ -1601,7 +1610,7 @@ export interface CheckPeerPullPaymentResponse {
export type AcceptPeerPullPaymentOp = {
op: WalletApiOperation.AcceptPeerPullPayment;
request: AcceptPeerPullPaymentRequest;
- response: {};
+ response: EmptyObject;
};
// AcceptPeerPullPayment = "acceptPeerPullPayment"
@@ -1623,7 +1632,7 @@ export interface AcceptPeerPullPaymentRequest {
*/
export type ExportDbOp = {
op: WalletApiOperation.ExportDb;
- request: {};
+ request: EmptyObject;
response: any;
};
// ExportDb = "exportDb"
@@ -1648,8 +1657,8 @@ export type ImportDbOp = {
*/
export type ClearDbOp = {
op: WalletApiOperation.ClearDb;
- request: {};
- response: {};
+ request: EmptyObject;
+ response: EmptyObject;
};
// ClearDb = "clearDb"
@@ -1662,8 +1671,8 @@ export type ClearDbOp = {
*/
export type RecycleOp = {
op: WalletApiOperation.Recycle;
- request: {};
- response: {};
+ request: EmptyObject;
+ response: EmptyObject;
};
// Recycle = "recycle"
@@ -1680,7 +1689,7 @@ export type RecycleOp = {
export type ApplyDevExperimentOp = {
op: WalletApiOperation.ApplyDevExperiment;
request: ApplyDevExperimentRequest;
- response: {};
+ response: EmptyObject;
};
// ApplyDevExperiment = "applyDevExperiment"
@@ -1697,7 +1706,7 @@ export interface ApplyDevExperimentRequest {
export type SetDevModeOp = {
op: WalletApiOperation.SetDevMode;
request: SetDevModeRequest;
- response: {};
+ response: EmptyObject;
};
// SetDevMode = "setDevMode"
@@ -1718,7 +1727,7 @@ export interface SetDevModeRequest {
export type RunIntegrationTestOp = {
op: WalletApiOperation.RunIntegrationTest;
request: IntegrationTestArgs;
- response: {};
+ response: EmptyObject;
};
// RunIntegrationTest = "runIntegrationTest"
@@ -1743,7 +1752,7 @@ export interface IntegrationTestArgs {
*/
export type TestCryptoOp = {
op: WalletApiOperation.TestCrypto;
- request: {};
+ request: EmptyObject;
response: any;
};
// TestCrypto = "testCrypto"
@@ -1759,7 +1768,7 @@ export type TestCryptoOp = {
export type WithdrawTestBalanceOp = {
op: WalletApiOperation.WithdrawTestBalance;
request: WithdrawTestBalanceRequest;
- response: {};
+ response: EmptyObject;
};
// WithdrawTestBalance = "withdrawTestBalance"
@@ -1785,8 +1794,8 @@ export interface WithdrawTestBalanceRequest {
*/
export type WithdrawTestkudosOp = {
op: WalletApiOperation.WithdrawTestkudos;
- request: {};
- response: {};
+ request: EmptyObject;
+ response: EmptyObject;
};
// WithdrawTestkudos = "withdrawTestkudos"
@@ -1862,7 +1871,7 @@ export interface PayCoinSelection {
export type WithdrawFakebankOp = {
op: WalletApiOperation.WithdrawFakebank;
request: WithdrawFakebankRequest;
- response: {};
+ response: EmptyObject;
};
// WithdrawFakebank = "withdrawFakebank"
@@ -1883,7 +1892,7 @@ export interface WithdrawFakebankRequest {
*/
export type GetPendingTasksOp = {
op: WalletApiOperation.GetPendingOperations;
- request: {};
+ request: EmptyObject;
response: PendingTasksResponse;
};
// GetPendingOperations = "getPendingOperations"
@@ -2180,7 +2189,7 @@ export interface PendingBackupTask {
*/
export type DumpCoinsOp = {
op: WalletApiOperation.DumpCoins;
- request: {};
+ request: EmptyObject;
response: CoinDumpJson;
};
// DumpCoins = "dumpCoins"
@@ -2341,7 +2350,7 @@ export declare type Edx25519PrivateKeyEnc = FlavorP<
export type SetCoinSuspendedOp = {
op: WalletApiOperation.SetCoinSuspended;
request: SetCoinSuspendedRequest;
- response: {};
+ response: EmptyObject;
};
// SetCoinSuspended = "setCoinSuspended"
@@ -2363,7 +2372,7 @@ export interface SetCoinSuspendedRequest {
export type ForceRefreshOp = {
op: WalletApiOperation.ForceRefresh;
request: ForceRefreshRequest;
- response: {};
+ response: EmptyObject;
};
// ForceRefresh = "forceRefresh"
@@ -2383,7 +2392,7 @@ export interface WalletCoreVersion {
exchange: string;
merchant: string;
bank: string;
- devMode?: boolean;
+ devMode: boolean;
}
```
```typescript
@@ -2859,6 +2868,7 @@ export interface ExchangeListItem {
paytoUris: string[];
tosStatus: ExchangeTosStatus;
exchangeStatus: ExchangeEntryStatus;
+ supportedAgeGroups: number[];
/**
* Permanently added to the wallet, as opposed to just
* temporarily queried.
@@ -2893,8 +2903,9 @@ export interface ForcedDenomSel {
```typescript
/**
* Contract terms from a merchant.
+ * FIXME: Add type field!
*/
-export interface ContractTerms {
+export interface MerchantContractTerms {
/**
* Hash of the merchant's wire details.
*/
@@ -3116,6 +3127,7 @@ export interface Duration {
export interface BackupRecovery {
walletRootPriv: string;
providers: {
+ name: string;
url: string;
}[];
}