@xelis/sdk 0.3.1 → 0.3.3

package/daemon/rpc.d.ts

@@ -1,4 +1,4 @@
-import { Balance, Block, TopoHeightRangeParams, GetInfoResult, HeightRangeParams, GetLastBalanceResult, P2PStatusResult, RPCMethod, RPCResponse, Transaction, GetLastBalanceParams, GetBalanceAtTopoHeightParams, GetAccountsParams } from './types';
+import { Balance, Block, TopoHeightRangeParams, GetInfoResult, HeightRangeParams, GetLastBalanceResult, P2PStatusResult, RPCMethod, RPCResponse, Transaction, GetLastBalanceParams, GetBalanceAtTopoHeightParams, GetAccountsParams, GetBlockAtTopoHeightParams, GetBlockByHashParams, GetBlocksAtHeightParams, GetTopBlockParams } from './types';
 declare class RPC {
     endpoint: string;
     constructor(endpoint: string);
@@ -9,10 +9,10 @@ declare class RPC {
     getTopoHeight(): Promise<RPCResponse<number>>;
     getStableHeight(): Promise<RPCResponse<number>>;
     getBlockTemplate(address: string): Promise<RPCResponse<string>>;
-    getBlockAtTopoHeight(topoHeight: number): Promise<RPCResponse<Block>>;
-    getBlocksAtHeight(height: number): Promise<RPCResponse<Block[]>>;
-    getBlockByHash(hash: string): Promise<RPCResponse<Block>>;
-    getTopBlock(): Promise<RPCResponse<Block>>;
+    getBlockAtTopoHeight(params: GetBlockAtTopoHeightParams): Promise<RPCResponse<Block>>;
+    getBlocksAtHeight(params: GetBlocksAtHeightParams): Promise<RPCResponse<Block[]>>;
+    getBlockByHash(params: GetBlockByHashParams): Promise<RPCResponse<Block>>;
+    getTopBlock(params: GetTopBlockParams): Promise<RPCResponse<Block>>;
     getNonce(address: string): Promise<RPCResponse<number>>;
     getLastBalance(params: GetLastBalanceParams): Promise<RPCResponse<GetLastBalanceResult>>;
     getBalanceAtTopoHeight(params: GetBalanceAtTopoHeightParams): Promise<RPCResponse<Balance>>;

package/daemon/rpc.js

@@ -40,17 +40,17 @@ class RPC {
     getBlockTemplate(address) {
         return this.fetch(RPCMethod.GetBlockTemplate, { address });
     }
-    getBlockAtTopoHeight(topoHeight) {
-        return this.fetch(RPCMethod.GetBlockAtTopoHeight, { topoheight: topoHeight });
+    getBlockAtTopoHeight(params) {
+        return this.fetch(RPCMethod.GetBlockAtTopoHeight, params);
     }
-    getBlocksAtHeight(height) {
-        return this.fetch(RPCMethod.GetBlocksAtHeight, { height });
+    getBlocksAtHeight(params) {
+        return this.fetch(RPCMethod.GetBlocksAtHeight, params);
     }
-    getBlockByHash(hash) {
-        return this.fetch(RPCMethod.GetBlockByHash, { hash });
+    getBlockByHash(params) {
+        return this.fetch(RPCMethod.GetBlockByHash, params);
     }
-    getTopBlock() {
-        return this.fetch(RPCMethod.GetTopBlock);
+    getTopBlock(params) {
+        return this.fetch(RPCMethod.GetTopBlock, params);
     }
     getNonce(address) {
         return this.fetch(RPCMethod.GetNonce, { address });

package/daemon/types.d.ts

@@ -110,6 +110,21 @@ export interface GetAccountsParams {
     minimum_topoheight?: number;
     maximum_topoheight?: number;
 }
+export interface GetBlockAtTopoHeightParams {
+    topoheight: number;
+    include_txs?: boolean;
+}
+export interface GetBlocksAtHeightParams {
+    height: number;
+    include_txs?: boolean;
+}
+export interface GetBlockByHashParams {
+    hash: string;
+    include_txs?: boolean;
+}
+export interface GetTopBlockParams {
+    include_txs?: boolean;
+}
 export declare enum RPCMethod {
     GetVersion = "get_version",
     GetInfo = "get_info",

package/daemon/websocket.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="node" />
 import { MessageEvent } from 'ws';
 import WebSocket from 'isomorphic-ws';
-import { Block, RPCResponse, GetInfoResult, RPCEvent, RPCEventResult, Transaction, TopoHeightRangeParams, P2PStatusResult, Balance, GetBalanceAtTopoHeightParams, GetLastBalanceResult, HeightRangeParams, BlockOrdered, GetLastBalanceParams, GetAccountsParams } from './types';
+import { Block, RPCResponse, GetInfoResult, RPCEvent, RPCEventResult, Transaction, TopoHeightRangeParams, P2PStatusResult, Balance, GetBalanceAtTopoHeightParams, GetLastBalanceResult, HeightRangeParams, BlockOrdered, GetLastBalanceParams, GetAccountsParams, GetBlockAtTopoHeightParams, GetBlockByHashParams, GetBlocksAtHeightParams, GetTopBlockParams } from './types';
 declare class WS {
     endpoint: string;
     socket?: WebSocket;
     timeout: number;
     connected: boolean;
+    unsubscribeSuspense: number;
     private events;
     constructor();
     connect(endpoint: string): Promise<unknown>;
@@ -27,10 +28,10 @@ declare class WS {
     getTopoHeight(): Promise<number>;
     getStableHeight(): Promise<number>;
     getBlockTemplate(address: string): Promise<string>;
-    getBlockAtTopoHeight(topoHeight: number): Promise<Block>;
-    getBlocksAtHeight(height: number): Promise<Block[]>;
-    getBlockByHash(hash: string): Promise<Block>;
-    getTopBlock(): Promise<Block>;
+    getBlockAtTopoHeight(params: GetBlockAtTopoHeightParams): Promise<Block>;
+    getBlocksAtHeight(params: GetBlocksAtHeightParams): Promise<Block[]>;
+    getBlockByHash(params: GetBlockByHashParams): Promise<Block>;
+    getTopBlock(params: GetTopBlockParams): Promise<Block>;
     getNonce(address: string): Promise<number>;
     getLastBalance(params: GetLastBalanceParams): Promise<GetLastBalanceResult>;
     getBalanceAtTopoHeight(params: GetBalanceAtTopoHeightParams): Promise<Balance>;

package/daemon/websocket.js

@@ -15,6 +15,7 @@ class WS {
         this.timeout = 3000;
         this.connected = false;
         this.events = {};
+        this.unsubscribeSuspense = 1000;
     }
     connect(endpoint) {
         if (this.socket && this.socket.readyState !== WebSocket.CLOSED) {
@@ -92,6 +93,12 @@ class WS {
             }
         };
         if (this.events[event]) {
+            const { unsubscribeTimeoutId } = this.events[event];
+            if (unsubscribeTimeoutId) {
+                // clear timeout to unsubscribe 
+                // because we got a new registered event and want to cancel the pending unsubscribe grace period
+                clearTimeout(unsubscribeTimeoutId);
+            }
             this.events[event].listeners.push(onMessage);
         }
         else {
@@ -105,13 +112,23 @@ class WS {
             this.events[event].id = res.id;
         }
         this.socket && this.socket.addEventListener(`message`, onMessage);
-        const closeListen = async () => {
-            if (this.events[event] && this.events[event].listeners.length === 1) {
-                // this is the last listen callback so we unsubscribe from daemon ws
-                const [err, _] = await to(this.call(`unsubscribe`, { notify: event }));
-                if (err)
-                    return Promise.reject(err);
-                Reflect.deleteProperty(this.events, event);
+        const closeListen = () => {
+            const eventData = this.events[event];
+            if (eventData) {
+                const listeners = eventData.listeners;
+                for (let i = 0; i < listeners.length; i++) {
+                    if (listeners[i] === onMessage) {
+                        listeners.splice(i, 1);
+                        break;
+                    }
+                }
+                if (listeners.length === 0) {
+                    this.events[event].unsubscribeTimeoutId = setTimeout(async () => {
+                        // no more listener so we unsubscribe from daemon websocket
+                        this.call(`unsubscribe`, { notify: event });
+                        Reflect.deleteProperty(this.events, event);
+                    }, this.unsubscribeSuspense);
+                }
             }
             this.socket && this.socket.removeEventListener(`message`, onMessage);
             return Promise.resolve();
@@ -179,17 +196,17 @@ class WS {
     getBlockTemplate(address) {
         return this.dataCall(RPCMethod.GetBlockTemplate, { address });
     }
-    getBlockAtTopoHeight(topoHeight) {
-        return this.dataCall(RPCMethod.GetBlockAtTopoHeight, { topoheight: topoHeight });
+    getBlockAtTopoHeight(params) {
+        return this.dataCall(RPCMethod.GetBlockAtTopoHeight, params);
     }
-    getBlocksAtHeight(height) {
-        return this.dataCall(RPCMethod.GetBlocksAtHeight, { height });
+    getBlocksAtHeight(params) {
+        return this.dataCall(RPCMethod.GetBlocksAtHeight, params);
     }
-    getBlockByHash(hash) {
-        return this.dataCall(RPCMethod.GetBlockByHash, { hash });
+    getBlockByHash(params) {
+        return this.dataCall(RPCMethod.GetBlockByHash, params);
     }
-    getTopBlock() {
-        return this.dataCall(RPCMethod.GetTopBlock);
+    getTopBlock(params) {
+        return this.dataCall(RPCMethod.GetTopBlock, params);
     }
     getNonce(address) {
         return this.dataCall(RPCMethod.GetNonce, { address });

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.1",
+  "version": "0.3.3",
   "name": "@xelis/sdk",
   "description": "Xelis software development kit for JS",
   "repository": {