@solana/rpc-transport - npm Package Compare versions

Comparing version 2.0.0-experimental.11d7d74 to 2.0.0-experimental.11dd48f

dist/index.browser.js

 // ../build-scripts/env-shim.ts
 var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 
+// src/apis/methods/methods-api.ts
+function createJsonRpcApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const methodName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, methodName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        return {
+          methodName,
+          params,
+          responseTransformer
+        };
+      };
+    }
+  });
+}
+
+// src/apis/subscriptions/subscriptions-api.ts
+function createJsonRpcSubscriptionsApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const notificationName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, notificationName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        const subscribeMethodName = config?.subscribeNotificationNameTransformer ? config?.subscribeNotificationNameTransformer(notificationName) : notificationName;
+        const unsubscribeMethodName = config?.unsubscribeNotificationNameTransformer ? config?.unsubscribeNotificationNameTransformer(notificationName) : notificationName;
+        return {
+          params,
+          responseTransformer,
+          subscribeMethodName,
+          unsubscribeMethodName
+        };
+      };
+    }
+  });
+}
+
 // src/json-rpc-errors.ts
 var SolanaJsonRpcError = class extends Error {
+  code;
+  data;
   constructor(details) {
@@ -39,3 +94,3 @@ super(`JSON-RPC 2.0 error (${details.code}): ${details.message}`);
     async send(options) {
-      const { methodName, params, responseProcessor } = pendingRequest;
+      const { methodName, params, responseTransformer } = pendingRequest;
       const payload = createJsonRpcMessage(methodName, params);
@@ -49,3 +104,3 @@ const response = await rpcConfig.transport({
       } else {
-        return responseProcessor ? responseProcessor(response.result) : response.result;
+        return responseTransformer ? responseTransformer(response.result, methodName) : response.result;
       }
@@ -77,2 +132,98 @@ }
 
+// src/json-rpc-subscription.ts
+function registerIterableCleanup(iterable, cleanupFn) {
+  (async () => {
+    try {
+      for await (const _ of iterable)
+        ;
+    } catch {
+    } finally {
+      cleanupFn();
+    }
+  })();
+}
+function createPendingRpcSubscription(rpcConfig, { params, subscribeMethodName, unsubscribeMethodName, responseTransformer }) {
+  return {
+    async subscribe({ abortSignal }) {
+      abortSignal.throwIfAborted();
+      let subscriptionId;
+      function handleCleanup() {
+        if (subscriptionId !== void 0) {
+          const payload = createJsonRpcMessage(unsubscribeMethodName, [subscriptionId]);
+          connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(payload).finally(() => {
+            connectionAbortController.abort();
+          });
+        } else {
+          connectionAbortController.abort();
+        }
+      }
+      abortSignal.addEventListener("abort", handleCleanup);
+      const connectionAbortController = new AbortController();
+      const subscribeMessage = createJsonRpcMessage(subscribeMethodName, params);
+      const connection = await rpcConfig.transport({
+        payload: subscribeMessage,
+        signal: connectionAbortController.signal
+      });
+      function handleConnectionCleanup() {
+        abortSignal.removeEventListener("abort", handleCleanup);
+      }
+      registerIterableCleanup(connection, handleConnectionCleanup);
+      for await (const message of connection) {
+        if ("id" in message && message.id === subscribeMessage.id) {
+          if ("error" in message) {
+            throw new SolanaJsonRpcError(message.error);
+          } else {
+            subscriptionId = message.result;
+            break;
+          }
+        }
+      }
+      if (subscriptionId == null) {
+        throw new Error("Failed to obtain a subscription id from the server");
+      }
+      return {
+        async *[Symbol.asyncIterator]() {
+          for await (const message of connection) {
+            if (!("params" in message) || message.params.subscription !== subscriptionId) {
+              continue;
+            }
+            const notification = message.params.result;
+            yield responseTransformer ? responseTransformer(notification, subscribeMethodName) : notification;
+          }
+        }
+      };
+    }
+  };
+}
+function makeProxy2(rpcConfig) {
+  return new Proxy(rpcConfig.api, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(target, p, receiver) {
+      return function(...rawParams) {
+        const methodName = p.toString();
+        const createRpcSubscription = Reflect.get(target, methodName, receiver);
+        if (p.toString().endsWith("Notifications") === false && !createRpcSubscription) {
+          throw new Error(
+            "Either the notification name must end in 'Notifications' or the API must supply a subscription creator function to map between the notification name and the subscribe/unsubscribe method names."
+          );
+        }
+        const newRequest = createRpcSubscription ? createRpcSubscription(...rawParams) : {
+          params: rawParams,
+          subscribeMethodName: methodName.replace(/Notifications$/, "Subscribe"),
+          unsubscribeMethodName: methodName.replace(/Notifications$/, "Unsubscribe")
+        };
+        return createPendingRpcSubscription(rpcConfig, newRequest);
+      };
+    }
+  });
+}
+function createJsonSubscriptionRpc(rpcConfig) {
+  return makeProxy2(rpcConfig);
+}
+
 // ../fetch-impl/dist/index.browser.js
@@ -83,2 +234,3 @@ var e = globalThis.fetch;
 var SolanaHttpError = class extends Error {
+  statusCode;
   constructor(details) {
@@ -145,12 +297,6 @@ super(`HTTP error (${details.statusCode}): ${details.message}`);
 // src/transports/http/http-transport.ts
-function createHttpTransport({ httpAgentNodeOnly, headers, url }) {
+function createHttpTransport({ headers, url }) {
   if (__DEV__ && headers) {
     assertIsAllowedHttpRequestHeaders(headers);
   }
-  const agent = void 0;
-  if (__DEV__ && httpAgentNodeOnly != null) {
-    console.warn(
-      "createHttpTransport(): The `httpAgentNodeOnly` config you supplied has been ignored; HTTP agents are only usable in Node environments."
-    );
-  }
   const customHeaders = headers && normalizeHeaders(headers);
@@ -163,3 +309,2 @@ return async function makeHttpRequest({
     const requestInfo = {
-      agent,
       body,
@@ -191,7 +336,25 @@ headers: {
 // src/transports/websocket/websocket-connection.ts
-async function createWebSocketConnection({ signal, url }) {
+var EXPLICIT_ABORT_TOKEN = Symbol(
+  __DEV__ ? "This symbol is thrown from a socket's iterator when the connection is explicitly aborted by the user" : void 0
+);
+async function createWebSocketConnection({
+  sendBufferHighWatermark,
+  signal,
+  url
+}) {
   return new Promise((resolve, reject) => {
     signal.addEventListener("abort", handleAbort, { once: true });
     const iteratorState = /* @__PURE__ */ new Map();
+    function errorAndClearAllIteratorStates(reason) {
+      const errorCallbacks = [...iteratorState.values()].filter((state) => state.__hasPolled).map(({ onError }) => onError);
+      iteratorState.clear();
+      errorCallbacks.forEach((cb) => {
+        try {
+          cb(reason);
+        } catch {
+        }
+      });
+    }
     function handleAbort() {
+      errorAndClearAllIteratorStates(EXPLICIT_ABORT_TOKEN);
       if (webSocket.readyState !== e2.CLOSED && webSocket.readyState !== e2.CLOSING) {
@@ -202,2 +365,3 @@ webSocket.close(1e3);
     function handleClose(ev) {
+      bufferDrainWatcher?.onCancel();
       signal.removeEventListener("abort", handleAbort);
@@ -208,11 +372,3 @@ webSocket.removeEventListener("close", handleClose);
       webSocket.removeEventListener("message", handleMessage);
-      iteratorState.forEach((state, iteratorKey) => {
-        if (state.__hasPolled) {
-          const { onError } = state;
-          iteratorState.delete(iteratorKey);
-          onError(ev);
-        } else {
-          iteratorState.delete(iteratorKey);
-        }
-      });
+      errorAndClearAllIteratorStates(ev);
     }
@@ -228,2 +384,3 @@ function handleError(ev) {
     let hasConnected = false;
+    let bufferDrainWatcher;
     function handleOpen() {
@@ -234,2 +391,31 @@ hasConnected = true;
           const message = JSON.stringify(payload);
+          if (!bufferDrainWatcher && webSocket.readyState === e2.OPEN && webSocket.bufferedAmount > sendBufferHighWatermark) {
+            let onCancel;
+            const promise = new Promise((resolve2, reject2) => {
+              const intervalId = setInterval(() => {
+                if (webSocket.readyState !== e2.OPEN || !(webSocket.bufferedAmount > sendBufferHighWatermark)) {
+                  clearInterval(intervalId);
+                  bufferDrainWatcher = void 0;
+                  resolve2();
+                }
+              }, 16);
+              onCancel = () => {
+                bufferDrainWatcher = void 0;
+                clearInterval(intervalId);
+                reject2(
+                  // TODO: Coded error
+                  new Error("WebSocket was closed before payload could be sent")
+                );
+              };
+            });
+            bufferDrainWatcher = {
+              // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+              // @ts-ignore
+              onCancel,
+              promise
+            };
+          }
+          if (bufferDrainWatcher) {
+            await bufferDrainWatcher.promise;
+          }
           webSocket.send(message);
@@ -257,11 +443,11 @@ },
                 try {
-                  yield await new Promise((onMessage, onError) => {
+                  yield await new Promise((resolve2, reject2) => {
                     iteratorState.set(iteratorKey, {
                       __hasPolled: true,
-                      onError,
-                      onMessage
+                      onError: reject2,
+                      onMessage: resolve2
                     });
                   });
                 } catch (e3) {
-                  if (e3 !== null && typeof e3 === "object" && "type" in e3 && e3.type === "close" && "wasClean" in e3 && e3.wasClean) {
+                  if (e3 === EXPLICIT_ABORT_TOKEN) {
                     return;
@@ -301,11 +487,27 @@ } else {
 // src/transports/websocket/websocket-transport.ts
-function createWebSocketTransport({ url }) {
-  return async function({ signal }) {
-    signal.throwIfAborted();
-    return await createWebSocketConnection({ signal, url });
+function createWebSocketTransport({ sendBufferHighWatermark, url }) {
+  if (/^wss?:/i.test(url) === false) {
+    const protocolMatch = url.match(/^([^:]+):/);
+    throw new DOMException(
+      protocolMatch ? `Failed to construct 'WebSocket': The URL's scheme must be either 'ws' or 'wss'. '${protocolMatch[1]}:' is not allowed.` : `Failed to construct 'WebSocket': The URL '${url}' is invalid.`
+    );
+  }
+  return async function sendWebSocketMessage({ payload, signal }) {
+    signal?.throwIfAborted();
+    const connection = await createWebSocketConnection({
+      sendBufferHighWatermark,
+      signal,
+      url
+    });
+    signal?.throwIfAborted();
+    await connection.send(payload);
+    return {
+      [Symbol.asyncIterator]: connection[Symbol.asyncIterator].bind(connection),
+      send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: connection.send.bind(connection)
+    };
   };
 }
 
-export { createHttpTransport, createJsonRpc, createWebSocketTransport };
+export { createHttpTransport, createJsonRpc, createJsonRpcApi, createJsonRpcSubscriptionsApi, createJsonSubscriptionRpc, createWebSocketTransport };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.browser.js.map

dist/index.native.js

 // ../build-scripts/env-shim.ts
 var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 
+// src/apis/methods/methods-api.ts
+function createJsonRpcApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const methodName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, methodName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        return {
+          methodName,
+          params,
+          responseTransformer
+        };
+      };
+    }
+  });
+}
+
+// src/apis/subscriptions/subscriptions-api.ts
+function createJsonRpcSubscriptionsApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const notificationName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, notificationName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        const subscribeMethodName = config?.subscribeNotificationNameTransformer ? config?.subscribeNotificationNameTransformer(notificationName) : notificationName;
+        const unsubscribeMethodName = config?.unsubscribeNotificationNameTransformer ? config?.unsubscribeNotificationNameTransformer(notificationName) : notificationName;
+        return {
+          params,
+          responseTransformer,
+          subscribeMethodName,
+          unsubscribeMethodName
+        };
+      };
+    }
+  });
+}
+
 // src/json-rpc-errors.ts
 var SolanaJsonRpcError = class extends Error {
+  code;
+  data;
   constructor(details) {
@@ -39,3 +94,3 @@ super(`JSON-RPC 2.0 error (${details.code}): ${details.message}`);
     async send(options) {
-      const { methodName, params, responseProcessor } = pendingRequest;
+      const { methodName, params, responseTransformer } = pendingRequest;
       const payload = createJsonRpcMessage(methodName, params);
@@ -49,3 +104,3 @@ const response = await rpcConfig.transport({
       } else {
-        return responseProcessor ? responseProcessor(response.result) : response.result;
+        return responseTransformer ? responseTransformer(response.result, methodName) : response.result;
       }
@@ -77,2 +132,98 @@ }
 
+// src/json-rpc-subscription.ts
+function registerIterableCleanup(iterable, cleanupFn) {
+  (async () => {
+    try {
+      for await (const _ of iterable)
+        ;
+    } catch {
+    } finally {
+      cleanupFn();
+    }
+  })();
+}
+function createPendingRpcSubscription(rpcConfig, { params, subscribeMethodName, unsubscribeMethodName, responseTransformer }) {
+  return {
+    async subscribe({ abortSignal }) {
+      abortSignal.throwIfAborted();
+      let subscriptionId;
+      function handleCleanup() {
+        if (subscriptionId !== void 0) {
+          const payload = createJsonRpcMessage(unsubscribeMethodName, [subscriptionId]);
+          connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(payload).finally(() => {
+            connectionAbortController.abort();
+          });
+        } else {
+          connectionAbortController.abort();
+        }
+      }
+      abortSignal.addEventListener("abort", handleCleanup);
+      const connectionAbortController = new AbortController();
+      const subscribeMessage = createJsonRpcMessage(subscribeMethodName, params);
+      const connection = await rpcConfig.transport({
+        payload: subscribeMessage,
+        signal: connectionAbortController.signal
+      });
+      function handleConnectionCleanup() {
+        abortSignal.removeEventListener("abort", handleCleanup);
+      }
+      registerIterableCleanup(connection, handleConnectionCleanup);
+      for await (const message of connection) {
+        if ("id" in message && message.id === subscribeMessage.id) {
+          if ("error" in message) {
+            throw new SolanaJsonRpcError(message.error);
+          } else {
+            subscriptionId = message.result;
+            break;
+          }
+        }
+      }
+      if (subscriptionId == null) {
+        throw new Error("Failed to obtain a subscription id from the server");
+      }
+      return {
+        async *[Symbol.asyncIterator]() {
+          for await (const message of connection) {
+            if (!("params" in message) || message.params.subscription !== subscriptionId) {
+              continue;
+            }
+            const notification = message.params.result;
+            yield responseTransformer ? responseTransformer(notification, subscribeMethodName) : notification;
+          }
+        }
+      };
+    }
+  };
+}
+function makeProxy2(rpcConfig) {
+  return new Proxy(rpcConfig.api, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(target, p, receiver) {
+      return function(...rawParams) {
+        const methodName = p.toString();
+        const createRpcSubscription = Reflect.get(target, methodName, receiver);
+        if (p.toString().endsWith("Notifications") === false && !createRpcSubscription) {
+          throw new Error(
+            "Either the notification name must end in 'Notifications' or the API must supply a subscription creator function to map between the notification name and the subscribe/unsubscribe method names."
+          );
+        }
+        const newRequest = createRpcSubscription ? createRpcSubscription(...rawParams) : {
+          params: rawParams,
+          subscribeMethodName: methodName.replace(/Notifications$/, "Subscribe"),
+          unsubscribeMethodName: methodName.replace(/Notifications$/, "Unsubscribe")
+        };
+        return createPendingRpcSubscription(rpcConfig, newRequest);
+      };
+    }
+  });
+}
+function createJsonSubscriptionRpc(rpcConfig) {
+  return makeProxy2(rpcConfig);
+}
+
 // ../fetch-impl/dist/index.browser.js
@@ -83,2 +234,3 @@ var e = globalThis.fetch;
 var SolanaHttpError = class extends Error {
+  statusCode;
   constructor(details) {
@@ -145,12 +297,6 @@ super(`HTTP error (${details.statusCode}): ${details.message}`);
 // src/transports/http/http-transport.ts
-function createHttpTransport({ httpAgentNodeOnly, headers, url }) {
+function createHttpTransport({ headers, url }) {
   if (__DEV__ && headers) {
     assertIsAllowedHttpRequestHeaders(headers);
   }
-  const agent = void 0;
-  if (__DEV__ && httpAgentNodeOnly != null) {
-    console.warn(
-      "createHttpTransport(): The `httpAgentNodeOnly` config you supplied has been ignored; HTTP agents are only usable in Node environments."
-    );
-  }
   const customHeaders = headers && normalizeHeaders(headers);
@@ -163,3 +309,2 @@ return async function makeHttpRequest({
     const requestInfo = {
-      agent,
       body,
@@ -191,7 +336,25 @@ headers: {
 // src/transports/websocket/websocket-connection.ts
-async function createWebSocketConnection({ signal, url }) {
+var EXPLICIT_ABORT_TOKEN = Symbol(
+  __DEV__ ? "This symbol is thrown from a socket's iterator when the connection is explicitly aborted by the user" : void 0
+);
+async function createWebSocketConnection({
+  sendBufferHighWatermark,
+  signal,
+  url
+}) {
   return new Promise((resolve, reject) => {
     signal.addEventListener("abort", handleAbort, { once: true });
     const iteratorState = /* @__PURE__ */ new Map();
+    function errorAndClearAllIteratorStates(reason) {
+      const errorCallbacks = [...iteratorState.values()].filter((state) => state.__hasPolled).map(({ onError }) => onError);
+      iteratorState.clear();
+      errorCallbacks.forEach((cb) => {
+        try {
+          cb(reason);
+        } catch {
+        }
+      });
+    }
     function handleAbort() {
+      errorAndClearAllIteratorStates(EXPLICIT_ABORT_TOKEN);
       if (webSocket.readyState !== e2.CLOSED && webSocket.readyState !== e2.CLOSING) {
@@ -202,2 +365,3 @@ webSocket.close(1e3);
     function handleClose(ev) {
+      bufferDrainWatcher?.onCancel();
       signal.removeEventListener("abort", handleAbort);
@@ -208,11 +372,3 @@ webSocket.removeEventListener("close", handleClose);
       webSocket.removeEventListener("message", handleMessage);
-      iteratorState.forEach((state, iteratorKey) => {
-        if (state.__hasPolled) {
-          const { onError } = state;
-          iteratorState.delete(iteratorKey);
-          onError(ev);
-        } else {
-          iteratorState.delete(iteratorKey);
-        }
-      });
+      errorAndClearAllIteratorStates(ev);
     }
@@ -228,2 +384,3 @@ function handleError(ev) {
     let hasConnected = false;
+    let bufferDrainWatcher;
     function handleOpen() {
@@ -234,2 +391,31 @@ hasConnected = true;
           const message = JSON.stringify(payload);
+          if (!bufferDrainWatcher && webSocket.readyState === e2.OPEN && webSocket.bufferedAmount > sendBufferHighWatermark) {
+            let onCancel;
+            const promise = new Promise((resolve2, reject2) => {
+              const intervalId = setInterval(() => {
+                if (webSocket.readyState !== e2.OPEN || !(webSocket.bufferedAmount > sendBufferHighWatermark)) {
+                  clearInterval(intervalId);
+                  bufferDrainWatcher = void 0;
+                  resolve2();
+                }
+              }, 16);
+              onCancel = () => {
+                bufferDrainWatcher = void 0;
+                clearInterval(intervalId);
+                reject2(
+                  // TODO: Coded error
+                  new Error("WebSocket was closed before payload could be sent")
+                );
+              };
+            });
+            bufferDrainWatcher = {
+              // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+              // @ts-ignore
+              onCancel,
+              promise
+            };
+          }
+          if (bufferDrainWatcher) {
+            await bufferDrainWatcher.promise;
+          }
           webSocket.send(message);
@@ -257,11 +443,11 @@ },
                 try {
-                  yield await new Promise((onMessage, onError) => {
+                  yield await new Promise((resolve2, reject2) => {
                     iteratorState.set(iteratorKey, {
                       __hasPolled: true,
-                      onError,
-                      onMessage
+                      onError: reject2,
+                      onMessage: resolve2
                     });
                   });
                 } catch (e3) {
-                  if (e3 !== null && typeof e3 === "object" && "type" in e3 && e3.type === "close" && "wasClean" in e3 && e3.wasClean) {
+                  if (e3 === EXPLICIT_ABORT_TOKEN) {
                     return;
@@ -301,11 +487,27 @@ } else {
 // src/transports/websocket/websocket-transport.ts
-function createWebSocketTransport({ url }) {
-  return async function({ signal }) {
-    signal.throwIfAborted();
-    return await createWebSocketConnection({ signal, url });
+function createWebSocketTransport({ sendBufferHighWatermark, url }) {
+  if (/^wss?:/i.test(url) === false) {
+    const protocolMatch = url.match(/^([^:]+):/);
+    throw new DOMException(
+      protocolMatch ? `Failed to construct 'WebSocket': The URL's scheme must be either 'ws' or 'wss'. '${protocolMatch[1]}:' is not allowed.` : `Failed to construct 'WebSocket': The URL '${url}' is invalid.`
+    );
+  }
+  return async function sendWebSocketMessage({ payload, signal }) {
+    signal?.throwIfAborted();
+    const connection = await createWebSocketConnection({
+      sendBufferHighWatermark,
+      signal,
+      url
+    });
+    signal?.throwIfAborted();
+    await connection.send(payload);
+    return {
+      [Symbol.asyncIterator]: connection[Symbol.asyncIterator].bind(connection),
+      send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: connection.send.bind(connection)
+    };
   };
 }
 
-export { createHttpTransport, createJsonRpc, createWebSocketTransport };
+export { createHttpTransport, createJsonRpc, createJsonRpcApi, createJsonRpcSubscriptionsApi, createJsonSubscriptionRpc, createWebSocketTransport };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.native.js.map

dist/index.node.js

@@ -1,3 +0,2 @@
-import t from 'node-fetch';
-import e from 'ws';
+import e2 from 'ws';
 
@@ -7,4 +6,59 @@ // ../build-scripts/env-shim.ts
 
+// src/apis/methods/methods-api.ts
+function createJsonRpcApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const methodName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, methodName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        return {
+          methodName,
+          params,
+          responseTransformer
+        };
+      };
+    }
+  });
+}
+
+// src/apis/subscriptions/subscriptions-api.ts
+function createJsonRpcSubscriptionsApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const notificationName = p.toString();
+      return function(...rawParams) {
+        const params = config?.parametersTransformer ? config?.parametersTransformer(rawParams, notificationName) : rawParams;
+        const responseTransformer = config?.responseTransformer ? config?.responseTransformer : (rawResponse) => rawResponse;
+        const subscribeMethodName = config?.subscribeNotificationNameTransformer ? config?.subscribeNotificationNameTransformer(notificationName) : notificationName;
+        const unsubscribeMethodName = config?.unsubscribeNotificationNameTransformer ? config?.unsubscribeNotificationNameTransformer(notificationName) : notificationName;
+        return {
+          params,
+          responseTransformer,
+          subscribeMethodName,
+          unsubscribeMethodName
+        };
+      };
+    }
+  });
+}
+
 // src/json-rpc-errors.ts
 var SolanaJsonRpcError = class extends Error {
+  code;
+  data;
   constructor(details) {
@@ -43,3 +97,3 @@ super(`JSON-RPC 2.0 error (${details.code}): ${details.message}`);
     async send(options) {
-      const { methodName, params, responseProcessor } = pendingRequest;
+      const { methodName, params, responseTransformer } = pendingRequest;
       const payload = createJsonRpcMessage(methodName, params);
@@ -53,3 +107,3 @@ const response = await rpcConfig.transport({
       } else {
-        return responseProcessor ? responseProcessor(response.result) : response.result;
+        return responseTransformer ? responseTransformer(response.result, methodName) : response.result;
       }
@@ -80,6 +134,105 @@ }
 }
-var o = typeof globalThis.fetch == "function" ? globalThis.fetch : t;
 
+// src/json-rpc-subscription.ts
+function registerIterableCleanup(iterable, cleanupFn) {
+  (async () => {
+    try {
+      for await (const _ of iterable)
+        ;
+    } catch {
+    } finally {
+      cleanupFn();
+    }
+  })();
+}
+function createPendingRpcSubscription(rpcConfig, { params, subscribeMethodName, unsubscribeMethodName, responseTransformer }) {
+  return {
+    async subscribe({ abortSignal }) {
+      abortSignal.throwIfAborted();
+      let subscriptionId;
+      function handleCleanup() {
+        if (subscriptionId !== void 0) {
+          const payload = createJsonRpcMessage(unsubscribeMethodName, [subscriptionId]);
+          connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(payload).finally(() => {
+            connectionAbortController.abort();
+          });
+        } else {
+          connectionAbortController.abort();
+        }
+      }
+      abortSignal.addEventListener("abort", handleCleanup);
+      const connectionAbortController = new AbortController();
+      const subscribeMessage = createJsonRpcMessage(subscribeMethodName, params);
+      const connection = await rpcConfig.transport({
+        payload: subscribeMessage,
+        signal: connectionAbortController.signal
+      });
+      function handleConnectionCleanup() {
+        abortSignal.removeEventListener("abort", handleCleanup);
+      }
+      registerIterableCleanup(connection, handleConnectionCleanup);
+      for await (const message of connection) {
+        if ("id" in message && message.id === subscribeMessage.id) {
+          if ("error" in message) {
+            throw new SolanaJsonRpcError(message.error);
+          } else {
+            subscriptionId = message.result;
+            break;
+          }
+        }
+      }
+      if (subscriptionId == null) {
+        throw new Error("Failed to obtain a subscription id from the server");
+      }
+      return {
+        async *[Symbol.asyncIterator]() {
+          for await (const message of connection) {
+            if (!("params" in message) || message.params.subscription !== subscriptionId) {
+              continue;
+            }
+            const notification = message.params.result;
+            yield responseTransformer ? responseTransformer(notification, subscribeMethodName) : notification;
+          }
+        }
+      };
+    }
+  };
+}
+function makeProxy2(rpcConfig) {
+  return new Proxy(rpcConfig.api, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(target, p, receiver) {
+      return function(...rawParams) {
+        const methodName = p.toString();
+        const createRpcSubscription = Reflect.get(target, methodName, receiver);
+        if (p.toString().endsWith("Notifications") === false && !createRpcSubscription) {
+          throw new Error(
+            "Either the notification name must end in 'Notifications' or the API must supply a subscription creator function to map between the notification name and the subscribe/unsubscribe method names."
+          );
+        }
+        const newRequest = createRpcSubscription ? createRpcSubscription(...rawParams) : {
+          params: rawParams,
+          subscribeMethodName: methodName.replace(/Notifications$/, "Subscribe"),
+          unsubscribeMethodName: methodName.replace(/Notifications$/, "Unsubscribe")
+        };
+        return createPendingRpcSubscription(rpcConfig, newRequest);
+      };
+    }
+  });
+}
+function createJsonSubscriptionRpc(rpcConfig) {
+  return makeProxy2(rpcConfig);
+}
+
+// ../fetch-impl/dist/index.node.js
+var e = globalThis.fetch;
+
 // src/transports/http/http-transport-errors.ts
 var SolanaHttpError = class extends Error {
+  statusCode;
   constructor(details) {
@@ -146,12 +299,6 @@ super(`HTTP error (${details.statusCode}): ${details.message}`);
 // src/transports/http/http-transport.ts
-function createHttpTransport({ httpAgentNodeOnly, headers, url }) {
+function createHttpTransport({ headers, url }) {
   if (__DEV__ && headers) {
     assertIsAllowedHttpRequestHeaders(headers);
   }
-  const agent = httpAgentNodeOnly ;
-  if (__DEV__ && httpAgentNodeOnly != null) {
-    console.warn(
-      "createHttpTransport(): The `httpAgentNodeOnly` config you supplied has been ignored; HTTP agents are only usable in Node environments."
-    );
-  }
   const customHeaders = headers && normalizeHeaders(headers);
@@ -164,3 +311,2 @@ return async function makeHttpRequest({
     const requestInfo = {
-      agent,
       body,
@@ -177,3 +323,3 @@ headers: {
     };
-    const response = await o(url, requestInfo);
+    const response = await e(url, requestInfo);
     if (!response.ok) {
@@ -188,11 +334,29 @@ throw new SolanaHttpError({
 }
-var t2 = e;
+var t = e2;
 
 // src/transports/websocket/websocket-connection.ts
-async function createWebSocketConnection({ signal, url }) {
+var EXPLICIT_ABORT_TOKEN = Symbol(
+  __DEV__ ? "This symbol is thrown from a socket's iterator when the connection is explicitly aborted by the user" : void 0
+);
+async function createWebSocketConnection({
+  sendBufferHighWatermark,
+  signal,
+  url
+}) {
   return new Promise((resolve, reject) => {
     signal.addEventListener("abort", handleAbort, { once: true });
     const iteratorState = /* @__PURE__ */ new Map();
+    function errorAndClearAllIteratorStates(reason) {
+      const errorCallbacks = [...iteratorState.values()].filter((state) => state.__hasPolled).map(({ onError }) => onError);
+      iteratorState.clear();
+      errorCallbacks.forEach((cb) => {
+        try {
+          cb(reason);
+        } catch {
+        }
+      });
+    }
     function handleAbort() {
-      if (webSocket.readyState !== t2.CLOSED && webSocket.readyState !== t2.CLOSING) {
+      errorAndClearAllIteratorStates(EXPLICIT_ABORT_TOKEN);
+      if (webSocket.readyState !== t.CLOSED && webSocket.readyState !== t.CLOSING) {
         webSocket.close(1e3);
@@ -202,2 +366,3 @@ }
     function handleClose(ev) {
+      bufferDrainWatcher?.onCancel();
       signal.removeEventListener("abort", handleAbort);
@@ -208,11 +373,3 @@ webSocket.removeEventListener("close", handleClose);
       webSocket.removeEventListener("message", handleMessage);
-      iteratorState.forEach((state, iteratorKey) => {
-        if (state.__hasPolled) {
-          const { onError } = state;
-          iteratorState.delete(iteratorKey);
-          onError(ev);
-        } else {
-          iteratorState.delete(iteratorKey);
-        }
-      });
+      errorAndClearAllIteratorStates(ev);
     }
@@ -228,2 +385,3 @@ function handleError(ev) {
     let hasConnected = false;
+    let bufferDrainWatcher;
     function handleOpen() {
@@ -234,2 +392,31 @@ hasConnected = true;
           const message = JSON.stringify(payload);
+          if (!bufferDrainWatcher && webSocket.readyState === t.OPEN && webSocket.bufferedAmount > sendBufferHighWatermark) {
+            let onCancel;
+            const promise = new Promise((resolve2, reject2) => {
+              const intervalId = setInterval(() => {
+                if (webSocket.readyState !== t.OPEN || !(webSocket.bufferedAmount > sendBufferHighWatermark)) {
+                  clearInterval(intervalId);
+                  bufferDrainWatcher = void 0;
+                  resolve2();
+                }
+              }, 16);
+              onCancel = () => {
+                bufferDrainWatcher = void 0;
+                clearInterval(intervalId);
+                reject2(
+                  // TODO: Coded error
+                  new Error("WebSocket was closed before payload could be sent")
+                );
+              };
+            });
+            bufferDrainWatcher = {
+              // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+              // @ts-ignore
+              onCancel,
+              promise
+            };
+          }
+          if (bufferDrainWatcher) {
+            await bufferDrainWatcher.promise;
+          }
           webSocket.send(message);
@@ -257,14 +444,14 @@ },
                 try {
-                  yield await new Promise((onMessage, onError) => {
+                  yield await new Promise((resolve2, reject2) => {
                     iteratorState.set(iteratorKey, {
                       __hasPolled: true,
-                      onError,
-                      onMessage
+                      onError: reject2,
+                      onMessage: resolve2
                     });
                   });
-                } catch (e2) {
-                  if (e2 !== null && typeof e2 === "object" && "type" in e2 && e2.type === "close" && "wasClean" in e2 && e2.wasClean) {
+                } catch (e3) {
+                  if (e3 === EXPLICIT_ABORT_TOKEN) {
                     return;
                   } else {
-                    throw new Error("WebSocket connection closed", { cause: e2 });
+                    throw new Error("WebSocket connection closed", { cause: e3 });
                   }
@@ -292,3 +479,3 @@ }
     }
-    const webSocket = new t2(url);
+    const webSocket = new t(url);
     webSocket.addEventListener("close", handleClose);
@@ -302,11 +489,27 @@ webSocket.addEventListener("error", handleError);
 // src/transports/websocket/websocket-transport.ts
-function createWebSocketTransport({ url }) {
-  return async function({ signal }) {
-    signal.throwIfAborted();
-    return await createWebSocketConnection({ signal, url });
+function createWebSocketTransport({ sendBufferHighWatermark, url }) {
+  if (/^wss?:/i.test(url) === false) {
+    const protocolMatch = url.match(/^([^:]+):/);
+    throw new DOMException(
+      protocolMatch ? `Failed to construct 'WebSocket': The URL's scheme must be either 'ws' or 'wss'. '${protocolMatch[1]}:' is not allowed.` : `Failed to construct 'WebSocket': The URL '${url}' is invalid.`
+    );
+  }
+  return async function sendWebSocketMessage({ payload, signal }) {
+    signal?.throwIfAborted();
+    const connection = await createWebSocketConnection({
+      sendBufferHighWatermark,
+      signal,
+      url
+    });
+    signal?.throwIfAborted();
+    await connection.send(payload);
+    return {
+      [Symbol.asyncIterator]: connection[Symbol.asyncIterator].bind(connection),
+      send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: connection.send.bind(connection)
+    };
   };
 }
 
-export { createHttpTransport, createJsonRpc, createWebSocketTransport };
+export { createHttpTransport, createJsonRpc, createJsonRpcApi, createJsonRpcSubscriptionsApi, createJsonSubscriptionRpc, createWebSocketTransport };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.node.js.map

dist/types/index.d.ts

@@ -1,4 +0,10 @@
-export * from './json-rpc';
-export * from './transports/http/http-transport';
-export * from './transports/websocket/websocket-transport';
+export * from './apis/api-types.js';
+export * from './apis/methods/methods-api.js';
+export * from './apis/subscriptions/subscriptions-api.js';
+export * from './json-rpc.js';
+export type { SolanaJsonRpcErrorCode } from './json-rpc-errors.js';
+export * from './json-rpc-subscription.js';
+export * from './transports/http/http-transport.js';
+export type { IRpcTransport, IRpcWebSocketTransport } from './transports/transport-types.js';
+export * from './transports/websocket/websocket-transport.js';
 //# sourceMappingURL=index.d.ts.map

dist/types/json-rpc.d.ts

@@ -1,3 +0,17 @@
-import { Rpc, RpcConfig } from './json-rpc-types';
+import { Rpc } from '@solana/rpc-types';
+import { RpcConfig } from './json-rpc-config.js';
+interface IHasIdentifier {
+    readonly id: number;
+}
+export type JsonRpcResponse<TResponse> = IHasIdentifier & Readonly<{
+    result: TResponse;
+} | {
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+}>;
 export declare function createJsonRpc<TRpcMethods>(rpcConfig: RpcConfig<TRpcMethods>): Rpc<TRpcMethods>;
+export {};
 //# sourceMappingURL=json-rpc.d.ts.map

dist/types/transports/http/http-transport.d.ts

@@ -1,14 +0,9 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { Agent as NodeHttpAgent } from 'node:http';
-import type { Agent as NodeHttpsAgent } from 'node:https';
-import { IRpcTransport } from '../transport-types';
-import { AllowedHttpRequestHeaders } from './http-transport-headers';
+import { IRpcTransport } from '../transport-types.js';
+import { AllowedHttpRequestHeaders } from './http-transport-headers.js';
 type Config = Readonly<{
     headers?: AllowedHttpRequestHeaders;
-    httpAgentNodeOnly?: NodeHttpAgent | NodeHttpsAgent | ((parsedUrl: URL) => NodeHttpAgent | NodeHttpsAgent);
     url: string;
 }>;
-export declare function createHttpTransport({ httpAgentNodeOnly, headers, url }: Config): IRpcTransport;
+export declare function createHttpTransport({ headers, url }: Config): IRpcTransport;
 export {};
 //# sourceMappingURL=http-transport.d.ts.map

dist/types/transports/transport-types.d.ts

@@ -1,2 +0,2 @@
-import { RpcWebSocketConnection } from './websocket/websocket-connection';
+import { RpcWebSocketConnection } from './websocket/websocket-connection.js';
 type RpcTransportConfig = Readonly<{
@@ -10,8 +10,11 @@ payload: unknown;
 type RpcWebSocketTransportConfig = Readonly<{
+    payload: unknown;
     signal: AbortSignal;
 }>;
 export interface IRpcWebSocketTransport {
-    (config: RpcWebSocketTransportConfig): Promise<RpcWebSocketConnection>;
+    (config: RpcWebSocketTransportConfig): Promise<Readonly<Omit<RpcWebSocketConnection, 'send'> & {
+        send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: RpcWebSocketConnection['send'];
+    }>>;
 }
 export {};
 //# sourceMappingURL=transport-types.d.ts.map

dist/types/transports/websocket/websocket-connection.d.ts

 type Config = Readonly<{
+    sendBufferHighWatermark: number;
     signal: AbortSignal;
@@ -9,4 +10,4 @@ url: string;
 }>;
-export declare function createWebSocketConnection({ signal, url }: Config): Promise<RpcWebSocketConnection>;
+export declare function createWebSocketConnection({ sendBufferHighWatermark, signal, url, }: Config): Promise<RpcWebSocketConnection>;
 export {};
 //# sourceMappingURL=websocket-connection.d.ts.map

dist/types/transports/websocket/websocket-transport.d.ts

@@ -1,7 +0,8 @@
-import { IRpcWebSocketTransport } from '../transport-types';
+import { IRpcWebSocketTransport } from '../transport-types.js';
 type Config = Readonly<{
+    sendBufferHighWatermark: number;
     url: string;
 }>;
-export declare function createWebSocketTransport({ url }: Config): IRpcWebSocketTransport;
+export declare function createWebSocketTransport({ sendBufferHighWatermark, url }: Config): IRpcWebSocketTransport;
 export {};
 //# sourceMappingURL=websocket-transport.d.ts.map

package.json

 {
   "name": "@solana/rpc-transport",
-  "version": "2.0.0-experimental.11d7d74",
+  "version": "2.0.0-experimental.11dd48f",
   "description": "Network transports for accessing the Solana JSON RPC API",
@@ -48,22 +48,26 @@ "exports": {
   ],
+  "dependencies": {
+    "@solana/rpc-types": "2.0.0-experimental.11dd48f"
+  },
   "devDependencies": {
     "@solana/eslint-config-solana": "^1.0.2",
-    "@swc/jest": "^0.2.28",
-    "@types/jest": "^29.5.3",
-    "@types/node": "^20",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@swc/jest": "^0.2.29",
+    "@types/jest": "^29.5.11",
+    "@types/node": "18.11.19",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
     "@typescript-eslint/parser": "^6.3.0",
     "agadoo": "^3.0.0",
     "eslint": "^8.45.0",
-    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-jest": "^27.4.2",
     "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "jest": "^29.6.1",
-    "jest-environment-jsdom": "^29.6.4",
+    "fast-stable-stringify": "^1.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "jest-fetch-mock-fork": "^3.0.4",
-    "jest-runner-eslint": "^2.1.0",
+    "jest-runner-eslint": "^2.1.2",
     "jest-runner-prettier": "^1.0.0",
-    "jest-websocket-mock": "^2.4.1",
-    "prettier": "^2.8",
-    "tsup": "7.2.0",
-    "typescript": "^5.1.6",
+    "jest-websocket-mock": "^2.5.0",
+    "prettier": "^3.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.2.2",
     "version-from-git": "^1.1.1",
@@ -76,2 +80,5 @@ "build-scripts": "0.0.0",
   },
+  "peerDependencies": {
+    "ws": "^8.14.0"
+  },
   "bundlewatch": {
@@ -87,10 +94,11 @@ "defaultCompression": "gzip",
     "compile:js": "tsup --config build-scripts/tsup.config.package.ts",
-    "compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json && node node_modules/build-scripts/add-js-extension-to-types.mjs",
     "dev": "jest -c node_modules/test-config/jest-dev.config.ts --rootDir . --watch",
     "publish-packages": "pnpm publish --tag experimental --access public --no-git-checks",
+    "style:fix": "pnpm eslint --fix src/* && pnpm prettier -w src/* package.json",
     "test:lint": "jest -c node_modules/test-config/jest-lint.config.ts --rootDir . --silent",
     "test:prettier": "jest -c node_modules/test-config/jest-prettier.config.ts --rootDir . --silent",
     "test:treeshakability:browser": "agadoo dist/index.browser.js",
-    "test:treeshakability:native": "agadoo dist/index.node.js",
-    "test:treeshakability:node": "agadoo dist/index.native.js",
+    "test:treeshakability:native": "agadoo dist/index.native.js",
+    "test:treeshakability:node": "agadoo dist/index.node.js",
     "test:typecheck": "tsc --noEmit",
@@ -97,0 +105,0 @@ "test:unit:browser": "jest -c node_modules/test-config/jest-unit.config.browser.ts --rootDir . --silent",

README.md

@@ -58,3 +58,3 @@ [![npm][npm-image]][npm-url]
             // Provide an optional function to modify the response.
-            responseProcessor: response => ({
+            responseTransformer: response => ({
                 confirmedBlocks: response,
@@ -61,0 +61,0 @@ queryRange: [startSlot, endSlot],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

330507

increased by57.6%

Number of package files

46

increased by21.05%

Lines of code

3090

increased by54.96%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

26

increased by4%

Dependency changes

• + Added@solana/rpc-types@2.0.0-experimental.11dd48f

• + Added@solana/codecs-core@2.0.0-experimental.11dd48f(transitive)

• + Added@solana/codecs-numbers@2.0.0-experimental.11dd48f(transitive)

• + Added@solana/codecs-strings@2.0.0-experimental.11dd48f(transitive)

• + Added@solana/rpc-types@2.0.0-experimental.11dd48f(transitive)

• + Addedfastestsmallesttextencoderdecoder@1.0.22(transitive)

• + Addedws@8.18.0(transitive)