@electrum-cash/network 3.2.0-r2 → 3.3.0-development.6103536979

package/README.md

@@ -15,7 +15,7 @@ Install the library with NPM:
 
 ## Usage
 
-### Load library
+### Usage with NodeJS
 
 Before you can use the library you need to include it in your project.
 
@@ -33,6 +33,15 @@ If you want to use **multiple servers**, load the `ElectrumCluster` module:
 const { ElectrumCluster } = require('electrum-cash');
 ```
 
+### Usage on Web
+
+To use the library on the web, use the ESM import syntax and include the `ElectrumTransport` import:
+
+```js
+// Load the electrum library.
+import { ElectrumClient, ElectrumTransport } from 'electrum-cash';
+```
+
 ### Connect to servers
 
 After you have loaded the appropriate module you need to initialize the module by configuring your **application identifier** and **protocol version**.
@@ -46,6 +55,15 @@ const electrum = new ElectrumClient('Electrum client example', '1.4.1', 'bch.ima
 await electrum.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(
+	'Electrum client example', '1.4.1', 'bch.imaginary.cash',
+	ElectrumTransport.WSS.Port, ElectrumTransport.WSS.Scheme
+);
+```
+
 If you want to use multiple servers, initialize an `ElectrumCluster` and add some servers:
 
 *For more information on various cluster configurations, read the [cluster documentation](https://read.cash/@JonathanSilverblood/electrum-cash-strategic-use-of-clusters-83743111).*
@@ -65,6 +83,7 @@ electrum.addServer('electrum.imaginary.cash');
 await electrum.ready();
 ```
 
+
 ### Request information
 
 Once your `ElectrumClient` or `ElectrumCluster` is connected and ready, you can call methods:

package/dist/index.cjs

@@ -182,12 +182,12 @@ const $48ce8effa4fcde4d$export$f019be48b3aacb1a = {
     // Transport to connect to the Electrum server
     TRANSPORT_SCHEME: $48ce8effa4fcde4d$export$d048df559e6d3842.TCP_TLS.Scheme,
     // How long to wait before attempting to reconnect, in milliseconds.
-    RECONNECT: 15000,
+    RECONNECT: 5000,
     // How long to wait for network operations before following up, in milliseconds.
-    TIMEOUT: 120000,
+    TIMEOUT: 30000,
     // Time between ping messages, in milliseconds. Pinging keeps the connection alive.
     // The reason for pinging this frequently is to detect connection problems early.
-    PING_INTERVAL: 3000,
+    PING_INTERVAL: 1000,
     // How many servers are required before we trust information provided.
     CLUSTER_CONFIDENCE: 1,
     // How many servers we send requests to.
@@ -1158,20 +1158,25 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
  * Triggers when the cluster connects to enough servers to satisfy both the cluster confidence and distribution policies.
  *
  * @event ElectrumCluster#ready
+ * @deprecated
  */ /**
  * Triggers when the cluster loses a connection and can no longer satisfy the cluster distribution policy.
  *
  * @event ElectrumCluster#degraded
+ * @deprecated
  */ /**
  * Triggers when the cluster loses a connection and can no longer satisfy the cluster confidence policy.
  *
  * @event ElectrumCluster#disabled
+ * @deprecated
  */ /**
  * Triggers when the cluster verifies the integrity of remote server sent data that is not a request responses.
  *
  * @event ElectrumCluster#notification
+ * @deprecated
  */ /**
  * High-level electrum client that provides transparent load balancing, confidence checking and/or low-latency polling.
+ * @deprecated
  */ class $683dbcc250bd73d7$var$ElectrumCluster extends (0, $790lB$events.EventEmitter) {
     /**
 	 * @param {string} application    your application name, used to identify to the electrum hosts.
@@ -1220,6 +1225,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     }
     /**
 	 * Adds a server to the cluster.
+	 * @deprecated
 	 *
 	 * @param {string} host              fully qualified domain name or IP number of the host.
 	 * @param {number} port              the TCP network port of the host.
@@ -1323,6 +1329,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     }
     /**
 	 * Calls a method on the remote server with the supplied parameters.
+	 * @deprecated
 	 *
 	 * @param {string}    method       name of the method to call.
 	 * @param {...string} parameters   one or more parameters for the method.
@@ -1439,6 +1446,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     }
     /**
 	 * Subscribes to the method at the cluster and attaches the callback function to the event feed.
+	 * @deprecated
 	 *
 	 * @note the response for the subscription request is issued as a notification event.
 	 *
@@ -1465,6 +1473,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     /**
 	 * Unsubscribes to the method at the cluster and removes any callback functions
 	 * when there are no more subscriptions for the method.
+	 * @deprecated
 	 *
 	 * @param {string}    method       one of the subscribable methods the server supports.
 	 * @param {...string} parameters   one or more parameters for the method.
@@ -1485,6 +1494,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     }
     /**
 	 * Define a callback function to validate server notifications and pass them to the subscribe callback.
+	 * @deprecated
 	 *
 	 * @ignore
 	 */ async handleSubscriptionNotifications(clientIdentity, data) {
@@ -1521,11 +1531,13 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
 	 * Forgets/Removes notification data for a specific notification.
 	 *
 	 * This is required in order to allow future identical notifications to be properly processed and emitted.
+	 * @deprecated
 	 */ async dismissSubscriptionNotification(responseDataIdentifier) {
         delete this.notifications[responseDataIdentifier];
     }
     /**
 	 * Provides a method to check or wait for the cluster to become ready.
+	 * @deprecated
 	 *
 	 * @returns a promise that resolves when the required servers are available.
 	 */ async ready() {
@@ -1563,6 +1575,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
     /**
 	 * Connects all servers from the cluster and attaches event listeners and handlers
 	 * for all underlying clients and connections.
+	 * @deprecated
 	 *
 	 * @throws {Error} if the cluster's version is not a valid version string.
 	 */ async startup() {
@@ -1588,6 +1601,7 @@ $ab5ca7f40897fe20$export$2e2bcd8739ae039 = $ab5ca7f40897fe20$var$ElectrumClient;
 	 * Disconnects all servers from the cluster. Removes all event listeners and
 	 * handlers from all underlying clients and connections. This includes all
 	 * active subscriptions, unless retainSubscriptions is set to true.
+	 * @deprecated
 	 *
 	 * @param {boolean} retainSubscriptions   retain subscription data so they will be restored on reconnection.
 	 *