@xelis/sdk 0.2.0 → 0.3.1

package/daemon/rpc.d.ts

@@ -1,8 +1,9 @@
-import { Balance, Block, TopoHeightRangeParams, GetInfoResult, HeightRangeParams, GetLastBalanceResult, P2PStatusResult, RPCMethod, RPCResponse, Transaction, BalanceParams } from './types';
+import { Balance, Block, TopoHeightRangeParams, GetInfoResult, HeightRangeParams, GetLastBalanceResult, P2PStatusResult, RPCMethod, RPCResponse, Transaction, GetLastBalanceParams, GetBalanceAtTopoHeightParams, GetAccountsParams } from './types';
 declare class RPC {
     endpoint: string;
     constructor(endpoint: string);
     fetch<T>(method: RPCMethod, params?: any): Promise<RPCResponse<T>>;
+    getVersion(): Promise<RPCResponse<string>>;
     getInfo(): Promise<RPCResponse<GetInfoResult>>;
     getHeight(): Promise<RPCResponse<number>>;
     getTopoHeight(): Promise<RPCResponse<number>>;
@@ -13,18 +14,19 @@ declare class RPC {
     getBlockByHash(hash: string): Promise<RPCResponse<Block>>;
     getTopBlock(): Promise<RPCResponse<Block>>;
     getNonce(address: string): Promise<RPCResponse<number>>;
-    getLastBalance(params: BalanceParams): Promise<RPCResponse<GetLastBalanceResult>>;
-    getBalanceAtTopoHeight(params: BalanceParams): Promise<RPCResponse<Balance>>;
+    getLastBalance(params: GetLastBalanceParams): Promise<RPCResponse<GetLastBalanceResult>>;
+    getBalanceAtTopoHeight(params: GetBalanceAtTopoHeightParams): Promise<RPCResponse<Balance>>;
     getAssets(): Promise<RPCResponse<string[]>>;
     countTransactions(): Promise<RPCResponse<number>>;
+    countAssets(): Promise<RPCResponse<number>>;
     getTips(): Promise<RPCResponse<string[]>>;
     p2pStatus(): Promise<RPCResponse<P2PStatusResult>>;
     getDAGOrder(params: TopoHeightRangeParams): Promise<RPCResponse<string[]>>;
     getMemPool(): Promise<RPCResponse<Transaction[]>>;
     getTransaction(hash: string): Promise<RPCResponse<Transaction>>;
     getTransactions(txHashes: string[]): Promise<RPCResponse<Transaction[]>>;
-    getBlocks(params: TopoHeightRangeParams): Promise<RPCResponse<Block[]>>;
     getBlocksRangeByTopoheight(params: TopoHeightRangeParams): Promise<RPCResponse<Block[]>>;
     getBlocksRangeByHeight(params: HeightRangeParams): Promise<RPCResponse<Block[]>>;
+    getAccounts(params: GetAccountsParams): Promise<RPCResponse<string[]>>;
 }
 export default RPC;

package/daemon/rpc.js

@@ -9,6 +9,9 @@ class RPC {
             const res = await fetch(this.endpoint, { method: `POST`, body });
             if (res.ok) {
                 const data = await res.json();
+                if (data.error) {
+                    return Promise.reject(new Error(data.error.message));
+                }
                 return Promise.resolve(data);
             }
             else {
@@ -19,6 +22,9 @@ class RPC {
             return Promise.reject(err);
         }
     }
+    getVersion() {
+        return this.fetch(RPCMethod.GetVersion);
+    }
     getInfo() {
         return this.fetch(RPCMethod.GetInfo);
     }
@@ -61,6 +67,9 @@ class RPC {
     countTransactions() {
         return this.fetch(RPCMethod.CountTransactions);
     }
+    countAssets() {
+        return this.fetch(RPCMethod.CountAssets);
+    }
     getTips() {
         return this.fetch(RPCMethod.GetTips);
     }
@@ -79,14 +88,14 @@ class RPC {
     getTransactions(txHashes) {
         return this.fetch(RPCMethod.GetTransactions, { tx_hashes: txHashes });
     }
-    getBlocks(params) {
-        return this.fetch(RPCMethod.GetBlocks, params);
-    }
     getBlocksRangeByTopoheight(params) {
         return this.fetch(RPCMethod.GetBlocksRangeByTopoheight, params);
     }
     getBlocksRangeByHeight(params) {
         return this.fetch(RPCMethod.GetBlocksRangeByHeight, params);
     }
+    getAccounts(params) {
+        return this.fetch(RPCMethod.GetAccounts, params);
+    }
 }
 export default RPC;

package/daemon/types.d.ts

@@ -11,7 +11,7 @@ export interface RPCError {
 export interface RPCResponse<T> {
     id: number;
     result: T;
-    error: RPCError;
+    error?: RPCError;
 }
 export interface GetInfoResult {
     block_time_target: number;
@@ -47,10 +47,15 @@ export interface Block {
     total_size_in_bytes: number;
     txs_hashes: string[];
 }
-export interface BalanceParams {
+export interface GetLastBalanceParams {
     address: string;
     asset: string;
 }
+export interface GetBalanceAtTopoHeightParams {
+    address: string;
+    asset: string;
+    topoheight: number;
+}
 export interface Balance {
     balance: number;
     previous_topoheight: number;
@@ -60,12 +65,12 @@ export interface GetLastBalanceResult {
     balance: Balance;
 }
 export interface P2PStatusResult {
-    best_height: number;
-    max_peers: number;
-    our_height: number;
     peer_count: number;
-    peer_id: number;
     tag?: string;
+    peer_id: number;
+    our_topoheight: number;
+    best_topoheight: number;
+    max_peers: number;
 }
 export interface TopoHeightRangeParams {
     start_topoheight?: number;
@@ -99,7 +104,14 @@ export interface Transaction {
     owner: string;
     signature: string;
 }
+export interface GetAccountsParams {
+    skip?: number;
+    maximum?: number;
+    minimum_topoheight?: number;
+    maximum_topoheight?: number;
+}
 export declare enum RPCMethod {
+    GetVersion = "get_version",
     GetInfo = "get_info",
     GetHeight = "get_height",
     GetTopoHeight = "get_topoheight",
@@ -113,6 +125,7 @@ export declare enum RPCMethod {
     GetLastBalance = "get_last_balance",
     GetBalanceAtTopoHeight = "get_balance_at_topoheight",
     GetAssets = "get_assets",
+    CountAssets = "count_assets",
     CountTransactions = "count_transactions",
     GetTips = "get_tips",
     P2PStatus = "p2p_status",
@@ -120,9 +133,9 @@ export declare enum RPCMethod {
     GetMempool = "get_mempool",
     GetTransaction = "get_transaction",
     GetTransactions = "get_transactions",
-    GetBlocks = "get_blocks",
     GetBlocksRangeByTopoheight = "get_blocks_range_by_topoheight",
-    GetBlocksRangeByHeight = "get_blocks_range_by_height"
+    GetBlocksRangeByHeight = "get_blocks_range_by_height",
+    GetAccounts = "get_accounts"
 }
 export declare enum RPCEvent {
     NewBlock = "NewBlock",

package/daemon/types.js

@@ -1,5 +1,6 @@
 export var RPCMethod;
 (function (RPCMethod) {
+    RPCMethod["GetVersion"] = "get_version";
     RPCMethod["GetInfo"] = "get_info";
     RPCMethod["GetHeight"] = "get_height";
     RPCMethod["GetTopoHeight"] = "get_topoheight";
@@ -13,6 +14,7 @@ export var RPCMethod;
     RPCMethod["GetLastBalance"] = "get_last_balance";
     RPCMethod["GetBalanceAtTopoHeight"] = "get_balance_at_topoheight";
     RPCMethod["GetAssets"] = "get_assets";
+    RPCMethod["CountAssets"] = "count_assets";
     RPCMethod["CountTransactions"] = "count_transactions";
     RPCMethod["GetTips"] = "get_tips";
     RPCMethod["P2PStatus"] = "p2p_status";
@@ -20,9 +22,9 @@ export var RPCMethod;
     RPCMethod["GetMempool"] = "get_mempool";
     RPCMethod["GetTransaction"] = "get_transaction";
     RPCMethod["GetTransactions"] = "get_transactions";
-    RPCMethod["GetBlocks"] = "get_blocks";
     RPCMethod["GetBlocksRangeByTopoheight"] = "get_blocks_range_by_topoheight";
     RPCMethod["GetBlocksRangeByHeight"] = "get_blocks_range_by_height";
+    RPCMethod["GetAccounts"] = "get_accounts";
 })(RPCMethod || (RPCMethod = {}));
 export var RPCEvent;
 (function (RPCEvent) {

package/daemon/websocket.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { MessageEvent } from 'ws';
 import WebSocket from 'isomorphic-ws';
-import { Block, RPCResponse, GetInfoResult, RPCEvent, RPCEventResult, Transaction, TopoHeightRangeParams, P2PStatusResult, Balance, BalanceParams, GetLastBalanceResult, HeightRangeParams, BlockOrdered } from './types';
+import { Block, RPCResponse, GetInfoResult, RPCEvent, RPCEventResult, Transaction, TopoHeightRangeParams, P2PStatusResult, Balance, GetBalanceAtTopoHeightParams, GetLastBalanceResult, HeightRangeParams, BlockOrdered, GetLastBalanceParams, GetAccountsParams } from './types';
 declare class WS {
     endpoint: string;
     socket?: WebSocket;
@@ -32,8 +32,8 @@ declare class WS {
     getBlockByHash(hash: string): Promise<Block>;
     getTopBlock(): Promise<Block>;
     getNonce(address: string): Promise<number>;
-    getLastBalance(params: BalanceParams): Promise<GetLastBalanceResult>;
-    getBalanceAtTopoHeight(params: BalanceParams): Promise<Balance>;
+    getLastBalance(params: GetLastBalanceParams): Promise<GetLastBalanceResult>;
+    getBalanceAtTopoHeight(params: GetBalanceAtTopoHeightParams): Promise<Balance>;
     getAssets(): Promise<string[]>;
     countTransactions(): Promise<number>;
     getTips(): Promise<string[]>;
@@ -42,8 +42,8 @@ declare class WS {
     getMemPool(): Promise<Transaction[]>;
     getTransaction(hash: string): Promise<Transaction>;
     getTransactions(txHashes: string[]): Promise<Transaction[]>;
-    getBlocks(params: TopoHeightRangeParams): Promise<Block[]>;
     getBlocksRangeByTopoheight(params: TopoHeightRangeParams): Promise<Block[]>;
     getBlocksRangeByHeight(params: HeightRangeParams): Promise<Block[]>;
+    getAccounts(params: GetAccountsParams): Promise<string[]>;
 }
 export default WS;

package/daemon/websocket.js

@@ -224,14 +224,14 @@ class WS {
     getTransactions(txHashes) {
         return this.dataCall(RPCMethod.GetTransactions, { tx_hashes: txHashes });
     }
-    getBlocks(params) {
-        return this.dataCall(RPCMethod.GetBlocks, params);
-    }
     getBlocksRangeByTopoheight(params) {
         return this.dataCall(RPCMethod.GetBlocksRangeByTopoheight, params);
     }
     getBlocksRangeByHeight(params) {
         return this.dataCall(RPCMethod.GetBlocksRangeByHeight, params);
     }
+    getAccounts(params) {
+        return this.dataCall(RPCMethod.GetAccounts, params);
+    }
 }
 export default WS;

package/dist

@@ -0,0 +1,44 @@
+# XELIS-JS-SDK
+
+Xelis software development kit for JS.
+
+## Install
+
+Install library with NPM.
+
+`npm i @xelis/sdk`
+
+## Usage
+
+Import library and start working :).
+
+Use http/rpc connection.
+
+```js
+import { DEV_NODE_RPC } from '@xelis/sdk/config/nodes'
+import DaemonRPC from '@xelis/sdk/daemon/rpc'
+
+const main = async () => {
+  const daemonRPC = new DaemonRPC(DEV_NODE_RPC)
+  const info = await daemonRPC.getInfo()
+  console.log(info)
+}
+
+main()
+```
+
+Use websocket connection.
+
+```js
+import { DEV_NODE_RPC } from '@xelis/sdk/config/nodes'
+import DaemonWS from '@xelis/sdk/daemon/websocket'
+
+const main = async () => {
+  const daemonWS = new DaemonWS()
+  await daemonWS.connect(DEV_NODE_RPC)
+  const info = await daemonWS.getInfo()
+  console.log(info)
+}
+
+main()
+```

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.0",
+  "version": "0.3.1",
   "name": "@xelis/sdk",
   "description": "Xelis software development kit for JS",
   "repository": {
@@ -10,7 +10,7 @@
   "scripts": {
     "test": "jest",
     "build": "npx tsc --declaration && cp package.json ./dist && cp README.md ./dist",
-    "prepublish": "npm run build",
+    "prepublishOnly": "npm run build",
     "publish": "cd ./dist && npm publish"
   },
   "devDependencies": {