@xelis/sdk 0.3.2 → 0.3.4

package/daemon/rpc.d.ts

@@ -1,18 +1,18 @@
-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);
-    fetch<T>(method: RPCMethod, params?: any): Promise<RPCResponse<T>>;
+    post<T>(method: RPCMethod, params?: any): Promise<RPCResponse<T>>;
     getVersion(): Promise<RPCResponse<string>>;
     getInfo(): Promise<RPCResponse<GetInfoResult>>;
     getHeight(): Promise<RPCResponse<number>>;
     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>>;
@@ -28,5 +28,7 @@ declare class RPC {
     getBlocksRangeByTopoheight(params: TopoHeightRangeParams): Promise<RPCResponse<Block[]>>;
     getBlocksRangeByHeight(params: HeightRangeParams): Promise<RPCResponse<Block[]>>;
     getAccounts(params: GetAccountsParams): Promise<RPCResponse<string[]>>;
+    submitBlock(blockTemplate: string): Promise<RPCResponse<boolean>>;
+    submitTransaction(hexData: string): Promise<RPCResponse<boolean>>;
 }
 export default RPC;

package/daemon/rpc.js

@@ -3,7 +3,7 @@ class RPC {
     constructor(endpoint) {
         this.endpoint = endpoint;
     }
-    async fetch(method, params) {
+    async post(method, params) {
         try {
             const body = JSON.stringify({ id: 1, jsonrpc: '2.0', method: method, params });
             const res = await fetch(this.endpoint, { method: `POST`, body });
@@ -23,79 +23,85 @@ class RPC {
         }
     }
     getVersion() {
-        return this.fetch(RPCMethod.GetVersion);
+        return this.post(RPCMethod.GetVersion);
     }
     getInfo() {
-        return this.fetch(RPCMethod.GetInfo);
+        return this.post(RPCMethod.GetInfo);
     }
     getHeight() {
-        return this.fetch(RPCMethod.GetHeight);
+        return this.post(RPCMethod.GetHeight);
     }
     getTopoHeight() {
-        return this.fetch(RPCMethod.GetTopoHeight);
+        return this.post(RPCMethod.GetTopoHeight);
     }
     getStableHeight() {
-        return this.fetch(RPCMethod.GetStableHeight);
+        return this.post(RPCMethod.GetStableHeight);
     }
     getBlockTemplate(address) {
-        return this.fetch(RPCMethod.GetBlockTemplate, { address });
+        return this.post(RPCMethod.GetBlockTemplate, { address });
     }
-    getBlockAtTopoHeight(topoHeight) {
-        return this.fetch(RPCMethod.GetBlockAtTopoHeight, { topoheight: topoHeight });
+    getBlockAtTopoHeight(params) {
+        return this.post(RPCMethod.GetBlockAtTopoHeight, params);
     }
-    getBlocksAtHeight(height) {
-        return this.fetch(RPCMethod.GetBlocksAtHeight, { height });
+    getBlocksAtHeight(params) {
+        return this.post(RPCMethod.GetBlocksAtHeight, params);
     }
-    getBlockByHash(hash) {
-        return this.fetch(RPCMethod.GetBlockByHash, { hash });
+    getBlockByHash(params) {
+        return this.post(RPCMethod.GetBlockByHash, params);
     }
-    getTopBlock() {
-        return this.fetch(RPCMethod.GetTopBlock);
+    getTopBlock(params) {
+        return this.post(RPCMethod.GetTopBlock, params);
     }
     getNonce(address) {
-        return this.fetch(RPCMethod.GetNonce, { address });
+        return this.post(RPCMethod.GetNonce, { address });
     }
     getLastBalance(params) {
-        return this.fetch(RPCMethod.GetLastBalance, params);
+        return this.post(RPCMethod.GetLastBalance, params);
     }
     getBalanceAtTopoHeight(params) {
-        return this.fetch(RPCMethod.GetBalanceAtTopoHeight, params);
+        return this.post(RPCMethod.GetBalanceAtTopoHeight, params);
     }
     getAssets() {
-        return this.fetch(RPCMethod.GetAssets);
+        return this.post(RPCMethod.GetAssets);
     }
     countTransactions() {
-        return this.fetch(RPCMethod.CountTransactions);
+        return this.post(RPCMethod.CountTransactions);
     }
     countAssets() {
-        return this.fetch(RPCMethod.CountAssets);
+        return this.post(RPCMethod.CountAssets);
     }
     getTips() {
-        return this.fetch(RPCMethod.GetTips);
+        return this.post(RPCMethod.GetTips);
     }
     p2pStatus() {
-        return this.fetch(RPCMethod.P2PStatus);
+        return this.post(RPCMethod.P2PStatus);
     }
     getDAGOrder(params) {
-        return this.fetch(RPCMethod.GetDAGOrder, params);
+        return this.post(RPCMethod.GetDAGOrder, params);
     }
     getMemPool() {
-        return this.fetch(RPCMethod.GetMempool);
+        return this.post(RPCMethod.GetMempool);
     }
     getTransaction(hash) {
-        return this.fetch(RPCMethod.GetTransaction, { hash });
+        return this.post(RPCMethod.GetTransaction, { hash });
     }
     getTransactions(txHashes) {
-        return this.fetch(RPCMethod.GetTransactions, { tx_hashes: txHashes });
+        return this.post(RPCMethod.GetTransactions, { tx_hashes: txHashes });
     }
     getBlocksRangeByTopoheight(params) {
-        return this.fetch(RPCMethod.GetBlocksRangeByTopoheight, params);
+        return this.post(RPCMethod.GetBlocksRangeByTopoheight, params);
     }
     getBlocksRangeByHeight(params) {
-        return this.fetch(RPCMethod.GetBlocksRangeByHeight, params);
+        return this.post(RPCMethod.GetBlocksRangeByHeight, params);
     }
     getAccounts(params) {
-        return this.fetch(RPCMethod.GetAccounts, params);
+        return this.post(RPCMethod.GetAccounts, params);
+    }
+    submitBlock(blockTemplate) {
+        return this.post(RPCMethod.SubmitBlock, { block_template: blockTemplate });
+    }
+    submitTransaction(hexData) {
+        return this.post(RPCMethod.SubmitTransaction, { data: hexData });
     }
 }
 export default RPC;

package/daemon/types.d.ts

@@ -88,17 +88,27 @@ export interface BlockOrdered {
     block_hash: string;
     block_type: string;
 }
+export interface Transfer {
+    amount: number;
+    asset: string;
+    extra_data?: any;
+    to: string;
+}
+export interface TransactionData {
+    transfers: Transfer[];
+    burn: {
+        asset: string;
+        amount: number;
+    };
+    call_contract: {
+        contract: string;
+    };
+    deploy_contract: string;
+}
 export interface Transaction {
     hash: string;
     blocks: string[];
-    data: {
-        Transfer: {
-            amount: number;
-            asset: string;
-            extra_data: any;
-            to: string;
-        }[];
-    };
+    data: TransactionData;
     fee: number;
     nonce: number;
     owner: string;
@@ -110,6 +120,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",
@@ -135,7 +160,9 @@ export declare enum RPCMethod {
     GetTransactions = "get_transactions",
     GetBlocksRangeByTopoheight = "get_blocks_range_by_topoheight",
     GetBlocksRangeByHeight = "get_blocks_range_by_height",
-    GetAccounts = "get_accounts"
+    GetAccounts = "get_accounts",
+    SubmitBlock = "submit_block",
+    SubmitTransaction = "submit_transaction"
 }
 export declare enum RPCEvent {
     NewBlock = "NewBlock",

package/daemon/types.js

@@ -25,6 +25,8 @@ export var RPCMethod;
     RPCMethod["GetBlocksRangeByTopoheight"] = "get_blocks_range_by_topoheight";
     RPCMethod["GetBlocksRangeByHeight"] = "get_blocks_range_by_height";
     RPCMethod["GetAccounts"] = "get_accounts";
+    RPCMethod["SubmitBlock"] = "submit_block";
+    RPCMethod["SubmitTransaction"] = "submit_transaction";
 })(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, 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;
@@ -28,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>;
@@ -46,5 +46,7 @@ declare class WS {
     getBlocksRangeByTopoheight(params: TopoHeightRangeParams): Promise<Block[]>;
     getBlocksRangeByHeight(params: HeightRangeParams): Promise<Block[]>;
     getAccounts(params: GetAccountsParams): Promise<string[]>;
+    submitBlock(blockTemplate: string): Promise<boolean>;
+    submitTransaction(hexData: string): Promise<boolean>;
 }
 export default WS;

package/daemon/websocket.js

@@ -196,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 });
@@ -250,5 +250,11 @@ class WS {
     getAccounts(params) {
         return this.dataCall(RPCMethod.GetAccounts, params);
     }
+    submitBlock(blockTemplate) {
+        return this.dataCall(RPCMethod.SubmitBlock, { block_template: blockTemplate });
+    }
+    submitTransaction(hexData) {
+        return this.dataCall(RPCMethod.SubmitTransaction, { data: hexData });
+    }
 }
 export default WS;

package/package.json

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

package/dist

@@ -1,44 +0,0 @@
-# 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()
-```