blockchainSubscribe: param "accounts" optional (#566)

trezor · Apr 16, 2020 · 82f1d6a · 82f1d6a
1 parent c1ea517
commit 82f1d6a
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 16 deletions.
diff --git a/src/js/backend/BlockchainLink.js b/src/js/backend/BlockchainLink.js
@@ -87,6 +87,7 @@ export default class Blockchain {
                 coin: this.coinInfo,
                 ...info,
             }));
+            // TODO: check for 1st block hash (different for btc forks)
         });
 
         this.link.on('disconnected', () => {
@@ -167,7 +168,7 @@ export default class Blockchain {
         return this.link.estimateFee(request);
     }
 
-    async subscribe(accounts: BlockchainSubscribeAccount[]) {
+    async subscribe(accounts?: BlockchainSubscribeAccount[]) {
         // set block listener if it wasn't set before
         if (this.link.listenerCount('block') === 0) {
             this.link.on('block', (block: BlockchainBlock) => {
@@ -188,7 +189,10 @@ export default class Blockchain {
             });
         }
 
-        await this.link.subscribe({ type: 'block' });
+        const blockSubscription = await this.link.subscribe({ type: 'block' });
+        if (!accounts) {
+            return blockSubscription;
+        }
 
         return this.link.subscribe({
             type: 'accounts',
@@ -221,9 +225,8 @@ export default class Blockchain {
             this.link.removeAllListeners('notification');
 
             // remove all subscriptions
-            await this.link.unsubscribe({ type: 'block' });
             await this.link.unsubscribe({ type: 'fiatRates' });
-            return this.link.unsubscribe({ type: 'notification' });
+            return this.link.unsubscribe({ type: 'block' });
         }
         // unsubscribe only requested accounts
         return this.link.unsubscribe({ type: 'accounts', accounts });

diff --git a/src/js/core/methods/blockchain/BlockchainSubscribe.js b/src/js/core/methods/blockchain/BlockchainSubscribe.js
@@ -9,7 +9,7 @@ import { getCoinInfo } from '../../../data/CoinInfo';
 import type { CoreMessage, CoinInfo, BlockchainSubscribeAccount } from '../../../types';
 
 type Params = {
-    accounts: BlockchainSubscribeAccount[];
+    accounts?: BlockchainSubscribeAccount[];
     coinInfo: CoinInfo;
 }
 
@@ -25,15 +25,17 @@ export default class BlockchainSubscribe extends AbstractMethod {
 
         // validate incoming parameters
         validateParams(payload, [
-            { name: 'accounts', type: 'array', obligatory: true },
+            { name: 'accounts', type: 'array', allowEmpty: true },
             { name: 'coin', type: 'string', obligatory: true },
         ]);
 
-        payload.accounts.forEach(account => {
-            validateParams(account, [
-                { name: 'descriptor', type: 'string', obligatory: true },
-            ]);
-        });
+        if (payload.accounts) {
+            payload.accounts.forEach(account => {
+                validateParams(account, [
+                    { name: 'descriptor', type: 'string', obligatory: true },
+                ]);
+            });
+        }
 
         const coinInfo = getCoinInfo(payload.coin);
         if (!coinInfo) {

diff --git a/src/js/core/methods/blockchain/BlockchainUnsubscribe.js b/src/js/core/methods/blockchain/BlockchainUnsubscribe.js
@@ -25,7 +25,7 @@ export default class BlockchainUnsubscribe extends AbstractMethod {
 
         // validate incoming parameters
         validateParams(payload, [
-            { name: 'accounts', type: 'array' },
+            { name: 'accounts', type: 'array', allowEmpty: true },
             { name: 'coin', type: 'string', obligatory: true },
         ]);
 

diff --git a/src/js/types/__tests__/blockchain.js b/src/js/types/__tests__/blockchain.js
@@ -96,18 +96,30 @@ export const others = async () => {
         coin: 'btc',
     });
 
+    TrezorConnect.blockchainSubscribe({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainUnsubscribe({
         accounts,
         coin: 'btc',
     });
 
+    TrezorConnect.blockchainUnsubscribe({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainDisconnect({ coin: 'btc' });
 
     TrezorConnect.blockchainSetCustomBackend({
         coin: 'btc',
         blockchainLink: undefined,
     });
 
+    TrezorConnect.blockchainSetCustomBackend({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainSetCustomBackend({
         coin: 'btc',
         blockchainLink: {

diff --git a/src/js/types/backend/blockchain.js b/src/js/types/backend/blockchain.js
@@ -58,7 +58,7 @@ export type BlockchainSubscribeFiatRates = {
 }
 
 export type BlockchainSubscribe = {
-    accounts: BlockchainSubscribeAccount[];
+    accounts?: BlockchainSubscribeAccount[];
     coin: string;
 }
 
@@ -146,7 +146,7 @@ export type BlockchainEstimatedFee = {
 
 export type BlockchainSetCustomBackend = {
     coin: string;
-    blockchainLink: $PropertyType<CoinInfo, 'blockchainLink'>;
+    blockchainLink?: $PropertyType<CoinInfo, 'blockchainLink'>;
 }
 
 export type BlockchainEvent =

diff --git a/src/ts/types/__tests__/blockchain.ts b/src/ts/types/__tests__/blockchain.ts
@@ -95,18 +95,30 @@ export const others = async () => {
         coin: 'btc',
     });
 
+    TrezorConnect.blockchainSubscribe({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainUnsubscribe({
         accounts,
         coin: 'btc',
     });
 
+    TrezorConnect.blockchainUnsubscribe({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainDisconnect({ coin: 'btc' });
 
     TrezorConnect.blockchainSetCustomBackend({
         coin: 'btc',
         blockchainLink: undefined,
     });
 
+    TrezorConnect.blockchainSetCustomBackend({
+        coin: 'btc',
+    });
+
     TrezorConnect.blockchainSetCustomBackend({
         coin: 'btc',
         blockchainLink: {

diff --git a/src/ts/types/backend/blockchain.d.ts b/src/ts/types/backend/blockchain.d.ts
@@ -43,7 +43,7 @@ export interface BlockchainSubscribeAccount {
 }
 
 export interface BlockchainSubscribe {
-    accounts: BlockchainSubscribeAccount[];
+    accounts?: BlockchainSubscribeAccount[];
     coin: string;
 }
 
@@ -148,7 +148,7 @@ export interface BlockchainAccountBalanceHistory {
 
 export interface BlockchainSetCustomBackend {
     coin: string;
-    blockchainLink: CoinInfo['blockchainLink'];
+    blockchainLink?: CoinInfo['blockchainLink'];
 }
 
 export type BlockchainEvent =