@xelis/sdk 0.8.4 → 0.9.1

package/dist/types/wallet/types.d.ts

@@ -1,4 +1,4 @@
-import { TransactionData, Transaction } from '../daemon/types.js';
+import { Transaction } from '../daemon/types';
 export interface GetAddressParams {
     integrated_data?: string;
 }
@@ -9,14 +9,21 @@ export interface SplitAddressResult {
     address: string;
     integrated_data: string;
 }
+export interface FeeBuilder {
+    multiplier?: number;
+    value?: number;
+}
 export interface BuildTransactionParams {
-    tx_type: TransactionData;
+    transfers: TransferOut[];
+    burn?: TxBurn;
     broadcast: boolean;
-    fee?: number;
+    fee?: FeeBuilder;
+    tx_as_hex: boolean;
 }
 export interface BuildTransactionResult {
     hash: string;
     data: Transaction;
+    txt_as_hex?: string;
 }
 export interface ListTransactionParams {
     min_topoheight?: number;
@@ -38,12 +45,23 @@ export interface TxBurn {
     asset: string;
     amount: number;
 }
+export interface TransferIn {
+    asset: string;
+    amount: number;
+    extra_data?: any;
+}
 export interface TxIncoming {
     from: string;
-    transfers: any;
+    transfers: TransferIn[];
+}
+export interface TransferOut {
+    destination: string;
+    asset: string;
+    amount: number;
+    extra_data?: any;
 }
 export interface TxOutgoing {
-    transfers: any;
+    transfers: TransferOut;
     fees: number;
     nonce: number;
 }
@@ -52,6 +70,28 @@ export interface TransactionEntry {
     topoheight: number;
     entry: TxCoinbase | TxBurn | TxIncoming | TxOutgoing;
 }
+export interface RescanParams {
+    until_topoheight?: number;
+    auto_reconnect: boolean;
+}
+export interface SetOnlineModeParams {
+    daemon_address: string;
+    auto_reconnect: boolean;
+}
+export interface EstimateFeesParams {
+    transfers: TransferOut[];
+    burn?: TxBurn;
+}
+export interface BalanceChangedResult {
+    asset: string;
+    balance: number;
+}
+export interface NewTopoheightResult {
+    topoheight: number;
+}
+export interface RescanResult {
+    start_topoheight: number;
+}
 export declare enum RPCMethod {
     GetVersion = "get_version",
     GetNetwork = "get_network",
@@ -68,9 +108,20 @@ export declare enum RPCMethod {
     BuildTransaction = "build_transaction",
     ListTransactions = "list_transactions",
     IsOnline = "is_online",
+    SetOnlineMode = "set_online_mode",
+    SetOfflineMode = "set_offline_mode",
     SignData = "sign_data",
     EstimateFees = "estimate_fees"
 }
+export declare enum RPCEvent {
+    NewTopoheight = "new_topoheight",
+    NewAsset = "new_asset",
+    NewTransaction = "",
+    BalanceChanged = "balance_changed",
+    Rescan = "rescan",
+    Online = "online",
+    Offline = "offline"
+}
 export declare enum Permission {
     Ask = 0,
     AcceptAlways = 1,

package/dist/types/wallet/websocket.d.ts

@@ -1,18 +1,26 @@
-import { WS as BaseWS } from '../lib/websocket.js';
-import { GetAssetParams, TransactionData } from '../daemon/types.js';
-import { BuildTransactionParams, BuildTransactionResult, GetAddressParams, ListTransactionParams, SplitAddressParams, SplitAddressResult, Signature, TransactionEntry } from './types.js';
+import { WS as BaseWS } from '../lib/websocket';
+import { MessageEvent } from 'ws';
+import { AssetWithData, GetAssetParams, RPCEventResult } from '../daemon/types';
+import { BuildTransactionParams, BuildTransactionResult, GetAddressParams, ListTransactionParams, SplitAddressParams, SplitAddressResult, Signature, RescanParams, SetOnlineModeParams, EstimateFeesParams, TransactionEntry, BalanceChangedResult, NewTopoheightResult, RescanResult } from './types';
 export declare class WalletMethods {
     ws: BaseWS;
     prefix: string;
     constructor(ws: BaseWS, prefix?: string);
     dataCall<T>(method: string, params?: any): Promise<T>;
+    onNewTopoheight(onData: (msgEvent: MessageEvent, data?: NewTopoheightResult & RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onNewAsset(onData: (msgEvent: MessageEvent, data?: AssetWithData & RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onNewTransaction(onData: (msgEvent: MessageEvent, data?: TransactionEntry & RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onBalanceChanged(onData: (msgEvent: MessageEvent, data?: BalanceChangedResult & RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onRescan(onData: (msgEvent: MessageEvent, data?: RescanResult & RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onOnline(onData: (msgEvent: MessageEvent, data?: RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
+    onOffline(onData: (msgEvent: MessageEvent, data?: RPCEventResult, err?: Error) => void): Promise<() => Promise<void>>;
     getVersion(): Promise<string>;
     getNetwork(): Promise<string>;
     getNonce(): Promise<number>;
     getTopoheight(): Promise<number>;
     getAddress(params?: GetAddressParams): Promise<string>;
     splitAddress(params: SplitAddressParams): Promise<SplitAddressResult>;
-    rescan(): Promise<void>;
+    rescan(params: RescanParams): Promise<boolean>;
     getBalance(asset?: string): Promise<number>;
     getTrackedAssets(): Promise<string[]>;
     getAssetPrecision(params: GetAssetParams): Promise<number>;
@@ -21,7 +29,9 @@ export declare class WalletMethods {
     listTransactions(params?: ListTransactionParams): Promise<TransactionEntry[]>;
     isOnline(): Promise<boolean>;
     signData(data: any): Promise<Signature>;
-    estimateFees(txData: TransactionData): Promise<number>;
+    estimateFees(params: EstimateFeesParams): Promise<number>;
+    setOnlineMode(params: SetOnlineModeParams): Promise<boolean>;
+    setOfflineMode(): Promise<boolean>;
 }
 export declare class WS extends BaseWS {
     methods: WalletMethods;

package/dist/types/xswd/websocket.d.ts

@@ -1,11 +1,11 @@
-import { WS as BaseWS } from '../lib/websocket.js';
-import { ApplicationData } from '../wallet/types.js';
-import { DaemonMethods } from '../daemon/websocket.js';
-import { WalletMethods } from '../wallet/websocket.js';
+import { WS as BaseWS } from '../lib/websocket';
+import { ApplicationData } from '../wallet/types';
+import { DaemonMethods } from '../daemon/websocket';
+import { WalletMethods } from '../wallet/websocket';
 export declare class WS extends BaseWS {
     daemon: DaemonMethods;
     wallet: WalletMethods;
     constructor();
-    authorize(app: ApplicationData): Promise<import("../lib/types.js").RPCResponse<unknown>>;
+    authorize(app: ApplicationData): Promise<import("../lib/types").RPCResponse<unknown>>;
 }
 export default WS;

package/package.json

@@ -1,39 +1,42 @@
-{
-  "version": "0.8.4",
-  "name": "@xelis/sdk",
-  "description": "Xelis software development kit for JS",
-  "exports": {
-    "./*": {
-      "types": "./dist/types/*.d.ts",
-      "require": "./dist/cjs/*.js",
-      "import": "./dist/esm/*.js",
-      "default": "./dist/esm/*.js"
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/xelis-project/xelis-js-sdk"
-  },
-  "homepage": "https://github.com/xelis-project/xelis-js-sdk#readme",
-  "scripts": {
-    "test": "jest",
-    "compile": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",
-    "clean": "rm -rf ./dist",
-    "build": "npm run clean && npm run compile && node create_esm_pkg.js",
-    "prepublishOnly": "npm run build"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.4.0",
-    "@types/react": "^18.2.23",
-    "@types/ws": "^8.5.4",
-    "ts-jest": "^29.0.5",
-    "typescript": "^4.9.5"
-  },
-  "dependencies": {
-    "await-to-js": "^3.0.0",
-    "isomorphic-ws": "^5.0.0",
-    "js-base64": "^3.7.6",
-    "react": "^18.2.0",
-    "ws": "^8.12.1"
-  }
-}
+{
+  "version": "0.9.1",
+  "name": "@xelis/sdk",
+  "description": "Xelis software development kit for JS",
+  "exports": {
+    "./*": {
+      "types": "./dist/types/*.d.ts",
+      "require": "./dist/cjs/*.js",
+      "import": "./dist/esm/*.js",
+      "default": "./dist/esm/*.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xelis-project/xelis-js-sdk"
+  },
+  "homepage": "https://github.com/xelis-project/xelis-js-sdk#readme",
+  "scripts": {
+    "test-func": "jest -t",
+    "test": "jest",
+    "compile": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",
+    "fix-esm": "fix-esm-import-path ./dist/esm",
+    "clean": "rm -rf ./dist",
+    "build": "npm run clean && npm run compile && node create_esm_pkg.js && npm run fix-esm",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.4.0",
+    "@types/react": "^18.2.23",
+    "@types/ws": "^8.5.4",
+    "fix-esm-import-path": "^1.5.0",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "await-to-js": "^3.0.0",
+    "isomorphic-ws": "^5.0.0",
+    "js-base64": "^3.7.6",
+    "react": "^18.2.0",
+    "ws": "^8.12.1"
+  }
+}

package/test_dist/index_cjs.js

@@ -0,0 +1,22 @@
+const { RPC: DaemonRPC } = require('../dist/cjs/daemon/rpc')
+const { WS: DaemonWS } = require('../dist/cjs/daemon/websocket')
+const { WS: WalletWS } = require('../dist/cjs/wallet/websocket')
+const { TESTNET_NODE_RPC, TESTNET_NODE_WS, LOCAL_NODE_WS } = require('../dist/cjs/config')
+
+const main = async () => {
+  const daemonRPC = new DaemonRPC(TESTNET_NODE_RPC)
+  const res1 = await daemonRPC.getInfo()
+  console.log(res1)
+
+  const daemonWS = new DaemonWS()
+  await daemonWS.connect(TESTNET_NODE_WS)
+  const res2 = await daemonWS.methods.getInfo()
+  console.log(res2)
+
+  const walletWS = new WalletWS(`test`, `test`)
+  await walletWS.connect(LOCAL_NODE_WS)
+  const res3 = await walletWS.methods.getVersion()
+  console.log(res3)
+}
+
+main()

package/test_dist/index_esm.js

@@ -0,0 +1,12 @@
+import { RPC as DaemonRPC } from '../dist/esm/daemon/rpc.js'
+import { TESTNET_NODE_RPC } from '../dist/esm/config.js'
+
+// need to add "type": "module" in package.json to test
+
+const main = async () => {
+  const daemon = new DaemonRPC(TESTNET_NODE_RPC)
+  const res = await daemon.getInfo()
+  console.log(res)
+}
+
+main()