commit ff8dc34bf5323031a641a6cdba37958a0ce7edbe parent d9f7d8e3182bf43c9e226324ea3fe311949c952d Author: Florian Dold <florian@dold.me> Date: Tue, 22 Oct 2024 15:28:35 +0200 update wallet-core API docs Diffstat:
| M | wallet/wallet-core.md | | | 29 | +++++++++++++++++++++++++---- |
1 file changed, 25 insertions(+), 4 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md @@ -4750,15 +4750,36 @@ export interface PreparePayResultAlreadyConfirmed { export interface PreparePayResultPaymentPossible { status: PreparePayResultType.PaymentPossible; transactionId: TransactionIdStr; + contractTerms: MerchantContractTerms; /** - * @deprecated use transactionId instead + * Details per currecy scope. + * + * Typically, only one scope is involved. + * + * In later versions, we might return more info here, + * such as the amount that each scope contributes + * to the transaction */ - proposalId: string; - contractTerms: MerchantContractTerms; - contractTermsHash: string; + detailsPerScope: PerScopeDetails[]; amountRaw: AmountString; amountEffective: AmountString; + /** + * FIXME: Unclear why this is needed. Remove? + */ + contractTermsHash: string; + /** + * FIXME: Unclear why this is needed! Remove? + */ talerUri: string; + /** + * @deprecated use transactionId instead + */ + proposalId: string; +} +``` +```typescript +export interface PerScopeDetails { + scopeInfo: ScopeInfo; } ``` ```typescript