updated signBTCtx request

- supports new keys to show more details of the tx in the keyguard
nimiq · Feb 22, 2022 · 9ff2089 · 9ff2089
1 parent 0dfee63
commit 9ff2089
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 5 deletions.
diff --git a/demos/Demo.ts b/demos/Demo.ts
@@ -18,7 +18,7 @@ import {
     SetupSwapRequest,
 } from '../src/lib/PublicRequestTypes';
 import { RedirectRequestBehavior, PopupRequestBehavior } from '../client/RequestBehavior';
-import { Utf8Tools } from '@nimiq/utils';
+import { FiatApiSupportedFiatCurrency, Utf8Tools } from '@nimiq/utils';
 import { WalletType } from '../src/lib/Constants';
 import { WalletStore } from '../src/lib/WalletStore';
 
@@ -494,6 +494,10 @@ class Demo {
                     value: Math.round(0.009 * 1e8),
                     label: 'Paul McCartney',
                 },
+                delay: 12,
+                fiatCurrency: FiatApiSupportedFiatCurrency.EUR,
+                fiatRate: 38662.93,
+                feePerByte: 68,
                 // changeOutput: {
                 //     keyPath: 'm/49\'/1\'/0\'/1/0',
                 //     address: '',

diff --git a/src/lib/PublicRequestTypes.ts b/src/lib/PublicRequestTypes.ts
@@ -6,6 +6,7 @@ import type { BitcoinSpecifics } from './paymentOptions/BitcoinPaymentOptions';
 import type { BitcoinDirectPaymentOptions } from './paymentOptions/BitcoinPaymentOptions';
 import type { EtherSpecifics } from './paymentOptions/EtherPaymentOptions';
 import type { EtherDirectPaymentOptions } from './paymentOptions/EtherPaymentOptions';
+import { FiatApiSupportedFiatCurrency } from '@nimiq/utils';
 
 export enum RequestType {
     LIST = 'list',
@@ -522,6 +523,12 @@ export interface SignBtcTransactionRequest extends SimpleRequest {
         value: number,
     };
     locktime?: number;
+
+    // Data needed for display in a standard BTC transaction
+    fiatCurrency?: FiatApiSupportedFiatCurrency;
+    fiatRate?: number;
+    delay?: number;
+    feePerByte?: number;
 }
 
 export interface SignedBtcTransaction {

diff --git a/src/lib/RequestParser.ts b/src/lib/RequestParser.ts
@@ -500,6 +500,29 @@ export class RequestParser {
                     throw new Error('Invalid locktime');
                 }
 
+                const delay = signBtcTransactionRequest.delay;
+                if (!delay || delay < 1 || delay >= 100) {
+                    throw new Error('Invalid delay');
+                }
+
+                const fiatRate = signBtcTransactionRequest.fiatRate;
+                if (!fiatRate || !Nimiq.NumberUtils.isUint32(fiatRate)) {
+                    throw new Error('Invalid fiatRate');
+                }
+
+                const fiatCurrency = signBtcTransactionRequest.fiatCurrency;
+                if (!fiatCurrency) {
+                    throw new Error('Invalid fiatCurrency');
+                } else if (typeof fiatCurrency !== 'string' || !/^[a-z]{3}$/i.test(fiatCurrency)) {
+                    throw new Error(`Invalid fiatCurrency code ${fiatCurrency}`);
+                }
+
+                const feePerByte = signBtcTransactionRequest.feePerByte;
+                if (!feePerByte || !Nimiq.NumberUtils.isUint32(feePerByte)) {
+                    throw new Error('Invalid feePerByte');
+                }
+
+
                 const parsedSignBtcTransactionRequest: ParsedSignBtcTransactionRequest = {
                     kind: RequestType.SIGN_BTC_TRANSACTION,
                     walletId: signBtcTransactionRequest.accountId,
@@ -508,6 +531,11 @@ export class RequestParser {
                     output,
                     changeOutput,
                     locktime,
+
+                    delay,
+                    fiatCurrency: fiatCurrency.toUpperCase(),
+                    fiatRate,
+                    feePerByte
                 };
                 return parsedSignBtcTransactionRequest;
             case RequestType.SETUP_SWAP:
@@ -768,6 +796,10 @@ export class RequestParser {
                     output: signBtcTransactionRequest.output,
                     changeOutput: signBtcTransactionRequest.changeOutput,
                     locktime: signBtcTransactionRequest.locktime,
+                    fiatCurrency: signBtcTransactionRequest.fiatCurrency,
+                    fiatRate: signBtcTransactionRequest.fiatRate,
+                    delay: signBtcTransactionRequest.delay,
+                    feePerByte: signBtcTransactionRequest.feePerByte,
                 } as SignBtcTransactionRequest;
             case RequestType.SETUP_SWAP:
                 const setupSwapRequest = request as ParsedSetupSwapRequest;

diff --git a/src/lib/RequestTypes.ts b/src/lib/RequestTypes.ts
@@ -138,6 +138,12 @@ export interface ParsedSignBtcTransactionRequest extends ParsedSimpleRequest {
         value: number,
     };
     locktime?: number;
+
+    // Data needed for display
+    fiatCurrency: string;
+    fiatRate: number;
+    delay: number;
+    feePerByte: number;
 }
 
 export interface ParsedAddBtcAddressesRequest extends ParsedSimpleRequest {

diff --git a/src/views/SignBtcTransaction.vue b/src/views/SignBtcTransaction.vue
@@ -16,11 +16,14 @@ import type {
     SignBtcTransactionRequest as KeyguardSignBtcTransactionRequest,
     BitcoinTransactionInput,
     BitcoinTransactionChangeOutput,
-    BitcoinTransactionInfo as KeyguardBitcoinTransactionInfo,
+    BitcoinTransactionInfo,
+    SignBtcTransactionRequestStandard
 } from '@nimiq/keyguard-client';
 
-// BitcoinTransactionInfo with complete changeOutput
-export type BitcoinTransactionInfo = Omit<KeyguardBitcoinTransactionInfo, 'changeOutput'> & {
+// StandardBitcoinTransactionInfo with complete changeOutput
+export type StandardBitcoinTransactionInfo = Pick<BitcoinTransactionInfo, 'inputs' | 'recipientOutput' | 'locktime'> & 
+    // Data needed for display
+    Pick<SignBtcTransactionRequestStandard, 'fiatCurrency' | 'fiatRate' | 'delay' | 'feePerByte'> & {
     changeOutput?: Required<BitcoinTransactionChangeOutput>,
 };
 
@@ -108,10 +111,14 @@ export default class SignBtcTransaction extends BitcoinSyncBaseView {
             changeOutput,
             recipientOutput: this.request.output,
             locktime: this.request.locktime,
+            delay: this.request.delay,
+            fiatCurrency: this.request.fiatCurrency,
+            fiatRate: this.request.fiatRate,
+            feePerByte: this.request.feePerByte,
         }, walletInfo);
     }
 
-    protected _signBtcTransaction(transactionInfo: BitcoinTransactionInfo, walletInfo: WalletInfo) {
+    protected _signBtcTransaction(transactionInfo: StandardBitcoinTransactionInfo, walletInfo: WalletInfo) {
         // note that this method gets overwritten for SignBtcTransactionLedger
 
         const request: KeyguardSignBtcTransactionRequest = {