@solana/rpc-subscriptions-spec 2.0.0-20241006045741

package/dist/index.node.mjs

@@ -0,0 +1,228 @@
+import { SolanaError, SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN, getSolanaErrorFromJsonRpcError, SOLANA_ERROR__RPC_SUBSCRIPTIONS__EXPECTED_SERVER_SUBSCRIPTION_ID, SOLANA_ERROR__INVARIANT_VIOLATION__DATA_PUBLISHER_CHANNEL_UNIMPLEMENTED } from '@solana/errors';
+import { createAsyncIterableFromDataPublisher, demultiplexDataPublisher } from '@solana/subscribable';
+import { safeRace } from '@solana/promises';
+import { createRpcMessage } from '@solana/rpc-spec-types';
+
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return new Proxy(rpcConfig.api, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(target, p, receiver) {
+      return function(...rawParams) {
+        const notificationName = p.toString();
+        const createRpcSubscriptionPlan = Reflect.get(target, notificationName, receiver);
+        if (!createRpcSubscriptionPlan) {
+          throw new SolanaError(SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN, {
+            notificationName
+          });
+        }
+        const subscriptionPlan = createRpcSubscriptionPlan(...rawParams);
+        return createPendingRpcSubscription(rpcConfig.transport, subscriptionPlan);
+      };
+    }
+  });
+}
+function createPendingRpcSubscription(transport, subscriptionsPlan) {
+  return {
+    async subscribe({ abortSignal }) {
+      const notificationsDataPublisher = await transport({
+        signal: abortSignal,
+        ...subscriptionsPlan
+      });
+      return createAsyncIterableFromDataPublisher({
+        abortSignal,
+        dataChannelName: "notification",
+        dataPublisher: notificationsDataPublisher,
+        errorChannelName: "error"
+      });
+    }
+  };
+}
+
+// src/rpc-subscriptions-api.ts
+var UNINITIALIZED = Symbol();
+function createRpcSubscriptionsApi(config) {
+  return new Proxy({}, {
+    defineProperty() {
+      return false;
+    },
+    deleteProperty() {
+      return false;
+    },
+    get(...args) {
+      const [_, p] = args;
+      const notificationName = p.toString();
+      return function(...params) {
+        let _cachedSubscriptionHash = UNINITIALIZED;
+        return {
+          executeSubscriptionPlan(planConfig) {
+            return config.planExecutor({
+              ...planConfig,
+              notificationName,
+              params
+            });
+          },
+          get subscriptionConfigurationHash() {
+            if (_cachedSubscriptionHash === UNINITIALIZED) {
+              _cachedSubscriptionHash = config?.getSubscriptionConfigurationHash?.({
+                notificationName,
+                params
+              });
+            }
+            return _cachedSubscriptionHash;
+          }
+        };
+      };
+    }
+  });
+}
+var subscriberCountBySubscriptionIdByChannel = /* @__PURE__ */ new WeakMap();
+function decrementSubscriberCountAndReturnNewCount(channel, subscriptionId) {
+  return augmentSubscriberCountAndReturnNewCount(-1, channel, subscriptionId);
+}
+function incrementSubscriberCount(channel, subscriptionId) {
+  augmentSubscriberCountAndReturnNewCount(1, channel, subscriptionId);
+}
+function augmentSubscriberCountAndReturnNewCount(amount, channel, subscriptionId) {
+  if (subscriptionId === void 0) {
+    return;
+  }
+  let subscriberCountBySubscriptionId = subscriberCountBySubscriptionIdByChannel.get(channel);
+  if (!subscriberCountBySubscriptionId && amount > 0) {
+    subscriberCountBySubscriptionIdByChannel.set(
+      channel,
+      subscriberCountBySubscriptionId = { [subscriptionId]: 0 }
+    );
+  }
+  if (subscriberCountBySubscriptionId[subscriptionId] !== void 0) {
+    return subscriberCountBySubscriptionId[subscriptionId] = amount + subscriberCountBySubscriptionId[subscriptionId];
+  }
+}
+var cache = /* @__PURE__ */ new WeakMap();
+function getMemoizedDemultiplexedNotificationPublisherFromChannelAndResponseTransformer(channel, responseTransformer) {
+  let publisherByResponseTransformer = cache.get(channel);
+  if (!publisherByResponseTransformer) {
+    cache.set(channel, publisherByResponseTransformer = /* @__PURE__ */ new WeakMap());
+  }
+  const responseTransformerKey = responseTransformer ?? channel;
+  let publisher = publisherByResponseTransformer.get(responseTransformerKey);
+  if (!publisher) {
+    publisherByResponseTransformer.set(
+      responseTransformerKey,
+      publisher = demultiplexDataPublisher(channel, "message", (rawMessage) => {
+        const message = rawMessage;
+        if (!("method" in message)) {
+          return;
+        }
+        const transformedNotification = responseTransformer ? responseTransformer(message.params.result, message.method) : message.params.result;
+        return [`notification:${message.params.subscription}`, transformedNotification];
+      })
+    );
+  }
+  return publisher;
+}
+async function executeRpcPubSubSubscriptionPlan({
+  channel,
+  responseTransformer,
+  signal,
+  subscribeMethodName,
+  subscribeParams,
+  unsubscribeMethodName
+}) {
+  let subscriptionId;
+  channel.on(
+    "error",
+    () => {
+      subscriptionId = void 0;
+      subscriberCountBySubscriptionIdByChannel.delete(channel);
+    },
+    { signal }
+  );
+  const abortPromise = new Promise((_, reject) => {
+    function handleAbort() {
+      if (decrementSubscriberCountAndReturnNewCount(channel, subscriptionId) === 0) {
+        const unsubscribePayload = createRpcMessage(unsubscribeMethodName, [subscriptionId]);
+        subscriptionId = void 0;
+        channel.send(unsubscribePayload).catch(() => {
+        });
+      }
+      reject(this.reason);
+    }
+    if (signal.aborted) {
+      handleAbort.call(signal);
+    } else {
+      signal.addEventListener("abort", handleAbort);
+    }
+  });
+  const subscribePayload = createRpcMessage(subscribeMethodName, subscribeParams);
+  await channel.send(subscribePayload);
+  const subscriptionIdPromise = new Promise((resolve, reject) => {
+    const abortController = new AbortController();
+    signal.addEventListener("abort", abortController.abort.bind(abortController));
+    const options = { signal: abortController.signal };
+    channel.on(
+      "error",
+      (err) => {
+        abortController.abort();
+        reject(err);
+      },
+      options
+    );
+    channel.on(
+      "message",
+      (message) => {
+        if (message && typeof message === "object" && "id" in message && message.id === subscribePayload.id) {
+          abortController.abort();
+          if ("error" in message) {
+            reject(getSolanaErrorFromJsonRpcError(message.error));
+          } else {
+            resolve(message.result);
+          }
+        }
+      },
+      options
+    );
+  });
+  subscriptionId = await safeRace([abortPromise, subscriptionIdPromise]);
+  if (subscriptionId == null) {
+    throw new SolanaError(SOLANA_ERROR__RPC_SUBSCRIPTIONS__EXPECTED_SERVER_SUBSCRIPTION_ID);
+  }
+  incrementSubscriberCount(channel, subscriptionId);
+  const notificationPublisher = getMemoizedDemultiplexedNotificationPublisherFromChannelAndResponseTransformer(
+    channel,
+    responseTransformer
+  );
+  const notificationKey = `notification:${subscriptionId}`;
+  return {
+    on(type, listener, options) {
+      switch (type) {
+        case "notification":
+          return notificationPublisher.on(
+            notificationKey,
+            listener,
+            options
+          );
+        case "error":
+          return channel.on(
+            "error",
+            listener,
+            options
+          );
+        default:
+          throw new SolanaError(SOLANA_ERROR__INVARIANT_VIOLATION__DATA_PUBLISHER_CHANNEL_UNIMPLEMENTED, {
+            channelName: type,
+            supportedChannelNames: ["notification", "error"]
+          });
+      }
+    }
+  };
+}
+
+export { createRpcSubscriptionsApi, createSubscriptionRpc, executeRpcPubSubSubscriptionPlan };
+//# sourceMappingURL=index.node.mjs.map
+//# sourceMappingURL=index.node.mjs.map

package/dist/index.node.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/rpc-subscriptions.ts","../src/rpc-subscriptions-api.ts","../src/rpc-subscriptions-pubsub-plan.ts"],"names":["SolanaError"],"mappings":";;;;;;AAmCO,SAAS,sBACZ,SAC6C,EAAA;AAC7C,EAAO,OAAA,IAAI,KAAM,CAAA,SAAA,CAAU,GAAK,EAAA;AAAA,IAC5B,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,GAAA,CAAI,MAAQ,EAAA,CAAA,EAAG,QAAU,EAAA;AACrB,MAAA,OAAO,YAAa,SAAsB,EAAA;AACtC,QAAM,MAAA,gBAAA,GAAmB,EAAE,QAAS,EAAA,CAAA;AACpC,QAAA,MAAM,yBAA4B,GAAA,OAAA,CAAQ,GAAI,CAAA,MAAA,EAAQ,kBAAkB,QAAQ,CAAA,CAAA;AAChF,QAAA,IAAI,CAAC,yBAA2B,EAAA;AAC5B,UAAM,MAAA,IAAI,YAAY,gEAAkE,EAAA;AAAA,YACpF,gBAAA;AAAA,WACH,CAAA,CAAA;AAAA,SACL;AACA,QAAM,MAAA,gBAAA,GAAmB,yBAA0B,CAAA,GAAG,SAAS,CAAA,CAAA;AAC/D,QAAO,OAAA,4BAAA,CAA6B,SAAU,CAAA,SAAA,EAAW,gBAAgB,CAAA,CAAA;AAAA,OAC7E,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,4BAAA,CACL,WACA,iBAC6C,EAAA;AAC7C,EAAO,OAAA;AAAA,IACH,MAAM,SAAA,CAAU,EAAE,WAAA,EAA2E,EAAA;AACzF,MAAM,MAAA,0BAAA,GAA6B,MAAM,SAAU,CAAA;AAAA,QAC/C,MAAQ,EAAA,WAAA;AAAA,QACR,GAAG,iBAAA;AAAA,OACN,CAAA,CAAA;AACD,MAAA,OAAO,oCAAoD,CAAA;AAAA,QACvD,WAAA;AAAA,QACA,eAAiB,EAAA,cAAA;AAAA,QACjB,aAAe,EAAA,0BAAA;AAAA,QACf,gBAAkB,EAAA,OAAA;AAAA,OACrB,CAAA,CAAA;AAAA,KACL;AAAA,GACJ,CAAA;AACJ,CAAA;;;ACrBA,IAAM,gBAAgB,MAAO,EAAA,CAAA;AAEtB,SAAS,0BACZ,MACgD,EAAA;AAChD,EAAO,OAAA,IAAI,KAAM,CAAA,EAAwD,EAAA;AAAA,IACrE,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,cAAiB,GAAA;AACb,MAAO,OAAA,KAAA,CAAA;AAAA,KACX;AAAA,IACA,OACO,IACL,EAAA;AACE,MAAM,MAAA,CAAC,CAAG,EAAA,CAAC,CAAI,GAAA,IAAA,CAAA;AACf,MAAM,MAAA,gBAAA,GAAmB,EAAE,QAAS,EAAA,CAAA;AACpC,MAAA,OAAO,YACA,MAK6E,EAAA;AAChF,QAAA,IAAI,uBAAqE,GAAA,aAAA,CAAA;AACzE,QAAO,OAAA;AAAA,UACH,wBAAwB,UAAY,EAAA;AAChC,YAAA,OAAO,OAAO,YAAa,CAAA;AAAA,cACvB,GAAG,UAAA;AAAA,cACH,gBAAA;AAAA,cACA,MAAA;AAAA,aACH,CAAA,CAAA;AAAA,WACL;AAAA,UACA,IAAI,6BAAgC,GAAA;AAChC,YAAA,IAAI,4BAA4B,aAAe,EAAA;AAC3C,cAAA,uBAAA,GAA0B,QAAQ,gCAAmC,GAAA;AAAA,gBACjE,gBAAA;AAAA,gBACA,MAAA;AAAA,eACH,CAAA,CAAA;AAAA,aACL;AACA,YAAO,OAAA,uBAAA,CAAA;AAAA,WACX;AAAA,SACJ,CAAA;AAAA,OACJ,CAAA;AAAA,KACJ;AAAA,GACH,CAAA,CAAA;AACL,CAAA;ACnEA,IAAM,wCAAA,uBAA+C,OAAQ,EAAA,CAAA;AAC7D,SAAS,yCAAA,CAA0C,SAAkB,cAA6C,EAAA;AAC9G,EAAO,OAAA,uCAAA,CAAwC,CAAI,CAAA,EAAA,OAAA,EAAS,cAAc,CAAA,CAAA;AAC9E,CAAA;AACA,SAAS,wBAAA,CAAyB,SAAkB,cAA+B,EAAA;AAC/E,EAAwC,uCAAA,CAAA,CAAA,EAAG,SAAS,cAAc,CAAA,CAAA;AACtE,CAAA;AACA,SAAS,uCAAA,CACL,MACA,EAAA,OAAA,EACA,cACkB,EAAA;AAClB,EAAA,IAAI,mBAAmB,KAAW,CAAA,EAAA;AAC9B,IAAA,OAAA;AAAA,GACJ;AACA,EAAI,IAAA,+BAAA,GAAkC,wCAAyC,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAC1F,EAAI,IAAA,CAAC,+BAAmC,IAAA,MAAA,GAAS,CAAG,EAAA;AAChD,IAAyC,wCAAA,CAAA,GAAA;AAAA,MACrC,OAAA;AAAA,MACC,+BAAkC,GAAA,EAAE,CAAC,cAAc,GAAG,CAAE,EAAA;AAAA,KAC7D,CAAA;AAAA,GACJ;AACA,EAAI,IAAA,+BAAA,CAAgC,cAAc,CAAA,KAAM,KAAW,CAAA,EAAA;AAC/D,IAAA,OAAQ,+BAAgC,CAAA,cAAc,CAClD,GAAA,MAAA,GAAS,gCAAgC,cAAc,CAAA,CAAA;AAAA,GAC/D;AACJ,CAAA;AAEA,IAAM,KAAA,uBAAY,OAAQ,EAAA,CAAA;AAC1B,SAAS,8EAAA,CACL,SACA,mBAGD,EAAA;AACC,EAAI,IAAA,8BAAA,GAAiC,KAAM,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AACtD,EAAA,IAAI,CAAC,8BAAgC,EAAA;AACjC,IAAA,KAAA,CAAM,GAAI,CAAA,OAAA,EAAU,8BAAiC,mBAAA,IAAI,SAAU,CAAA,CAAA;AAAA,GACvE;AACA,EAAA,MAAM,yBAAyB,mBAAuB,IAAA,OAAA,CAAA;AACtD,EAAI,IAAA,SAAA,GAAY,8BAA+B,CAAA,GAAA,CAAI,sBAAsB,CAAA,CAAA;AACzE,EAAA,IAAI,CAAC,SAAW,EAAA;AACZ,IAA+B,8BAAA,CAAA,GAAA;AAAA,MAC3B,sBAAA;AAAA,MACC,SAAY,GAAA,wBAAA,CAAyB,OAAS,EAAA,SAAA,EAAW,CAAc,UAAA,KAAA;AACpE,QAAA,MAAM,OAAU,GAAA,UAAA,CAAA;AAChB,QAAI,IAAA,EAAE,YAAY,OAAU,CAAA,EAAA;AACxB,UAAA,OAAA;AAAA,SACJ;AACA,QAAM,MAAA,uBAAA,GAA0B,mBAC1B,GAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,QAAQ,OAAQ,CAAA,MAAM,CACzD,GAAA,OAAA,CAAQ,MAAO,CAAA,MAAA,CAAA;AACrB,QAAA,OAAO,CAAC,CAAgB,aAAA,EAAA,OAAA,CAAQ,MAAO,CAAA,YAAY,IAAI,uBAAuB,CAAA,CAAA;AAAA,OACjF,CAAA;AAAA,KACL,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,SAAA,CAAA;AACX,CAAA;AAEA,eAAsB,gCAAgD,CAAA;AAAA,EAClE,OAAA;AAAA,EACA,mBAAA;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,eAAA;AAAA,EACA,qBAAA;AACJ,CAAoG,EAAA;AAChG,EAAI,IAAA,cAAA,CAAA;AACJ,EAAQ,OAAA,CAAA,EAAA;AAAA,IACJ,OAAA;AAAA,IACA,MAAM;AAIF,MAAiB,cAAA,GAAA,KAAA,CAAA,CAAA;AACjB,MAAA,wCAAA,CAAyC,OAAO,OAAO,CAAA,CAAA;AAAA,KAC3D;AAAA,IACA,EAAE,MAAO,EAAA;AAAA,GACb,CAAA;AAMA,EAAA,MAAM,YAAe,GAAA,IAAI,OAAe,CAAA,CAAC,GAAG,MAAW,KAAA;AACnD,IAAA,SAAS,WAA+B,GAAA;AAOpC,MAAA,IAAI,yCAA0C,CAAA,OAAA,EAAS,cAAc,CAAA,KAAM,CAAG,EAAA;AAC1E,QAAA,MAAM,kBAAqB,GAAA,gBAAA,CAAiB,qBAAuB,EAAA,CAAC,cAAc,CAAC,CAAA,CAAA;AACnF,QAAiB,cAAA,GAAA,KAAA,CAAA,CAAA;AACjB,QAAA,OAAA,CAAQ,IAAK,CAAA,kBAAkB,CAAE,CAAA,KAAA,CAAM,MAAM;AAAA,SAAE,CAAA,CAAA;AAAA,OACnD;AACA,MAAA,MAAA,CAAO,KAAK,MAAM,CAAA,CAAA;AAAA,KACtB;AACA,IAAA,IAAI,OAAO,OAAS,EAAA;AAChB,MAAA,WAAA,CAAY,KAAK,MAAM,CAAA,CAAA;AAAA,KACpB,MAAA;AACH,MAAO,MAAA,CAAA,gBAAA,CAAiB,SAAS,WAAW,CAAA,CAAA;AAAA,KAChD;AAAA,GACH,CAAA,CAAA;AAKD,EAAM,MAAA,gBAAA,GAAmB,gBAAiB,CAAA,mBAAA,EAAqB,eAAe,CAAA,CAAA;AAC9E,EAAM,MAAA,OAAA,CAAQ,KAAK,gBAAgB,CAAA,CAAA;AAKnC,EAAA,MAAM,qBAAwB,GAAA,IAAI,OAA2B,CAAA,CAAC,SAAS,MAAW,KAAA;AAC9E,IAAM,MAAA,eAAA,GAAkB,IAAI,eAAgB,EAAA,CAAA;AAC5C,IAAA,MAAA,CAAO,iBAAiB,OAAS,EAAA,eAAA,CAAgB,KAAM,CAAA,IAAA,CAAK,eAAe,CAAC,CAAA,CAAA;AAC5E,IAAA,MAAM,OAAU,GAAA,EAAE,MAAQ,EAAA,eAAA,CAAgB,MAAO,EAAA,CAAA;AACjD,IAAQ,OAAA,CAAA,EAAA;AAAA,MACJ,OAAA;AAAA,MACA,CAAO,GAAA,KAAA;AACH,QAAA,eAAA,CAAgB,KAAM,EAAA,CAAA;AACtB,QAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AAAA,OACd;AAAA,MACA,OAAA;AAAA,KACJ,CAAA;AACA,IAAQ,OAAA,CAAA,EAAA;AAAA,MACJ,SAAA;AAAA,MACA,CAAW,OAAA,KAAA;AACP,QAAI,IAAA,OAAA,IAAW,OAAO,OAAY,KAAA,QAAA,IAAY,QAAQ,OAAW,IAAA,OAAA,CAAQ,EAAO,KAAA,gBAAA,CAAiB,EAAI,EAAA;AACjG,UAAA,eAAA,CAAgB,KAAM,EAAA,CAAA;AACtB,UAAA,IAAI,WAAW,OAAS,EAAA;AACpB,YAAO,MAAA,CAAA,8BAAA,CAA+B,OAAQ,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,WACjD,MAAA;AACH,YAAA,OAAA,CAAQ,QAAQ,MAAM,CAAA,CAAA;AAAA,WAC1B;AAAA,SACJ;AAAA,OACJ;AAAA,MACA,OAAA;AAAA,KACJ,CAAA;AAAA,GACH,CAAA,CAAA;AACD,EAAA,cAAA,GAAiB,MAAM,QAAA,CAAS,CAAC,YAAA,EAAc,qBAAqB,CAAC,CAAA,CAAA;AACrE,EAAA,IAAI,kBAAkB,IAAM,EAAA;AACxB,IAAM,MAAA,IAAIA,YAAY,gEAAgE,CAAA,CAAA;AAAA,GAC1F;AACA,EAAA,wBAAA,CAAyB,SAAS,cAAc,CAAA,CAAA;AAKhD,EAAA,MAAM,qBAAwB,GAAA,8EAAA;AAAA,IAC1B,OAAA;AAAA,IACA,mBAAA;AAAA,GACJ,CAAA;AACA,EAAM,MAAA,eAAA,GAAkB,gBAAgB,cAAc,CAAA,CAAA,CAAA;AACtD,EAAO,OAAA;AAAA,IACH,EAAA,CAAG,IAAM,EAAA,QAAA,EAAU,OAAS,EAAA;AACxB,MAAA,QAAQ,IAAM;AAAA,QACV,KAAK,cAAA;AACD,UAAA,OAAO,qBAAsB,CAAA,EAAA;AAAA,YACzB,eAAA;AAAA,YACA,QAAA;AAAA,YACA,OAAA;AAAA,WACJ,CAAA;AAAA,QACJ,KAAK,OAAA;AACD,UAAA,OAAO,OAAQ,CAAA,EAAA;AAAA,YACX,OAAA;AAAA,YACA,QAAA;AAAA,YACA,OAAA;AAAA,WACJ,CAAA;AAAA,QACJ;AACI,UAAM,MAAA,IAAIA,YAAY,uEAAyE,EAAA;AAAA,YAC3F,WAAa,EAAA,IAAA;AAAA,YACb,qBAAA,EAAuB,CAAC,cAAA,EAAgB,OAAO,CAAA;AAAA,WAClD,CAAA,CAAA;AAAA,OACT;AAAA,KACJ;AAAA,GACJ,CAAA;AACJ","file":"index.node.mjs","sourcesContent":["import { SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN, SolanaError } from '@solana/errors';\nimport { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';\nimport { createAsyncIterableFromDataPublisher } from '@solana/subscribable';\n\nimport { RpcSubscriptionsApi, RpcSubscriptionsPlan } from './rpc-subscriptions-api';\nimport { PendingRpcSubscriptionsRequest, RpcSubscribeOptions } from './rpc-subscriptions-request';\nimport { RpcSubscriptionsTransport } from './rpc-subscriptions-transport';\n\nexport type RpcSubscriptionsConfig<TRpcMethods> = Readonly<{\n    api: RpcSubscriptionsApi<TRpcMethods>;\n    transport: RpcSubscriptionsTransport;\n}>;\n\nexport type RpcSubscriptions<TRpcSubscriptionsMethods> = {\n    [TMethodName in keyof TRpcSubscriptionsMethods]: PendingRpcSubscriptionsRequestBuilder<\n        OverloadImplementations<TRpcSubscriptionsMethods, TMethodName>\n    >;\n};\n\ntype PendingRpcSubscriptionsRequestBuilder<TSubscriptionMethodImplementations> = UnionToIntersection<\n    Flatten<{\n        [P in keyof TSubscriptionMethodImplementations]: PendingRpcSubscriptionsRequestReturnTypeMapper<\n            TSubscriptionMethodImplementations[P]\n        >;\n    }>\n>;\n\ntype PendingRpcSubscriptionsRequestReturnTypeMapper<TSubscriptionMethodImplementation> =\n    // Check that this property of the TRpcSubscriptionMethods interface is, in fact, a function.\n    TSubscriptionMethodImplementation extends Callable\n        ? (\n              ...args: Parameters<TSubscriptionMethodImplementation>\n          ) => PendingRpcSubscriptionsRequest<ReturnType<TSubscriptionMethodImplementation>>\n        : never;\n\nexport function createSubscriptionRpc<TRpcSubscriptionsApiMethods>(\n    rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods>,\n): RpcSubscriptions<TRpcSubscriptionsApiMethods> {\n    return new Proxy(rpcConfig.api, {\n        defineProperty() {\n            return false;\n        },\n        deleteProperty() {\n            return false;\n        },\n        get(target, p, receiver) {\n            return function (...rawParams: unknown[]) {\n                const notificationName = p.toString();\n                const createRpcSubscriptionPlan = Reflect.get(target, notificationName, receiver);\n                if (!createRpcSubscriptionPlan) {\n                    throw new SolanaError(SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN, {\n                        notificationName,\n                    });\n                }\n                const subscriptionPlan = createRpcSubscriptionPlan(...rawParams);\n                return createPendingRpcSubscription(rpcConfig.transport, subscriptionPlan);\n            };\n        },\n    }) as RpcSubscriptions<TRpcSubscriptionsApiMethods>;\n}\n\nfunction createPendingRpcSubscription<TNotification>(\n    transport: RpcSubscriptionsTransport,\n    subscriptionsPlan: RpcSubscriptionsPlan<TNotification>,\n): PendingRpcSubscriptionsRequest<TNotification> {\n    return {\n        async subscribe({ abortSignal }: RpcSubscribeOptions): Promise<AsyncIterable<TNotification>> {\n            const notificationsDataPublisher = await transport({\n                signal: abortSignal,\n                ...subscriptionsPlan,\n            });\n            return createAsyncIterableFromDataPublisher<TNotification>({\n                abortSignal,\n                dataChannelName: 'notification',\n                dataPublisher: notificationsDataPublisher,\n                errorChannelName: 'error',\n            });\n        },\n    };\n}\n","import { Callable } from '@solana/rpc-spec-types';\nimport { DataPublisher } from '@solana/subscribable';\n\nimport { RpcSubscriptionsChannel } from './rpc-subscriptions-channel';\nimport { RpcSubscriptionsTransportDataEvents } from './rpc-subscriptions-transport';\n\nexport type RpcSubscriptionsApiConfig<TApiMethods extends RpcSubscriptionsApiMethods> = Readonly<{\n    getSubscriptionConfigurationHash?: (\n        details: Readonly<{\n            notificationName: string;\n            params: unknown;\n        }>,\n    ) => string | undefined;\n    planExecutor: RpcSubscriptionsPlanExecutor<ReturnType<TApiMethods[keyof TApiMethods]>>;\n}>;\n\ntype RpcSubscriptionsPlanExecutor<TNotification> = (\n    config: Readonly<{\n        channel: RpcSubscriptionsChannel<unknown, unknown>;\n        notificationName: string;\n        params?: unknown[];\n        signal: AbortSignal;\n    }>,\n) => Promise<DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>>;\n\nexport type RpcSubscriptionsPlan<TNotification> = Readonly<{\n    /**\n     * This method may be called with a newly-opened channel or a pre-established channel.\n     */\n    executeSubscriptionPlan: (\n        config: Readonly<{\n            channel: RpcSubscriptionsChannel<unknown, unknown>;\n            signal: AbortSignal;\n        }>,\n    ) => Promise<DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>>;\n    /**\n     * This hash uniquely identifies the configuration of a subscription. It is typically used by\n     * consumers of this API to deduplicate multiple subscriptions for the same notification.\n     */\n    subscriptionConfigurationHash: string | undefined;\n}>;\n\nexport type RpcSubscriptionsApi<TRpcSubscriptionMethods> = {\n    [MethodName in keyof TRpcSubscriptionMethods]: RpcSubscriptionsReturnTypeMapper<\n        TRpcSubscriptionMethods[MethodName]\n    >;\n};\n\ntype RpcSubscriptionsReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable\n    ? (...rawParams: unknown[]) => RpcSubscriptionsPlan<ReturnType<TRpcMethod>>\n    : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype RpcSubscriptionsApiMethod = (...args: any) => any;\nexport interface RpcSubscriptionsApiMethods {\n    [methodName: string]: RpcSubscriptionsApiMethod;\n}\n\nconst UNINITIALIZED = Symbol();\n\nexport function createRpcSubscriptionsApi<TRpcSubscriptionsApiMethods extends RpcSubscriptionsApiMethods>(\n    config: RpcSubscriptionsApiConfig<TRpcSubscriptionsApiMethods>,\n): RpcSubscriptionsApi<TRpcSubscriptionsApiMethods> {\n    return new Proxy({} as RpcSubscriptionsApi<TRpcSubscriptionsApiMethods>, {\n        defineProperty() {\n            return false;\n        },\n        deleteProperty() {\n            return false;\n        },\n        get<TNotificationName extends keyof RpcSubscriptionsApi<TRpcSubscriptionsApiMethods>>(\n            ...args: Parameters<NonNullable<ProxyHandler<RpcSubscriptionsApi<TRpcSubscriptionsApiMethods>>['get']>>\n        ) {\n            const [_, p] = args;\n            const notificationName = p.toString() as keyof TRpcSubscriptionsApiMethods as string;\n            return function (\n                ...params: Parameters<\n                    TRpcSubscriptionsApiMethods[TNotificationName] extends CallableFunction\n                        ? TRpcSubscriptionsApiMethods[TNotificationName]\n                        : never\n                >\n            ): RpcSubscriptionsPlan<ReturnType<TRpcSubscriptionsApiMethods[TNotificationName]>> {\n                let _cachedSubscriptionHash: string | typeof UNINITIALIZED | undefined = UNINITIALIZED;\n                return {\n                    executeSubscriptionPlan(planConfig) {\n                        return config.planExecutor({\n                            ...planConfig,\n                            notificationName,\n                            params,\n                        });\n                    },\n                    get subscriptionConfigurationHash() {\n                        if (_cachedSubscriptionHash === UNINITIALIZED) {\n                            _cachedSubscriptionHash = config?.getSubscriptionConfigurationHash?.({\n                                notificationName,\n                                params,\n                            });\n                        }\n                        return _cachedSubscriptionHash;\n                    },\n                };\n            };\n        },\n    });\n}\n","import {\n    getSolanaErrorFromJsonRpcError,\n    SOLANA_ERROR__INVARIANT_VIOLATION__DATA_PUBLISHER_CHANNEL_UNIMPLEMENTED,\n    SOLANA_ERROR__RPC_SUBSCRIPTIONS__EXPECTED_SERVER_SUBSCRIPTION_ID,\n    SolanaError,\n} from '@solana/errors';\nimport { safeRace } from '@solana/promises';\nimport { createRpcMessage, RpcResponseData } from '@solana/rpc-spec-types';\nimport { DataPublisher } from '@solana/subscribable';\nimport { demultiplexDataPublisher } from '@solana/subscribable';\n\nimport { RpcSubscriptionChannelEvents } from './rpc-subscriptions-channel';\nimport { RpcSubscriptionsChannel } from './rpc-subscriptions-channel';\n\ntype Config<TNotification> = Readonly<{\n    channel: RpcSubscriptionsChannel<unknown, RpcNotification<TNotification> | RpcResponseData<RpcSubscriptionId>>;\n    responseTransformer?: <T>(response: unknown, notificationName: string) => T;\n    signal: AbortSignal;\n    subscribeMethodName: string;\n    subscribeParams?: unknown[];\n    unsubscribeMethodName: string;\n}>;\n\ntype RpcNotification<TNotification> = Readonly<{\n    method: string;\n    params: Readonly<{\n        result: TNotification;\n        subscription: number;\n    }>;\n}>;\n\ntype RpcSubscriptionId = number;\n\ntype RpcSubscriptionNotificationEvents<TNotification> = Omit<RpcSubscriptionChannelEvents<TNotification>, 'message'> & {\n    notification: TNotification;\n};\n\nconst subscriberCountBySubscriptionIdByChannel = new WeakMap();\nfunction decrementSubscriberCountAndReturnNewCount(channel: WeakKey, subscriptionId?: number): number | undefined {\n    return augmentSubscriberCountAndReturnNewCount(-1, channel, subscriptionId);\n}\nfunction incrementSubscriberCount(channel: WeakKey, subscriptionId?: number): void {\n    augmentSubscriberCountAndReturnNewCount(1, channel, subscriptionId);\n}\nfunction augmentSubscriberCountAndReturnNewCount(\n    amount: -1 | 1,\n    channel: WeakKey,\n    subscriptionId?: number,\n): number | undefined {\n    if (subscriptionId === undefined) {\n        return;\n    }\n    let subscriberCountBySubscriptionId = subscriberCountBySubscriptionIdByChannel.get(channel);\n    if (!subscriberCountBySubscriptionId && amount > 0) {\n        subscriberCountBySubscriptionIdByChannel.set(\n            channel,\n            (subscriberCountBySubscriptionId = { [subscriptionId]: 0 }),\n        );\n    }\n    if (subscriberCountBySubscriptionId[subscriptionId] !== undefined) {\n        return (subscriberCountBySubscriptionId[subscriptionId] =\n            amount + subscriberCountBySubscriptionId[subscriptionId]);\n    }\n}\n\nconst cache = new WeakMap();\nfunction getMemoizedDemultiplexedNotificationPublisherFromChannelAndResponseTransformer<TNotification>(\n    channel: RpcSubscriptionsChannel<unknown, RpcNotification<TNotification>>,\n    responseTransformer?: <T>(response: unknown, notificationName: string) => T,\n): DataPublisher<{\n    [channelName: `notification:${number}`]: TNotification;\n}> {\n    let publisherByResponseTransformer = cache.get(channel);\n    if (!publisherByResponseTransformer) {\n        cache.set(channel, (publisherByResponseTransformer = new WeakMap()));\n    }\n    const responseTransformerKey = responseTransformer ?? channel;\n    let publisher = publisherByResponseTransformer.get(responseTransformerKey);\n    if (!publisher) {\n        publisherByResponseTransformer.set(\n            responseTransformerKey,\n            (publisher = demultiplexDataPublisher(channel, 'message', rawMessage => {\n                const message = rawMessage as RpcNotification<unknown> | RpcResponseData<unknown>;\n                if (!('method' in message)) {\n                    return;\n                }\n                const transformedNotification = responseTransformer\n                    ? responseTransformer(message.params.result, message.method)\n                    : message.params.result;\n                return [`notification:${message.params.subscription}`, transformedNotification];\n            })),\n        );\n    }\n    return publisher;\n}\n\nexport async function executeRpcPubSubSubscriptionPlan<TNotification>({\n    channel,\n    responseTransformer,\n    signal,\n    subscribeMethodName,\n    subscribeParams,\n    unsubscribeMethodName,\n}: Config<TNotification>): Promise<DataPublisher<RpcSubscriptionNotificationEvents<TNotification>>> {\n    let subscriptionId: number | undefined;\n    channel.on(\n        'error',\n        () => {\n            // An error on the channel indicates that the subscriptions are dead.\n            // There is no longer any sense hanging on to subscription ids.\n            // Erasing it here will prevent the unsubscribe code from running.\n            subscriptionId = undefined;\n            subscriberCountBySubscriptionIdByChannel.delete(channel);\n        },\n        { signal },\n    );\n    /**\n     * STEP 1\n     * Create a promise that rejects if this subscription is aborted and sends\n     * the unsubscribe message if the subscription is active at that time.\n     */\n    const abortPromise = new Promise<never>((_, reject) => {\n        function handleAbort(this: AbortSignal) {\n            /**\n             * Because of https://github.com/solana-labs/solana/pull/18943, two subscriptions for\n             * materially the same notification will be coalesced on the server. This means they\n             * will be assigned the same subscription id, and will occupy one subscription slot. We\n             * must be careful not to send the unsubscribe message until the last subscriber aborts.\n             */\n            if (decrementSubscriberCountAndReturnNewCount(channel, subscriptionId) === 0) {\n                const unsubscribePayload = createRpcMessage(unsubscribeMethodName, [subscriptionId]);\n                subscriptionId = undefined;\n                channel.send(unsubscribePayload).catch(() => {});\n            }\n            reject(this.reason);\n        }\n        if (signal.aborted) {\n            handleAbort.call(signal);\n        } else {\n            signal.addEventListener('abort', handleAbort);\n        }\n    });\n    /**\n     * STEP 2\n     * Send the subscription request.\n     */\n    const subscribePayload = createRpcMessage(subscribeMethodName, subscribeParams);\n    await channel.send(subscribePayload);\n    /**\n     * STEP 3\n     * Wait for the acknowledgement from the server with the subscription id.\n     */\n    const subscriptionIdPromise = new Promise<RpcSubscriptionId>((resolve, reject) => {\n        const abortController = new AbortController();\n        signal.addEventListener('abort', abortController.abort.bind(abortController));\n        const options = { signal: abortController.signal } as const;\n        channel.on(\n            'error',\n            err => {\n                abortController.abort();\n                reject(err);\n            },\n            options,\n        );\n        channel.on(\n            'message',\n            message => {\n                if (message && typeof message === 'object' && 'id' in message && message.id === subscribePayload.id) {\n                    abortController.abort();\n                    if ('error' in message) {\n                        reject(getSolanaErrorFromJsonRpcError(message.error));\n                    } else {\n                        resolve(message.result);\n                    }\n                }\n            },\n            options,\n        );\n    });\n    subscriptionId = await safeRace([abortPromise, subscriptionIdPromise]);\n    if (subscriptionId == null) {\n        throw new SolanaError(SOLANA_ERROR__RPC_SUBSCRIPTIONS__EXPECTED_SERVER_SUBSCRIPTION_ID);\n    }\n    incrementSubscriberCount(channel, subscriptionId);\n    /**\n     * STEP 4\n     * Filter out notifications unrelated to this subscription.\n     */\n    const notificationPublisher = getMemoizedDemultiplexedNotificationPublisherFromChannelAndResponseTransformer(\n        channel,\n        responseTransformer,\n    );\n    const notificationKey = `notification:${subscriptionId}` as const;\n    return {\n        on(type, listener, options) {\n            switch (type) {\n                case 'notification':\n                    return notificationPublisher.on(\n                        notificationKey,\n                        listener as (data: RpcSubscriptionNotificationEvents<TNotification>['notification']) => void,\n                        options,\n                    );\n                case 'error':\n                    return channel.on(\n                        'error',\n                        listener as (data: RpcSubscriptionNotificationEvents<TNotification>['error']) => void,\n                        options,\n                    );\n                default:\n                    throw new SolanaError(SOLANA_ERROR__INVARIANT_VIOLATION__DATA_PUBLISHER_CHANNEL_UNIMPLEMENTED, {\n                        channelName: type,\n                        supportedChannelNames: ['notification', 'error'],\n                    });\n            }\n        },\n    };\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './rpc-subscriptions-request';
+export * from './rpc-subscriptions';
+export * from './rpc-subscriptions-api';
+export * from './rpc-subscriptions-channel';
+export * from './rpc-subscriptions-pubsub-plan';
+export * from './rpc-subscriptions-transport';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC"}

package/dist/types/rpc-subscriptions-api.d.ts

@@ -0,0 +1,42 @@
+import { Callable } from '@solana/rpc-spec-types';
+import { DataPublisher } from '@solana/subscribable';
+import { RpcSubscriptionsChannel } from './rpc-subscriptions-channel';
+import { RpcSubscriptionsTransportDataEvents } from './rpc-subscriptions-transport';
+export type RpcSubscriptionsApiConfig<TApiMethods extends RpcSubscriptionsApiMethods> = Readonly<{
+    getSubscriptionConfigurationHash?: (details: Readonly<{
+        notificationName: string;
+        params: unknown;
+    }>) => string | undefined;
+    planExecutor: RpcSubscriptionsPlanExecutor<ReturnType<TApiMethods[keyof TApiMethods]>>;
+}>;
+type RpcSubscriptionsPlanExecutor<TNotification> = (config: Readonly<{
+    channel: RpcSubscriptionsChannel<unknown, unknown>;
+    notificationName: string;
+    params?: unknown[];
+    signal: AbortSignal;
+}>) => Promise<DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>>;
+export type RpcSubscriptionsPlan<TNotification> = Readonly<{
+    /**
+     * This method may be called with a newly-opened channel or a pre-established channel.
+     */
+    executeSubscriptionPlan: (config: Readonly<{
+        channel: RpcSubscriptionsChannel<unknown, unknown>;
+        signal: AbortSignal;
+    }>) => Promise<DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>>;
+    /**
+     * This hash uniquely identifies the configuration of a subscription. It is typically used by
+     * consumers of this API to deduplicate multiple subscriptions for the same notification.
+     */
+    subscriptionConfigurationHash: string | undefined;
+}>;
+export type RpcSubscriptionsApi<TRpcSubscriptionMethods> = {
+    [MethodName in keyof TRpcSubscriptionMethods]: RpcSubscriptionsReturnTypeMapper<TRpcSubscriptionMethods[MethodName]>;
+};
+type RpcSubscriptionsReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable ? (...rawParams: unknown[]) => RpcSubscriptionsPlan<ReturnType<TRpcMethod>> : never;
+type RpcSubscriptionsApiMethod = (...args: any) => any;
+export interface RpcSubscriptionsApiMethods {
+    [methodName: string]: RpcSubscriptionsApiMethod;
+}
+export declare function createRpcSubscriptionsApi<TRpcSubscriptionsApiMethods extends RpcSubscriptionsApiMethods>(config: RpcSubscriptionsApiConfig<TRpcSubscriptionsApiMethods>): RpcSubscriptionsApi<TRpcSubscriptionsApiMethods>;
+export {};
+//# sourceMappingURL=rpc-subscriptions-api.d.ts.map

package/dist/types/rpc-subscriptions-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions-api.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,EAAE,mCAAmC,EAAE,MAAM,+BAA+B,CAAC;AAEpF,MAAM,MAAM,yBAAyB,CAAC,WAAW,SAAS,0BAA0B,IAAI,QAAQ,CAAC;IAC7F,gCAAgC,CAAC,EAAE,CAC/B,OAAO,EAAE,QAAQ,CAAC;QACd,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,OAAO,CAAC;KACnB,CAAC,KACD,MAAM,GAAG,SAAS,CAAC;IACxB,YAAY,EAAE,4BAA4B,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;CAC1F,CAAC,CAAC;AAEH,KAAK,4BAA4B,CAAC,aAAa,IAAI,CAC/C,MAAM,EAAE,QAAQ,CAAC;IACb,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,MAAM,EAAE,WAAW,CAAC;CACvB,CAAC,KACD,OAAO,CAAC,aAAa,CAAC,mCAAmC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAEhF,MAAM,MAAM,oBAAoB,CAAC,aAAa,IAAI,QAAQ,CAAC;IACvD;;OAEG;IACH,uBAAuB,EAAE,CACrB,MAAM,EAAE,QAAQ,CAAC;QACb,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,MAAM,EAAE,WAAW,CAAC;KACvB,CAAC,KACD,OAAO,CAAC,aAAa,CAAC,mCAAmC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAChF;;;OAGG;IACH,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;CACrD,CAAC,CAAC;AAEH,MAAM,MAAM,mBAAmB,CAAC,uBAAuB,IAAI;KACtD,UAAU,IAAI,MAAM,uBAAuB,GAAG,gCAAgC,CAC3E,uBAAuB,CAAC,UAAU,CAAC,CACtC;CACJ,CAAC;AAEF,KAAK,gCAAgC,CAAC,UAAU,IAAI,UAAU,SAAS,QAAQ,GACzE,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,KAAK,oBAAoB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GACzE,KAAK,CAAC;AAGZ,KAAK,yBAAyB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;AACvD,MAAM,WAAW,0BAA0B;IACvC,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB,CAAC;CACnD;AAID,wBAAgB,yBAAyB,CAAC,2BAA2B,SAAS,0BAA0B,EACpG,MAAM,EAAE,yBAAyB,CAAC,2BAA2B,CAAC,GAC/D,mBAAmB,CAAC,2BAA2B,CAAC,CA0ClD"}

package/dist/types/rpc-subscriptions-channel.d.ts

@@ -0,0 +1,15 @@
+import { SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_CLOSED_BEFORE_MESSAGE_BUFFERED, SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_CONNECTION_CLOSED, SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_FAILED_TO_CONNECT, SolanaError } from '@solana/errors';
+import { DataPublisher } from '@solana/subscribable';
+type RpcSubscriptionsChannelSolanaErrorCode = typeof SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_CLOSED_BEFORE_MESSAGE_BUFFERED | typeof SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_CONNECTION_CLOSED | typeof SOLANA_ERROR__RPC_SUBSCRIPTIONS__CHANNEL_FAILED_TO_CONNECT;
+export type RpcSubscriptionChannelEvents<TInboundMessage> = {
+    error: SolanaError<RpcSubscriptionsChannelSolanaErrorCode>;
+    message: TInboundMessage;
+};
+export interface RpcSubscriptionsChannel<TOutboundMessage, TInboundMessage> extends DataPublisher<RpcSubscriptionChannelEvents<TInboundMessage>> {
+    send(message: TOutboundMessage): Promise<void>;
+}
+export type RpcSubscriptionsChannelCreator<TOutboundMessage, TInboundMessage> = (config: Readonly<{
+    abortSignal: AbortSignal;
+}>) => Promise<RpcSubscriptionsChannel<TOutboundMessage, TInboundMessage>>;
+export {};
+//# sourceMappingURL=rpc-subscriptions-channel.d.ts.map

package/dist/types/rpc-subscriptions-channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions-channel.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,uEAAuE,EACvE,0DAA0D,EAC1D,0DAA0D,EAC1D,WAAW,EACd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,KAAK,sCAAsC,GACrC,OAAO,uEAAuE,GAC9E,OAAO,0DAA0D,GACjE,OAAO,0DAA0D,CAAC;AAExE,MAAM,MAAM,4BAA4B,CAAC,eAAe,IAAI;IACxD,KAAK,EAAE,WAAW,CAAC,sCAAsC,CAAC,CAAC;IAC3D,OAAO,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,uBAAuB,CAAC,gBAAgB,EAAE,eAAe,CACtE,SAAQ,aAAa,CAAC,4BAA4B,CAAC,eAAe,CAAC,CAAC;IACpE,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD;AAED,MAAM,MAAM,8BAA8B,CAAC,gBAAgB,EAAE,eAAe,IAAI,CAC5E,MAAM,EAAE,QAAQ,CAAC;IACb,WAAW,EAAE,WAAW,CAAC;CAC5B,CAAC,KACD,OAAO,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC"}

package/dist/types/rpc-subscriptions-pubsub-plan.d.ts

@@ -0,0 +1,26 @@
+import { RpcResponseData } from '@solana/rpc-spec-types';
+import { DataPublisher } from '@solana/subscribable';
+import { RpcSubscriptionChannelEvents } from './rpc-subscriptions-channel';
+import { RpcSubscriptionsChannel } from './rpc-subscriptions-channel';
+type Config<TNotification> = Readonly<{
+    channel: RpcSubscriptionsChannel<unknown, RpcNotification<TNotification> | RpcResponseData<RpcSubscriptionId>>;
+    responseTransformer?: <T>(response: unknown, notificationName: string) => T;
+    signal: AbortSignal;
+    subscribeMethodName: string;
+    subscribeParams?: unknown[];
+    unsubscribeMethodName: string;
+}>;
+type RpcNotification<TNotification> = Readonly<{
+    method: string;
+    params: Readonly<{
+        result: TNotification;
+        subscription: number;
+    }>;
+}>;
+type RpcSubscriptionId = number;
+type RpcSubscriptionNotificationEvents<TNotification> = Omit<RpcSubscriptionChannelEvents<TNotification>, 'message'> & {
+    notification: TNotification;
+};
+export declare function executeRpcPubSubSubscriptionPlan<TNotification>({ channel, responseTransformer, signal, subscribeMethodName, subscribeParams, unsubscribeMethodName, }: Config<TNotification>): Promise<DataPublisher<RpcSubscriptionNotificationEvents<TNotification>>>;
+export {};
+//# sourceMappingURL=rpc-subscriptions-pubsub-plan.d.ts.map

package/dist/types/rpc-subscriptions-pubsub-plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions-pubsub-plan.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-pubsub-plan.ts"],"names":[],"mappings":"AAOA,OAAO,EAAoB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,KAAK,MAAM,CAAC,aAAa,IAAI,QAAQ,CAAC;IAClC,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,eAAe,CAAC,aAAa,CAAC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC/G,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAC,CAAC;IAC5E,MAAM,EAAE,WAAW,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC;IAC5B,qBAAqB,EAAE,MAAM,CAAC;CACjC,CAAC,CAAC;AAEH,KAAK,eAAe,CAAC,aAAa,IAAI,QAAQ,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,QAAQ,CAAC;QACb,MAAM,EAAE,aAAa,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC,CAAC;CACN,CAAC,CAAC;AAEH,KAAK,iBAAiB,GAAG,MAAM,CAAC;AAEhC,KAAK,iCAAiC,CAAC,aAAa,IAAI,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,GAAG;IACnH,YAAY,EAAE,aAAa,CAAC;CAC/B,CAAC;AA6DF,wBAAsB,gCAAgC,CAAC,aAAa,EAAE,EAClE,OAAO,EACP,mBAAmB,EACnB,MAAM,EACN,mBAAmB,EACnB,eAAe,EACf,qBAAqB,GACxB,EAAE,MAAM,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,iCAAiC,CAAC,aAAa,CAAC,CAAC,CAAC,CAiHlG"}

package/dist/types/rpc-subscriptions-request.d.ts

@@ -0,0 +1,13 @@
+export type RpcSubscriptionsRequest<TResponse> = {
+    params: unknown[];
+    responseTransformer?: (response: unknown, notificationName: string) => TResponse;
+    subscribeMethodName: string;
+    unsubscribeMethodName: string;
+};
+export type PendingRpcSubscriptionsRequest<TNotification> = {
+    subscribe(options: RpcSubscribeOptions): Promise<AsyncIterable<TNotification>>;
+};
+export type RpcSubscribeOptions = Readonly<{
+    abortSignal: AbortSignal;
+}>;
+//# sourceMappingURL=rpc-subscriptions-request.d.ts.map

package/dist/types/rpc-subscriptions-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions-request.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-request.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,CAAC,SAAS,IAAI;IAC7C,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,KAAK,SAAS,CAAC;IACjF,mBAAmB,EAAE,MAAM,CAAC;IAC5B,qBAAqB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,8BAA8B,CAAC,aAAa,IAAI;IACxD,SAAS,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;CAClF,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;IACvC,WAAW,EAAE,WAAW,CAAC;CAC5B,CAAC,CAAC"}

package/dist/types/rpc-subscriptions-transport.d.ts

@@ -0,0 +1,15 @@
+import { SolanaError } from '@solana/errors';
+import { DataPublisher } from '@solana/subscribable';
+import { RpcSubscriptionsPlan } from './rpc-subscriptions-api';
+export type RpcSubscriptionsTransportDataEvents<TNotification> = {
+    error: SolanaError;
+    notification: TNotification;
+};
+interface RpcSubscriptionsTransportConfig<TNotification> extends RpcSubscriptionsPlan<TNotification> {
+    signal: AbortSignal;
+}
+export interface RpcSubscriptionsTransport {
+    <TNotification>(config: RpcSubscriptionsTransportConfig<TNotification>): Promise<DataPublisher<RpcSubscriptionsTransportDataEvents<TNotification>>>;
+}
+export {};
+//# sourceMappingURL=rpc-subscriptions-transport.d.ts.map

package/dist/types/rpc-subscriptions-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions-transport.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE/D,MAAM,MAAM,mCAAmC,CAAC,aAAa,IAAI;IAC7D,KAAK,EAAE,WAAW,CAAC;IACnB,YAAY,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,UAAU,+BAA+B,CAAC,aAAa,CAAE,SAAQ,oBAAoB,CAAC,aAAa,CAAC;IAChG,MAAM,EAAE,WAAW,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACtC,CAAC,aAAa,EACV,MAAM,EAAE,+BAA+B,CAAC,aAAa,CAAC,GACvD,OAAO,CAAC,aAAa,CAAC,mCAAmC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CACjF"}

package/dist/types/rpc-subscriptions.d.ts

@@ -0,0 +1,18 @@
+import { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';
+import { RpcSubscriptionsApi } from './rpc-subscriptions-api';
+import { PendingRpcSubscriptionsRequest } from './rpc-subscriptions-request';
+import { RpcSubscriptionsTransport } from './rpc-subscriptions-transport';
+export type RpcSubscriptionsConfig<TRpcMethods> = Readonly<{
+    api: RpcSubscriptionsApi<TRpcMethods>;
+    transport: RpcSubscriptionsTransport;
+}>;
+export type RpcSubscriptions<TRpcSubscriptionsMethods> = {
+    [TMethodName in keyof TRpcSubscriptionsMethods]: PendingRpcSubscriptionsRequestBuilder<OverloadImplementations<TRpcSubscriptionsMethods, TMethodName>>;
+};
+type PendingRpcSubscriptionsRequestBuilder<TSubscriptionMethodImplementations> = UnionToIntersection<Flatten<{
+    [P in keyof TSubscriptionMethodImplementations]: PendingRpcSubscriptionsRequestReturnTypeMapper<TSubscriptionMethodImplementations[P]>;
+}>>;
+type PendingRpcSubscriptionsRequestReturnTypeMapper<TSubscriptionMethodImplementation> = TSubscriptionMethodImplementation extends Callable ? (...args: Parameters<TSubscriptionMethodImplementation>) => PendingRpcSubscriptionsRequest<ReturnType<TSubscriptionMethodImplementation>> : never;
+export declare function createSubscriptionRpc<TRpcSubscriptionsApiMethods>(rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods>): RpcSubscriptions<TRpcSubscriptionsApiMethods>;
+export {};
+//# sourceMappingURL=rpc-subscriptions.d.ts.map

package/dist/types/rpc-subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-subscriptions.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAGzG,OAAO,EAAE,mBAAmB,EAAwB,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,8BAA8B,EAAuB,MAAM,6BAA6B,CAAC;AAClG,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,MAAM,MAAM,sBAAsB,CAAC,WAAW,IAAI,QAAQ,CAAC;IACvD,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACtC,SAAS,EAAE,yBAAyB,CAAC;CACxC,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,CAAC,wBAAwB,IAAI;KACpD,WAAW,IAAI,MAAM,wBAAwB,GAAG,qCAAqC,CAClF,uBAAuB,CAAC,wBAAwB,EAAE,WAAW,CAAC,CACjE;CACJ,CAAC;AAEF,KAAK,qCAAqC,CAAC,kCAAkC,IAAI,mBAAmB,CAChG,OAAO,CAAC;KACH,CAAC,IAAI,MAAM,kCAAkC,GAAG,8CAA8C,CAC3F,kCAAkC,CAAC,CAAC,CAAC,CACxC;CACJ,CAAC,CACL,CAAC;AAEF,KAAK,8CAA8C,CAAC,iCAAiC,IAEjF,iCAAiC,SAAS,QAAQ,GAC5C,CACI,GAAG,IAAI,EAAE,UAAU,CAAC,iCAAiC,CAAC,KACrD,8BAA8B,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC,GAClF,KAAK,CAAC;AAEhB,wBAAgB,qBAAqB,CAAC,2BAA2B,EAC7D,SAAS,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,GAC/D,gBAAgB,CAAC,2BAA2B,CAAC,CAsB/C"}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@solana/rpc-subscriptions-spec",
+  "version": "2.0.0-20241006045741",
+  "description": "A generic implementation of JSON RPC Subscriptions using proxies",
+  "exports": {
+    "edge-light": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "workerd": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "browser": {
+      "import": "./dist/index.browser.mjs",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "react-native": "./dist/index.native.mjs",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.mjs": "./dist/index.browser.mjs"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.mjs",
+  "react-native": "./dist/index.native.mjs",
+  "types": "./dist/types/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "./dist/"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "blockchain",
+    "solana",
+    "web3"
+  ],
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/solana-labs/solana-web3.js"
+  },
+  "bugs": {
+    "url": "http://github.com/solana-labs/solana-web3.js/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ],
+  "dependencies": {
+    "@solana/errors": "2.0.0-20241006045741",
+    "@solana/rpc-spec-types": "2.0.0-20241006045741",
+    "@solana/promises": "2.0.0-20241006045741",
+    "@solana/subscribable": "2.0.0-20241006045741"
+  },
+  "peerDependencies": {
+    "typescript": ">=5"
+  },
+  "bundlewatch": {
+    "defaultCompression": "gzip",
+    "files": [
+      {
+        "path": "./dist/index*.js"
+      }
+    ]
+  },
+  "scripts": {
+    "compile:js": "tsup --config build-scripts/tsup.config.package.ts",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+    "dev": "jest -c ../../node_modules/@solana/test-config/jest-dev.config.ts --rootDir . --watch",
+    "publish-impl": "npm view $npm_package_name@$npm_package_version > /dev/null 2>&1 || pnpm publish --tag ${PUBLISH_TAG:-canary} --access public --no-git-checks",
+    "publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
+    "style:fix": "pnpm eslint --fix src && pnpm prettier --log-level warn --ignore-unknown --write ./*",
+    "test:lint": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-lint.config.ts --rootDir . --silent",
+    "test:prettier": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-prettier.config.ts --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.mjs",
+    "test:treeshakability:native": "agadoo dist/index.native.mjs",
+    "test:treeshakability:node": "agadoo dist/index.node.mjs",
+    "test:typecheck": "tsc --noEmit",
+    "test:unit:browser": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.browser.ts --rootDir . --silent",
+    "test:unit:node": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.node.ts --rootDir . --silent"
+  }
+}