commit 39d4979482cee41a6993505e75f0462a12cafb63
parent 38b8831a3ad9bcfe6d8b83b049c4505efcf9131e
Author: Florian Dold <florian@dold.me>
Date: Thu, 23 Jul 2026 13:51:34 +0200
update wallet-core docs
Diffstat:
| M | wallet/wallet-core.md | | | 194 | +++++++++++++++++++++++++++++++++++++++++-------------------------------------- |
1 file changed, 101 insertions(+), 93 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -449,6 +449,28 @@ export type RegisterAliasOp = {
// RegisterAlias = "registerAlias"
```
+```typescript
+export interface TaldirRegistrationRequest {
+ alias: string;
+ aliasType: string;
+ targetUri: string;
+ taldirBaseUrl: string;
+ duration: RelativeTime;
+}
+
+```
+```typescript
+export type TaldirRegistrationResponse =
+ | TaldirAlreadyPaidResponse
+ | EmptyObject;
+
+```
+```typescript
+export interface TaldirAlreadyPaidResponse {
+ valid_for: RelativeTime;
+}
+
+```
### CompleteRegisterAliasOp
```typescript
@@ -463,6 +485,16 @@ export type CompleteRegisterAliasOp = {
// CompleteRegisterAlias = "completeRegisterAlias"
```
+```typescript
+export interface TaldirRegistrationCompletionRequest {
+ alias: string;
+ aliasType: string;
+ challenge: string;
+ taldirBaseUrl: string;
+ targetUri: string;
+}
+
+```
### LookupAliasOp
```typescript
@@ -477,6 +509,20 @@ export type LookupAliasOp = {
// LookupAlias = "lookupAlias"
```
+```typescript
+export interface TaldirLookupRequest {
+ alias: string;
+ aliasType: string;
+ taldirBaseUrl: string;
+}
+
+```
+```typescript
+export interface TaldirLookupResponse {
+ targetUri?: string;
+}
+
+```
### RefreshMailboxOp
```typescript
@@ -491,6 +537,12 @@ export type RefreshMailboxOp = {
// RefreshMailbox = "refreshMailbox"
```
+```typescript
+export interface MailboxMessageRecordsResponse {
+ messages: MailboxMessageRecord[];
+}
+
+```
### InitializeMailboxOp
```typescript
@@ -1212,18 +1264,7 @@ export interface GetWithdrawalDetailsForAmountRequest {
restrictScope?: ScopeInfo;
amount: AmountString;
restrictAge?: number;
- /**
- * ID provided by the client to cancel the request.
- *
- * If the same request is made again with the same clientCancellationId,
- * all previous requests are cancelled.
- *
- * The cancelled request will receive an error response with
- * an error code that indicates the cancellation.
- *
- * The cancellation is best-effort, responses might still arrive.
- */
- clientCancellationId?: string;
+ progressToken?: string;
}
```
@@ -1278,13 +1319,6 @@ export interface WithdrawalDetailsForAmount {
* @deprecated in favor of withdrawalAccountsList
*/
paytoUris: string[];
- /**
- * Did the user accept the current version of the exchange's
- * terms of service?
- *
- * @deprecated the client should query the exchange entry instead
- */
- tosAccepted: boolean;
}
```
@@ -1311,6 +1345,7 @@ export interface GetWithdrawalDetailsForUriRequest {
* @deprecated not used
*/
restrictAge?: number;
+ progressToken?: string;
}
```
@@ -1331,6 +1366,7 @@ export type PrepareBankIntegratedWithdrawalOp = {
```typescript
export interface PrepareBankIntegratedWithdrawalRequest {
talerWithdrawUri: string;
+ progressToken?: string;
}
```
@@ -1359,9 +1395,10 @@ export type ConfirmWithdrawalOp = {
export interface ConfirmWithdrawalRequest {
transactionId: string;
exchangeBaseUrl: string;
- amount: AmountString | undefined;
+ amount?: AmountString | undefined;
forcedDenomSel?: ForcedDenomSel;
restrictAge?: number;
+ progressToken?: string;
}
```
@@ -1394,6 +1431,7 @@ export interface AcceptBankIntegratedWithdrawalRequest {
*/
amount?: AmountString;
restrictAge?: number;
+ progressToken?: string;
}
```
@@ -1431,6 +1469,7 @@ export interface AcceptManualWithdrawalRequest {
* to developer mode.
*/
forceReservePriv?: EddsaPrivateKeyString;
+ progressToken?: string;
}
```
@@ -1691,6 +1730,7 @@ export type CheckPayForTemplateOp = {
```typescript
export interface CheckPayTemplateRequest {
talerPayTemplateUri: string;
+ progressToken?: string;
}
```
@@ -1725,7 +1765,6 @@ export interface TemplateContractFixedOrder extends TemplateContractCommon {
```
```typescript
export interface TemplateContractCommon {
- template_type: TemplateType;
summary?: string;
currency?: string;
pay_duration?: RelativeTime;
@@ -1736,14 +1775,6 @@ export interface TemplateContractCommon {
```
```typescript
-export declare enum TemplateType {
- FIXED_ORDER = "fixed-order",
- INVENTORY_CART = "inventory-cart",
- PAIVANA = "paivana",
-}
-
-```
-```typescript
export interface TemplateContractInventoryCart extends TemplateContractCommon {
template_type: TemplateType.INVENTORY_CART;
selected_all?: boolean;
@@ -1934,7 +1965,7 @@ export interface ConfirmPayResultDone {
export interface ConfirmPayResultPending {
type: ConfirmPayResultType.Pending;
transactionId: TransactionIdStr;
- lastError: TalerErrorDetail | undefined;
+ lastError?: TalerErrorDetail | undefined;
}
```
@@ -2422,6 +2453,7 @@ export interface AddExchangeRequest {
* @deprecated Use {@link uri} instead
*/
exchangeBaseUrl?: string;
+ progressToken?: string;
}
```
@@ -3043,6 +3075,7 @@ export interface CreateDepositGroupRequest {
* before the creation request has returned.
*/
transactionId?: TransactionIdStr;
+ progressToken?: string;
}
```
@@ -3096,18 +3129,7 @@ export interface CheckDepositRequest {
* Restrict the deposit to a certain scope.
*/
restrictScope?: ScopeInfo;
- /**
- * ID provided by the client to cancel the request.
- *
- * If the same request is made again with the same clientCancellationId,
- * all previous requests are cancelled.
- *
- * The cancelled request will receive an error response with
- * an error code that indicates the cancellation.
- *
- * The cancellation is best-effort, responses might still arrive.
- */
- clientCancellationId?: string;
+ progressToken?: string;
}
```
@@ -3387,6 +3409,7 @@ export type PreparePeerPushCreditOp = {
export interface PreparePeerPushCreditRequest {
talerUri?: string;
transactionId?: string;
+ progressToken?: string;
}
```
@@ -3426,6 +3449,7 @@ export type ConfirmPeerPushCreditOp = {
```typescript
export interface ConfirmPeerPushCreditRequest {
transactionId: string;
+ progressToken?: string;
}
```
@@ -3457,18 +3481,7 @@ export interface CheckPeerPullCreditRequest {
exchangeBaseUrl?: string;
restrictScope?: ScopeInfo;
amount: AmountString;
- /**
- * ID provided by the client to cancel the request.
- *
- * If the same request is made again with the same clientCancellationId,
- * all previous requests are cancelled.
- *
- * The cancelled request will receive an error response with
- * an error code that indicates the cancellation.
- *
- * The cancellation is best-effort, responses might still arrive.
- */
- clientCancellationId?: string;
+ progressToken?: string;
}
```
@@ -3503,6 +3516,7 @@ export type InitiatePeerPullCreditOp = {
export interface InitiatePeerPullCreditRequest {
exchangeBaseUrl?: string;
partialContractTerms: PeerContractTerms;
+ progressToken?: string;
}
```
@@ -3542,6 +3556,7 @@ export type PreparePeerPullDebitOp = {
export interface PreparePeerPullDebitRequest {
talerUri?: string;
transactionId?: string;
+ progressToken?: string;
}
```
@@ -3771,7 +3786,7 @@ export type ImportDbOp = {
```
```typescript
export interface ImportDbRequest {
- dump: any;
+ dump?: any;
}
```
@@ -4001,11 +4016,11 @@ export interface GetActiveTasksResponse {
```typescript
export interface ActiveTask {
taskId: string;
- transaction: TransactionIdStr | undefined;
- firstTry: AbsoluteTime | undefined;
- nextTry: AbsoluteTime | undefined;
- retryCounter: number | undefined;
- lastError: TalerErrorDetail | undefined;
+ transaction?: TransactionIdStr | undefined;
+ firstTry?: AbsoluteTime | undefined;
+ nextTry?: AbsoluteTime | undefined;
+ retryCounter?: number | undefined;
+ lastError?: TalerErrorDetail | undefined;
}
```
@@ -4930,6 +4945,21 @@ export interface ContactEntry {
}
```
```typescript
+export interface TalerProtocolDuration {
+ readonly d_us: number | "forever";
+}
+```
+```typescript
+export interface DurationUnitSpec {
+ seconds?: number;
+ minutes?: number;
+ hours?: number;
+ days?: number;
+ months?: number;
+ years?: number;
+}
+```
+```typescript
export interface MailboxConfiguration {
mailboxBaseUrl: string;
privateKey: EddsaPrivateKeyString;
@@ -4978,6 +5008,7 @@ export interface TalerPayUriResult {
* "continue on mobile" payment flow.
*/
noncePriv?: string;
+ nfc?: boolean;
}
```
```typescript
@@ -4996,6 +5027,7 @@ export interface TalerPayTemplateUri {
summary?: string;
editableAmount?: boolean;
amount?: AmountString;
+ nfc?: boolean;
}
```
```typescript
@@ -5072,11 +5104,6 @@ export interface TalerAddContactUri {
}
```
```typescript
-export interface MailboxBaseUrl {
- mailboxBaseUrl: string;
-}
-```
-```typescript
/**
* Record metadata for mailbox messages
*/
@@ -5087,6 +5114,11 @@ export interface MailboxMessageRecord {
}
```
```typescript
+export interface MailboxBaseUrl {
+ mailboxBaseUrl: string;
+}
+```
+```typescript
export type ScopeInfo = ScopeInfoGlobal | ScopeInfoExchange | ScopeInfoAuditor;
```
```typescript
@@ -5337,6 +5369,7 @@ export declare enum TransactionMinorState {
Track = "track",
Unknown = "unknown",
Withdraw = "withdraw",
+ Abort = "abort",
}
```
```typescript
@@ -5376,21 +5409,6 @@ export interface Duration {
}
```
```typescript
-export interface DurationUnitSpec {
- seconds?: number;
- minutes?: number;
- hours?: number;
- days?: number;
- months?: number;
- years?: number;
-}
-```
-```typescript
-export interface TalerProtocolDuration {
- readonly d_us: number | "forever";
-}
-```
-```typescript
export interface KycAuthTransferInfo {
/**
* Payto URI of the account that must make the transfer.
@@ -6491,7 +6509,7 @@ export interface PreparePayResultAlreadyConfirmed {
contractTerms: MerchantContractTerms;
paid: boolean;
amountRaw: AmountString;
- amountEffective: AmountString | undefined;
+ amountEffective?: AmountString | undefined;
/**
* Scopes involved in this transaction.
*/
@@ -6543,6 +6561,7 @@ export interface PreparePayResultChoiceSelection {
export interface PreparePayTemplateRequest {
talerPayTemplateUri: string;
templateParams?: TemplateParams;
+ progressToken?: string;
}
```
```typescript
@@ -6683,18 +6702,7 @@ export interface CheckPeerPushDebitRequest {
* scope info.
*/
restrictScope?: ScopeInfo;
- /**
- * ID provided by the client to cancel the request.
- *
- * If the same request is made again with the same clientCancellationId,
- * all previous requests are cancelled.
- *
- * The cancelled request will receive an error response with
- * an error code that indicates the cancellation.
- *
- * The cancellation is best-effort, responses might still arrive.
- */
- clientCancellationId?: string;
+ progressToken?: string;
}
```
```typescript
