nexa-wallet-sdk 0.1.2 → 0.1.4

package/README.md

@@ -15,7 +15,7 @@ A comprehensive TypeScript SDK for building applications on the Nexa blockchain.
 ## Installation
 
 ```bash
-npm install @dolaned/wallet-sdk-ts
+npm install nexa-wallet-sdk
 ```
 
 ## Quick Start
@@ -23,11 +23,22 @@ npm install @dolaned/wallet-sdk-ts
 ### Basic Wallet Setup
 
 ```typescript
-import { Wallet, rostrumProvider } from '@dolaned/wallet-sdk-ts'
+import { Wallet, rostrumProvider } from 'nexa-wallet-sdk'
 
-// Connect to the network
+// Connect to the default mainnet node
 await rostrumProvider.connect()
 
+// Connect to a specific network (mainnet or testnet)
+await rostrumProvider.connect('testnet')  // Uses predefined testnet node
+await rostrumProvider.connect('mainnet')  // Uses predefined mainnet node
+
+// Connect to a custom node (ignores network parameter)
+await rostrumProvider.connect({
+    host: 'your-custom-node.example.com',
+    port: 30004,
+    scheme: 'wss' // or 'ws' for unencrypted connection
+})
+
 // Create wallet from seed phrase
 const wallet = new Wallet(
     'your twelve word seed phrase goes here for wallet creation',
@@ -266,11 +277,10 @@ Watch-only wallets allow you to monitor addresses and create unsigned transactio
 ### Create Watch-Only Wallet
 
 ```typescript
-import { WatchOnlyWallet } from '@dolaned/wallet-sdk-ts'
+import { WatchOnlyWallet } from 'nexa-wallet-sdk'
 
 const watchOnlyWallet = new WatchOnlyWallet([
-    { address: 'nexatest:nqtsq5g5dsgh6mwjchqypn8hvdrjue0xpmz293fl7rm926xv' },
-    { address: 'nexatest:nqtsq5g5jsdmqqywaqd82lhnnk3a8wqunjz6gtxdtavnnekc' }
+    { address: 'nexatest:nqtsq5g5dsgh6mwjchqypn8hvdrjue0xpmz293fl7rm926xv' }
 ], 'testnet')
 ```
 
@@ -375,7 +385,7 @@ import {
     Balance,
     TransactionEntity,
     TokenAction
-} from '@dolaned/wallet-sdk-ts'
+} from 'nexa-wallet-sdk'
 ```
 
 ## Error Handling

package/dist/{index.js → index.cjs}

@@ -21,7 +21,7 @@ function $parcel$interopDefault(a) {
 var $parcel$modules = {};
 var $parcel$inits = {};
 
-var parcelRequire = $parcel$global["parcelRequire77ae"];
+var parcelRequire = $parcel$global["parcelRequire3d58"];
 
 if (parcelRequire == null) {
   parcelRequire = function(id) {
@@ -45,7 +45,7 @@ if (parcelRequire == null) {
     $parcel$inits[id] = init;
   };
 
-  $parcel$global["parcelRequire77ae"] = parcelRequire;
+  $parcel$global["parcelRequire3d58"] = parcelRequire;
 }
 
 var parcelRegister = parcelRequire.register;
@@ -141,7 +141,7 @@ $parcel$export(module.exports, "WatchOnlyTransactionCreator", () => $2ce5b75d109
 $parcel$export(module.exports, "rostrumProvider", () => $b5bfd17fdf06d231$export$eaa49f0478d81b9d);
 // @ts-ignore
 var $2dd241e44b9dc3c2$exports = {};
-$2dd241e44b9dc3c2$exports = JSON.parse("{\"name\":\"@nexa/wallet-sdk-ts\",\"version\":\"0.1.0\",\"main\":\"dist/index.js\",\"module\":\"dist/index.mjs\",\"types\":\"dist/index.d.ts\",\"source\":\"src/index.ts\",\"scripts\":{\"build\":\"parcel build\",\"dev\":\"parcel watch\",\"test\":\"vitest run\",\"clean\":\"rm -rf dist .parcel-cache\"},\"repository\":{\"type\":\"git\",\"url\":\"git+ssh://git@gitlab.com/nexa/wallet-sdk-ts.git\"},\"keywords\":[\"nexa\",\"wallet\",\"web3\",\"crypto\",\"dapp\",\"walletcomms\",\"walletsdk\"],\"contributors\":[{\"name\":\"Dolaned\"},{\"name\":\"Griffith\"},{\"name\":\"Vgrunner\"},{\"name\":\"myendy\"}],\"author\":\"Dolaned\",\"license\":\"MIT\",\"bugs\":{\"url\":\"https://gitlab.com/nexa/wallet-sdk-ts/issues\"},\"homepage\":\"https://gitlab.com/nexa/wallet-sdk-ts#readme\",\"description\":\"Wallet SDK for the Nexa blockchain\",\"devDependencies\":{\"@parcel/packager-ts\":\"^2.15.4\",\"@parcel/transformer-typescript-types\":\"^2.15.4\",\"@types/lodash-es\":\"^4.17.12\",\"@types/node\":\"^22.13.1\",\"parcel\":\"^2.15.4\",\"typescript\":\"^5.8.3\",\"vitest\":\"^3.0.8\"},\"targets\":{\"main\":{\"context\":\"node\",\"outputFormat\":\"commonjs\",\"distDir\":\"dist\",\"isLibrary\":true,\"includeNodeModules\":[\"lodash-es\"]},\"module\":{\"context\":\"node\",\"outputFormat\":\"esmodule\",\"distDir\":\"dist\",\"isLibrary\":true},\"browser\":{\"context\":\"browser\",\"outputFormat\":\"esmodule\",\"distDir\":\"dist\",\"isLibrary\":true}},\"dependencies\":{\"@vgrunner/electrum-cash\":\"^2.0.12\",\"bip39\":\"^3.1.0\",\"js-big-decimal\":\"^2.2.0\",\"libnexa-ts\":\"^1.0.5\",\"lodash-es\":\"^4.17.21\"},\"directories\":{\"test\":\"tests\"}}");
+$2dd241e44b9dc3c2$exports = JSON.parse("{\"name\":\"nexa-wallet-sdk\",\"version\":\"0.1.4\",\"type\":\"module\",\"source\":\"src/index.ts\",\"types\":\"dist/index.d.ts\",\"main\":\"dist/index.cjs\",\"module\":\"dist/index.mjs\",\"browser\":\"dist/index.web.mjs\",\"exports\":{\"types\":\"./dist/index.d.ts\",\"node\":{\"import\":\"./dist/index.mjs\",\"require\":\"./dist/index.cjs\"},\"browser\":\"./dist/index.web.mjs\",\"default\":\"./dist/index.mjs\"},\"scripts\":{\"build\":\"parcel build\",\"lint\":\"eslint .\",\"fix-lint\":\"eslint --fix .\",\"dev\":\"parcel watch\",\"test\":\"vitest run\",\"clean\":\"rm -rf dist .parcel-cache\",\"docs\":\"typedoc\"},\"repository\":{\"type\":\"git\",\"url\":\"git+ssh://git@gitlab.com/nexa/wallet-sdk-ts.git\"},\"keywords\":[\"nexa\",\"wallet\",\"web3\",\"crypto\",\"dapp\",\"walletcomms\",\"walletsdk\"],\"contributors\":[{\"name\":\"Dolaned\"},{\"name\":\"Griffith\"},{\"name\":\"Vgrunner\"},{\"name\":\"myendy\"}],\"author\":\"Dolaned\",\"license\":\"MIT\",\"bugs\":{\"url\":\"https://gitlab.com/nexa/wallet-sdk-ts/issues\"},\"homepage\":\"https://gitlab.com/nexa/wallet-sdk-ts#readme\",\"description\":\"Wallet SDK for the Nexa blockchain\",\"devDependencies\":{\"@parcel/packager-ts\":\"^2.15.4\",\"@parcel/transformer-typescript-types\":\"^2.15.4\",\"@types/lodash-es\":\"^4.17.12\",\"@types/node\":\"^22.13.1\",\"eslint\":\"^9.20.1\",\"parcel\":\"^2.15.4\",\"typedoc\":\"^0.28.7\",\"typedoc-plugin-markdown\":\"^4.7.0\",\"typedoc-plugin-rename-defaults\":\"^0.7.3\",\"typescript\":\"^5.8.3\",\"typescript-eslint\":\"^8.24.1\",\"vitest\":\"^3.0.8\"},\"targets\":{\"main\":{\"context\":\"node\",\"outputFormat\":\"commonjs\",\"distDir\":\"dist\",\"isLibrary\":true,\"includeNodeModules\":[\"lodash-es\"]},\"module\":{\"context\":\"node\",\"outputFormat\":\"esmodule\",\"distDir\":\"dist\",\"isLibrary\":true},\"browser\":{\"context\":\"browser\",\"outputFormat\":\"esmodule\",\"distDir\":\"dist\",\"isLibrary\":true}},\"dependencies\":{\"@vgrunner/electrum-cash\":\"^2.0.12\",\"bip39\":\"^3.1.0\",\"js-big-decimal\":\"^2.2.0\",\"libnexa-ts\":\"^1.0.5\",\"lodash-es\":\"^4.17.21\"},\"files\":[\"dist\"],\"directories\":{\"test\":\"tests\"},\"@parcel/resolver-default\":{\"packageExports\":true}}");
 
 
 
@@ -153,50 +153,95 @@ const $95d1e8196bc3f78b$export$1f6f962b0b96558 = {
 };
 
 
+
 class $b5bfd17fdf06d231$export$ba81aefc89aef50c {
     constructor(){}
-    async getVersion() {
+    /**
+     * Get Rostum Server Version
+     */ async getVersion() {
         return await this.execute('server.version');
     }
-    async getBlockTip() {
+    /**
+     * Get the block tip of the network / chain we are currently connected to
+     */ async getBlockTip() {
         return await this.execute('blockchain.headers.tip');
     }
-    async getBalance(address) {
+    /**
+     * Get the nexa balance of an address without the token balances
+     * @param address
+     */ async getBalance(address) {
         return await this.execute('blockchain.address.get_balance', address, 'exclude_tokens');
     }
-    async getTransactionsHistory(address) {
+    /**
+     * Get The transaction history for an address
+     * @param address
+     */ async getTransactionHistory(address) {
         return await this.execute('blockchain.address.get_history', address);
     }
-    async getFirstUse(address) {
+    /**
+     * Get the block height or block has of when the address was first used
+     * @param address
+     */ async getFirstUse(address) {
         return await this.execute('blockchain.address.get_first_use', address);
     }
-    async getTransaction(id, verbose = true) {
+    /**
+     * Get a single transaction object
+     * @param id
+     * @param verbose
+     */ async getTransaction(id, verbose = true) {
         return await this.execute('blockchain.transaction.get', id, verbose);
     }
-    async getUtxo(outpoint) {
+    /**
+     * Get a single unspent output including group data
+     * @param outpoint
+     */ async getUtxo(outpoint) {
         return await this.execute('blockchain.utxo.get', outpoint);
     }
-    async getNexaUtxos(address) {
+    /**
+     * Get Utxos only containing nexa information
+     * @param address
+     */ async getNexaUtxos(address) {
         return await this.execute('blockchain.address.listunspent', address, 'exclude_tokens');
     }
-    async getTokenUtxos(address, token) {
+    /**
+     * Get all the utxo's for a token at an address
+     * @param address
+     * @param token
+     */ async getTokenUtxos(address, token) {
         let listunspent = await this.execute('token.address.listunspent', address, null, token);
         return listunspent.unspent;
     }
-    async getTokensBalance(address, token) {
+    /**
+     * Get the token balances for an address
+     * @param address
+     * @param token
+     */ async getTokensBalance(address, token) {
         if (token) return await this.execute('token.address.get_balance', address, null, token);
         return await this.execute('token.address.get_balance', address);
     }
-    async getTokenGenesis(token) {
+    /**
+     * Get the token genesis for a token
+     * @param token
+     */ async getTokenGenesis(token) {
         return await this.execute('token.genesis.info', token);
     }
-    async subscribeToAddresses(addresses, callback) {
+    /**
+     * Subscribe to address call back notifications, handy for updating the user when they receive nexa or tokens in
+     * their wallet
+     * @param addresses
+     * @param callback
+     */ async subscribeToAddresses(addresses, callback) {
         for (const addr of addresses)await this.client?.subscribe(callback, 'blockchain.address.subscribe', addr);
     }
-    async broadcast(txHex) {
+    /**
+     * Broadcast a presigned transaction hash
+     * @param txHex
+     */ async broadcast(txHex) {
         return await this.execute('blockchain.transaction.broadcast', txHex);
     }
-    async getLatency() {
+    /**
+     * Get the latency of the server connection
+     */ async getLatency() {
         try {
             let start = Date.now();
             let res = await this.getBlockTip();
@@ -206,14 +251,39 @@ class $b5bfd17fdf06d231$export$ba81aefc89aef50c {
             return 0;
         }
     }
-    async connect(params) {
+    /**
+     * Create initial connection with the rostrum server
+     * @param netOrParams
+     * @param params
+     */ async connect(netOrParams, params) {
         try {
-            if (!params) params = {
-                host: 'aus.electrum.nexa.onethirtyseven.dev',
-                port: 30004,
-                scheme: (0, $95d1e8196bc3f78b$export$1f6f962b0b96558).WSS
-            };
-            this.client = new (0, $l50U0$vgrunnerelectrumcash.ElectrumClient)("com.otoplo.wallet", "1.4.3", params.host, params.port, params.scheme, 30000, 10000, true);
+            let connectionParams;
+            // Handle backward compatibility: connect(params) or connect(network, params)
+            if (netOrParams && typeof netOrParams === 'object' && 'host' in netOrParams && 'port' in netOrParams && 'scheme' in netOrParams) // First parameter is RostrumParams
+            connectionParams = netOrParams;
+            else if (params) // Second parameter contains RostrumParams, ignore network
+            connectionParams = params;
+            else {
+                // Use network to determine default params
+                const network = netOrParams ? (0, $l50U0$libnexats.Networks).get(netOrParams) : (0, $l50U0$libnexats.Networks).mainnet;
+                if (network === (0, $l50U0$libnexats.Networks).mainnet) connectionParams = {
+                    host: 'electrum.nexa.org',
+                    port: 20004,
+                    scheme: (0, $95d1e8196bc3f78b$export$1f6f962b0b96558).WSS
+                };
+                else if (network === (0, $l50U0$libnexats.Networks).testnet) connectionParams = {
+                    host: 'testnet-electrum.nexa.org',
+                    port: 30004,
+                    scheme: (0, $95d1e8196bc3f78b$export$1f6f962b0b96558).WSS
+                };
+                else // Default fallback for other networks (like regtest)
+                connectionParams = {
+                    host: 'localhost',
+                    port: 30004,
+                    scheme: (0, $95d1e8196bc3f78b$export$1f6f962b0b96558).WS
+                };
+            }
+            this.client = new (0, $l50U0$vgrunnerelectrumcash.ElectrumClient)("com.nexa.wallet-sdk", "0.1.4", connectionParams.host, connectionParams.port, connectionParams.scheme, 30000, 10000, true);
             await this.client.connect();
         } catch (e) {
             if (e instanceof Error) console.info(e.message);
@@ -221,7 +291,10 @@ class $b5bfd17fdf06d231$export$ba81aefc89aef50c {
             throw e;
         }
     }
-    async disconnect(force) {
+    /**
+     * Disconnect from the rostrum server
+     * @param force
+     */ async disconnect(force) {
         try {
             return await this.client.disconnect(force);
         } catch (e) {
@@ -229,8 +302,13 @@ class $b5bfd17fdf06d231$export$ba81aefc89aef50c {
             return false;
         }
     }
-    async execute(method, ...parameters) {
-        var res = await this.client.request(method, ...parameters);
+    /**
+     * internal function to call commands against the rostrum API
+     * @param method
+     * @param parameters
+     * @private
+     */ async execute(method, ...parameters) {
+        let res = await this.client.request(method, ...parameters);
         if (res instanceof Error) throw res;
         return res;
     }
@@ -789,7 +867,7 @@ async function $0d59d2bcffd646c5$export$a2ed4b531376a5a4(addresses, fromHeight)
     let index = 0, i = 0, data = new Map(), maxHeight = fromHeight;
     for (let address of addresses){
         i++;
-        let txHistory = await (0, $b5bfd17fdf06d231$export$eaa49f0478d81b9d).getTransactionsHistory(address);
+        let txHistory = await (0, $b5bfd17fdf06d231$export$eaa49f0478d81b9d).getTransactionHistory(address);
         if (txHistory && txHistory.length > 0) {
             index = i;
             for (let tx of txHistory)if (tx.height === 0 || tx.height > fromHeight) {
@@ -808,7 +886,7 @@ async function $0d59d2bcffd646c5$var$rescanAddressesHistory(addresses) {
     let index = 0, i = 0, minHeight = Number.MAX_SAFE_INTEGER;
     for (let address of addresses){
         i++;
-        let txHistory = await (0, $b5bfd17fdf06d231$export$eaa49f0478d81b9d).getTransactionsHistory(address);
+        let txHistory = await (0, $b5bfd17fdf06d231$export$eaa49f0478d81b9d).getTransactionHistory(address);
         if (!(0, $54dde1e65fb8e5b8$export$2e2bcd8739ae039)(txHistory)) {
             index = i;
             let heights = txHistory.filter((tx)=>tx.height > 0).map((h)=>h.height);
@@ -2912,4 +2990,4 @@ $parcel$global._walletSdk_ver = `v${0, $2dd241e44b9dc3c2$exports.version}`;
 var $56b18ab116ff33bd$export$2e2bcd8739ae039 = $56b18ab116ff33bd$var$walletSdk;
 
 
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.cjs.map