@electrum-cash/network 4.0.0-development.6392223875 → 4.0.0-development.6393041663

package/README.md

@@ -1,6 +1,7 @@
-# electrum-cash
+# Introduction
+
+@electrum-cash/network is a lightweight `JavaScript` library that lets you connect `Electrum` servers.
 
-Electrum-cash is a lightweight `JavaScript` library that lets you connect with one or more `Electrum` servers.
 It offers encrypted connections by default,
 performs the expected protocol version negotiation and
 automatically keeps your connection alive until your close it.
@@ -10,7 +11,7 @@ automatically keeps your connection alive until your close it.
 Install the library with NPM:
 
 ```bash
-# npm install electrum-cash
+# npm install @electrum-cash/network
 ```
 
 ## Usage
@@ -21,7 +22,7 @@ Before you can use the library you need to include it in your project.
 
 ```js
 // Load the electrum library.
-const { ElectrumClient } = require('electrum-cash');
+const { ElectrumClient } = require('@electrum-cash/network');
 ```
 
 ### Usage on Web
@@ -30,26 +31,25 @@ To use the library on the web, use the ESM import syntax and include the `Electr
 
 ```js
 // Load the electrum library.
-import { ElectrumClient, ElectrumTransport } from 'electrum-cash';
+import { ElectrumClient, ElectrumTransport } from '@electrum-cash/network';
 ```
 
-### Connect to servers
+### Connecting to a server
 
-After you have loaded the appropriate module you need to initialize the module by configuring your **application identifier** and **protocol version**.
+After you have imported the library you need to initialize and connect the client by configuring your **application identifier** and **protocol version**.
 
-If you only want to use a single server, initialize an `ElectrumClient` and connect to the server:
 ```js
 // Initialize an electrum client.
-const electrum = new ElectrumClient('Electrum client example', '1.4.1', 'bch.imaginary.cash');
+const electrumClient = new ElectrumClient('Electrum client example', '1.4.1', 'bch.imaginary.cash');
 
 // Wait for the client to connect
-await electrum.connect();
+await electrumClient.connect();
 ```
 
 To connect to an electrum server from a web browser, use the `ElectrumTransport` import to use the WSS `port` and `scheme`:
 
 ```js
-const electrum = new ElectrumClient(
+const electrumClient = new ElectrumClient(
 	'Electrum client example', '1.4.1', 'bch.imaginary.cash',
 	ElectrumTransport.WSS.Port, ElectrumTransport.WSS.Scheme
 );
@@ -66,7 +66,7 @@ Once your `ElectrumClient` is connected and ready, you can call methods:
 const transactionID = '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251';
 
 // Request the full transaction hex for the transaction ID.
-const transactionHex = await electrum.request('blockchain.transaction.get', transactionID);
+const transactionHex = await electrumClient.request('blockchain.transaction.get', transactionID);
 
 // Print out the transaction hex.
 console.log(transactionHex);
@@ -101,33 +101,29 @@ const handleNotifications = function(data)
 }
 
 // Listen for notifications.
-electrum.on('notification', handleNotifications);
+electrumClient.on('notification', handleNotifications);
 
 // Set up a subscription for new block headers.
-await electrum.subscribe('blockchain.headers.subscribe');
+await electrumClient.subscribe('blockchain.headers.subscribe');
 ```
 
 ### Shutting down
 
-When you're done and don't want to be connected anymore you can disconnect the server(s).
-
-If you're using a single `ElectrumClient`, call the `disconnect()` function:
+When you're done and don't want to be connected anymore you can disconnect the server:
 
 ```js
 // Close the connection.
-await electrum.disconnect();
+await electrumClient.disconnect();
 ```
 
 ## Documentation
 
-For a complete list of methods and parameters, read the [API documentation](https://generalprotocols.gitlab.io/electrum-cash/library/).
+For a complete list of methods and parameters, read the [API documentation](https://electrum-cash.gitlab.io/network/).
 
 ## Support and communication
 
 If you need help with how to use the library or just want to talk about electrum-cash, you can find us on [Telegram](https://t.me/electrumcash) and [Discord](https://discord.gg/ZjXQzew).
 
-You can also read our tutorials on [read.cash](https://read.cash/c/electrum-cash-f45e), or share your own.
-
 ## Notes
 
 The keep-alive functionality of this library only works when the protocol version is 1.2 or higher.

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"mappings":";ACCA,oBAA2B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAG5D;IAEC,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,yBAAiC,SAAQ,OAAO;IAE/C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAWD,sBAA8B,SAAQ,OAAO;IAE5C,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;IAEC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACX;AAGD,0BAAkC,SAAQ,OAAO;IAEhD,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;CAChB;AAGD,mBAA0B,gBAAgB,GAAG,YAAY,CAAC;AE3C1D;;;;;GAKG;AACH;IAEC,WAAW,IAAI;IACf,SAAS,IAAI;CACb;AAED;;;;;;;;GAQG;AACH;IAEC,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,UAAU,IAAI;IACd,YAAY,IAAI;CAChB;AC3BD;IAGC,KAAK,EAAE,WAAW,CAAC;IAGnB,UAAU,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,8BAA8B,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,eAAe,EAAE,CAAC;AAI5F,8BAA8B,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAGrE,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AACrE,6BAA6B,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;AAEpD;IAEC,KAAK,EAAE,QAAQ,CAAC;CAChB;AAED;IAEC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,OAAO,MAAM,4BAAqC,GAAG,8BAGpD,CAAC;AAEF,OAAO,MAAM,8BAAuC,GAAG,gCAGtD,CAAC;AAEF;;GAEG;AACH,8BAA8B,KAAK,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;AAG/D;IAEC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;ACvDD;;;;;;;;GAQG;AACH,OAAO,MAAM;;;;;;;;;;;;;;;;;CAMZ,CAAC;AAEF,OAAO,MAAM;;;;;;;CAoBZ,CAAC;AE9BF;;;;GAIG;AACH,gCAAyB,SAAQ,YAAY;IA6CpC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,MAAM;IACf,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IAlDnB,MAAM,EAAE,gBAAgB,CAAiC;IAGzD,qBAAqB,EAAE,MAAM,CAAC;IAG9B,QAAQ,EAAE,MAAM,CAAC;IAoBxB;;;;;;;;;;;;;;OAcG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAA+B,EACrC,MAAM,GAAE,eAAoD,EAC5D,OAAO,GAAE,MAAkC,EAC3C,YAAY,GAAE,MAAwC,EACtD,iBAAiB,GAAE,MAAoC,EACvD,SAAS,GAAE,OAAuC;IAuB1D;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAG3B;IAED;;OAEG;IACH,YAAY,IAAI,IAAI;IA0BpB;;OAEG;IACH,aAAa,IAAI,IAAI;IAMrB;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgFrC;;;;;OAKG;IACH,IAAI,IAAI,OAAO;IAef;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8G9B;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA0BhC;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAY3B;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAY3B;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAU3B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,WAAW,GAAE,OAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAqCvF;;;;;;;;;;OAUG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB7C;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAuB9B;;;OAGG;IACH,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IA0BvC;;OAEG;IACH,eAAe,IAAI,IAAI;IAkBvB;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAoD1B;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,SAAS,GAAG,IAAI;CAgC3C;AC5pBD;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AACH,2BAAqB,SAAQ,YAAY;IAiChC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,MAAM;IACf,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IAtCnB,UAAU,EAAE,kBAAkB,CAAC;IActC;;;;;;;;;;;;;;OAcG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAA+B,EACrC,MAAM,GAAE,eAAoD,EAC5D,OAAO,GAAE,MAAkC,EAC3C,YAAY,GAAE,MAAwC,EACtD,iBAAiB,GAAE,MAAoC,EACvD,SAAS,GAAE,OAAuC;IAU1D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAoC9B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,mBAAmB,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAqChG;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;IAgD9F;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B7E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA6E/E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAiDtD;;;;;OAKG;IACH,sBAAsB,IAAI,IAAI;CAkB9B","sources":["lib/lib/util.ts","lib/lib/rpc-interfaces.ts","lib/lib/electrum-protocol.ts","lib/lib/enums.ts","lib/lib/interfaces.ts","lib/lib/constants.ts","lib/lib/electrum-socket.ts","lib/lib/electrum-connection.ts","lib/lib/electrum-client.ts","lib/lib/index.ts","lib/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,"export { default as ElectrumClient } from './electrum-client';\n\nexport * from './interfaces';\nexport * from './constants';\nexport * from './enums';\n"],"names":[],"version":3,"file":"index.d.ts.map"}
+{"mappings":";ACCA,oBAA2B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAG5D;IAEC,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,yBAAiC,SAAQ,OAAO;IAE/C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAWD,sBAA8B,SAAQ,OAAO;IAE5C,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;IAEC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACX;AAGD,0BAAkC,SAAQ,OAAO;IAEhD,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;CAChB;AAGD,mBAA0B,gBAAgB,GAAG,YAAY,CAAC;AE3C1D;;;;;GAKG;AACH;IAEC,WAAW,IAAI;IACf,SAAS,IAAI;CACb;AAED;;;;;;;;GAQG;AACH;IAEC,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,UAAU,IAAI;IACd,YAAY,IAAI;CAChB;AC3BD;IAGC,KAAK,EAAE,WAAW,CAAC;IAGnB,UAAU,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,8BAA8B,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,eAAe,EAAE,CAAC;AAI5F,8BAA8B,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAGrE,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AACrE,6BAA6B,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;AAEpD;IAEC,KAAK,EAAE,QAAQ,CAAC;CAChB;AAED;IAEC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,OAAO,MAAM,4BAAqC,GAAG,8BAGpD,CAAC;AAEF,OAAO,MAAM,8BAAuC,GAAG,gCAGtD,CAAC;AAEF;;GAEG;AACH,8BAA8B,KAAK,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;AAG/D;IAEC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;ACvDD;;;;;;;;GAQG;AACH,OAAO,MAAM;;;;;;;;;;;;;;;;;CAMZ,CAAC;AAEF,OAAO,MAAM;;;;;;;CAoBZ,CAAC;AE9BF;;;;GAIG;AACH,gCAAyB,SAAQ,YAAY;IA6CpC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,MAAM;IACf,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IAlDnB,MAAM,EAAE,gBAAgB,CAAiC;IAGzD,qBAAqB,EAAE,MAAM,CAAC;IAG9B,QAAQ,EAAE,MAAM,CAAC;IAoBxB;;;;;;;;;;;;;;OAcG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAA+B,EACrC,MAAM,GAAE,eAAoD,EAC5D,OAAO,GAAE,MAAkC,EAC3C,YAAY,GAAE,MAAwC,EACtD,iBAAiB,GAAE,MAAoC,EACvD,SAAS,GAAE,OAAuC;IAuB1D;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAG3B;IAED;;OAEG;IACH,YAAY,IAAI,IAAI;IA0BpB;;OAEG;IACH,aAAa,IAAI,IAAI;IAMrB;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAgFrC;;;;;OAKG;IACH,IAAI,IAAI,OAAO;IAef;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA8G9B;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA0BhC;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAY3B;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAY3B;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAU3B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,WAAW,GAAE,OAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAqCvF;;;;;;;;;;OAUG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB7C;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAuB9B;;;OAGG;IACH,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IA0BvC;;OAEG;IACH,eAAe,IAAI,IAAI;IAkBvB;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAoD1B;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,SAAS,GAAG,IAAI;CAgC3C;AC5pBD;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AACH,2BAAqB,SAAQ,YAAY;IAiChC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,MAAM;IACf,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IAtCnB,UAAU,EAAE,kBAAkB,CAAC;IActC;;;;;;;;;;;;;;OAcG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAA+B,EACrC,MAAM,GAAE,eAAoD,EAC5D,OAAO,GAAE,MAAkC,EAC3C,YAAY,GAAE,MAAwC,EACtD,iBAAiB,GAAE,MAAoC,EACvD,SAAS,GAAE,OAAuC;IAU1D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAoC9B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,mBAAmB,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAqChG;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;IAgD9F;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B7E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA6E/E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IAiDtD;;;;;OAKG;IACH,sBAAsB,IAAI,IAAI;CAkB9B","sources":["source/source/util.ts","source/source/rpc-interfaces.ts","source/source/electrum-protocol.ts","source/source/enums.ts","source/source/interfaces.ts","source/source/constants.ts","source/source/electrum-socket.ts","source/source/electrum-connection.ts","source/source/electrum-client.ts","source/source/index.ts","source/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,"export { default as ElectrumClient } from './electrum-client';\n\nexport * from './interfaces';\nexport * from './constants';\nexport * from './enums';\n"],"names":[],"version":3,"file":"index.d.ts.map"}