chia-agent 14.0.0-beta.0 → 14.0.0-beta.1

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 ## [14.0.0]
 ### Breaking change
 - When RPC API responds with `success: false`, its `Promise` now does `reject`. (Previously it does `resolve`)
+### Added
+- Added connectivity options for `RPCAgent`.
+  - `keepAlive` (default: `true`)
+  - `keepAliveMsecs` (default: `1000`)
+  - `maxSockets` (default: `Infinity`)
+  - `timeout` (default: `undefined`)
+```typescript
+// Usage
+const {RPCAgent, setLogLevel} = require("chia-agent");
+const {get_plots} = require("chia-agent/api/rpc");
+
+const agent = new RPCAgent({
+  service: "harvester",
+  keepAlive: true,
+  keepAliveMsecs: 3000,
+  maxSockets: 1, // Avoid to set `1` if your requests may be sent in parallel.
+  timeout: 5000,
+});
+```
 
 ## [13.2.0]
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chia-agent",
-  "version": "14.0.0-beta.0",
+  "version": "14.0.0-beta.1",
   "author": "ChiaMineJP <admin@chiamine.jp>",
   "description": "chia rpc/websocket client library",
   "license": "MIT",

package/rpc/index.d.ts

@@ -15,22 +15,38 @@ export declare type TRPCAgentProps = {
     client_cert?: string | Buffer;
     client_key?: string | Buffer;
     skip_hostname_verification?: boolean;
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    timeout?: number;
 } | {
     protocol: "https";
     host: string;
     port: number;
     configPath: string;
     skip_hostname_verification?: boolean;
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    timeout?: number;
 } | {
     protocol: "http";
     host: string;
     port: number;
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    timeout?: number;
 } | {
     service: TDestination;
     host?: string;
     port?: number;
     configPath?: string;
     skip_hostname_verification?: boolean;
+    keepAlive?: boolean;
+    keepAliveMsecs?: number;
+    maxSockets?: number;
+    timeout?: number;
 };
 export declare class RPCAgent {
     protected _protocol: "http" | "https";
@@ -41,6 +57,10 @@ export declare class RPCAgent {
     protected _clientKey?: string | Buffer;
     protected _agent: HttpsAgent | HttpAgent;
     protected _skip_hostname_verification: boolean;
+    protected _keepAlive: boolean;
+    protected _keepAliveMsecs: number;
+    protected _maxSockets: number;
+    protected _timeout?: number;
     constructor(props: TRPCAgentProps);
     protected _getConfig(configPath?: string): TConfig;
     protected _loadCertFilesFromConfig(config: TConfig): {

package/rpc/index.js

@@ -67,10 +67,21 @@ class RPCAgent {
         this._clientCert = "";
         this._clientKey = "";
         this._skip_hostname_verification = false;
+        this._keepAlive = true;
+        this._keepAliveMsecs = 1000;
+        this._maxSockets = Infinity;
+        this._timeout = undefined;
         if ("protocol" in props) {
             this._protocol = props.protocol;
             this._hostname = props.host;
             this._port = props.port;
+            this._keepAlive = props.keepAlive !== false;
+            this._keepAliveMsecs = typeof props.keepAliveMsecs === "number" && props.keepAliveMsecs > 0 ?
+                props.keepAliveMsecs : this._keepAliveMsecs;
+            this._maxSockets = typeof props.maxSockets === "number" && props.maxSockets > 0 ?
+                props.maxSockets : this._maxSockets;
+            this._timeout = typeof props.timeout === "number" && props.timeout > 0 ?
+                props.timeout : this._timeout;
             if (props.protocol === "https") {
                 if ("configPath" in props) {
                     const config = this._getConfig(props.configPath);
@@ -93,14 +104,28 @@ class RPCAgent {
                     cert: this._clientCert,
                     key: this._clientKey,
                     rejectUnauthorized: Boolean(this._caCert) && this._hostname !== "localhost",
+                    keepAlive: this._keepAlive,
+                    keepAliveMsecs: this._keepAliveMsecs,
+                    maxSockets: this._maxSockets,
+                    timeout: this._timeout,
                 });
             }
             else {
-                this._agent = new http_1.Agent();
+                this._agent = new http_1.Agent({
+                    keepAlive: this._keepAlive,
+                    keepAliveMsecs: this._keepAliveMsecs,
+                    maxSockets: this._maxSockets,
+                    timeout: this._timeout,
+                });
             }
         }
         else {
             this._protocol = "https";
+            this._keepAlive = props.keepAlive !== false;
+            this._keepAliveMsecs = typeof props.keepAliveMsecs === "number" ? props.keepAliveMsecs : this._keepAliveMsecs;
+            this._maxSockets = typeof props.maxSockets === "number" && props.maxSockets > 0 ?
+                props.maxSockets : this._maxSockets;
+            this._timeout = typeof props.timeout === "number" && props.timeout > 0 ? props.timeout : this._timeout;
             const config = this._getConfig("configPath" in props ? props.configPath : undefined);
             if (props.host && typeof props.port === "number") {
                 this._hostname = props.host;
@@ -124,6 +149,10 @@ class RPCAgent {
                 cert: this._clientCert,
                 key: this._clientKey,
                 rejectUnauthorized: Boolean(this._caCert) && this._hostname !== "localhost",
+                keepAlive: this._keepAlive,
+                keepAliveMsecs: this._keepAliveMsecs,
+                maxSockets: this._maxSockets,
+                timeout: this._timeout,
             });
         }
     }