npm - @solana/rpc-subscriptions-spec - Versions diffs - 2.0.0-experimental.021706b - Mend

@solana/rpc-subscriptions-spec 2.0.0-experimental.021706b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/LICENSE +20 -0
package/README.md +17 -0
package/dist/index.browser.cjs +132 -0
package/dist/index.browser.cjs.map +1 -0
package/dist/index.browser.js +129 -0
package/dist/index.browser.js.map +1 -0
package/dist/index.native.js +129 -0
package/dist/index.native.js.map +1 -0
package/dist/index.node.cjs +132 -0
package/dist/index.node.cjs.map +1 -0
package/dist/index.node.js +129 -0
package/dist/index.node.js.map +1 -0
package/dist/types/index.d.ts +5 -0
package/dist/types/index.d.ts.map +1 -0
package/dist/types/rpc-subscriptions-api.d.ts +19 -0
package/dist/types/rpc-subscriptions-api.d.ts.map +1 -0
package/dist/types/rpc-subscriptions-request.d.ts +13 -0
package/dist/types/rpc-subscriptions-request.d.ts.map +1 -0
package/dist/types/rpc-subscriptions-transport.d.ts +11 -0
package/dist/types/rpc-subscriptions-transport.d.ts.map +1 -0
package/dist/types/rpc-subscriptions.d.ts +18 -0
package/dist/types/rpc-subscriptions.d.ts.map +1 -0
package/package.json +75 -0

package/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Solana Labs, Inc
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,17 @@
+[![npm][npm-image]][npm-url]
+[![npm-downloads][npm-downloads-image]][npm-url]
+[![semantic-release][semantic-release-image]][semantic-release-url]
+<br />
+[![code-style-prettier][code-style-prettier-image]][code-style-prettier-url]
+[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
+[code-style-prettier-url]: https://github.com/prettier/prettier
+[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/rpc-subscriptions-spec/experimental.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/@solana/rpc-subscriptions-spec/experimental.svg?style=flat
+[npm-url]: https://www.npmjs.com/package/@solana/rpc-subscriptions-spec/v/experimental
+[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-url]: https://github.com/semantic-release/semantic-release
+# @solana/rpc-subscriptions-spec
+TODO

package/dist/index.browser.cjs ADDED Viewed

@@ -0,0 +1,132 @@
+'use strict';
+var rpcSpecTypes = require('@solana/rpc-spec-types');
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return makeProxy(rpcConfig);
+}
+function makeProxy(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 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 = rpcSpecTypes.createRpcMessage(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 = rpcSpecTypes.createRpcMessage(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 rpcSpecTypes.RpcError(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;
+          }
+        }
+      };
+    }
+  };
+}
+// src/rpc-subscriptions-api.ts
+function createRpcSubscriptionsApi(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
+        };
+      };
+    }
+  });
+}
+exports.createRpcSubscriptionsApi = createRpcSubscriptionsApi;
+exports.createSubscriptionRpc = createSubscriptionRpc;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.cjs.map

package/dist/index.browser.cjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/rpc-subscriptions.ts","../src/rpc-subscriptions-api.ts"],"names":[],"mappings":";AAAA;AAAA,EAEI;AAAA,EAGA;AAAA,OAGG;AAiDA,SAAS,sBAIZ,WAC6C;AAC7C,SAAO,UAAU,SAAS;AAC9B;AAEA,SAAS,UACL,WAC6C;AAC7C,SAAO,IAAI,MAAM,UAAU,KAAK;AAAA,IAC5B,iBAAiB;AACb,aAAO;AAAA,IACX;AAAA,IACA,iBAAiB;AACb,aAAO;AAAA,IACX;AAAA,IACA,IAAI,QAAQ,GAAG,UAAU;AACrB,aAAO,YAAa,WAAsB;AACtC,cAAM,aAAa,EAAE,SAAS;AAC9B,cAAM,wBAAwB,QAAQ,IAAI,QAAQ,YAAY,QAAQ;AACtE,YAAI,EAAE,SAAS,EAAE,SAAS,eAAe,MAAM,SAAS,CAAC,uBAAuB;AAE5E,gBAAM,IAAI;AAAA,YACN;AAAA,UAGJ;AAAA,QACJ;AACA,cAAM,aAAa,wBACb,sBAAsB,GAAG,SAAS,IAClC;AAAA,UACI,QAAQ;AAAA,UACR,qBAAqB,WAAW,QAAQ,kBAAkB,WAAW;AAAA,UACrE,uBAAuB,WAAW,QAAQ,kBAAkB,aAAa;AAAA,QAC7E;AACN,eAAO,6BAA6B,WAAW,UAAU;AAAA,MAC7D;AAAA,IACJ;AAAA,EACJ,CAAC;AACL;AAEA,SAAS,wBAAwB,UAAkC,WAA6B;AAC5F,GAAC,YAAY;AACT,QAAI;AAEA,uBAAiB,KAAK;AAAS;AAAA,IACnC,QAAQ;AAAA,IAER,UAAE;AAEE,gBAAU;AAAA,IACd;AAAA,EACJ,GAAG;AACP;AAEA,SAAS,6BAKL,WACA,EAAE,QAAQ,qBAAqB,uBAAuB,oBAAoB,GAC7B;AAC7C,SAAO;AAAA,IACH,MAAM,UAAU,EAAE,YAAY,GAA+D;AACzF,kBAAY,eAAe;AAC3B,UAAI;AACJ,eAAS,gBAAgB;AACrB,YAAI,mBAAmB,QAAW;AAC9B,gBAAM,UAAU,iBAAiB,uBAAuB,CAAC,cAAc,CAAC;AACxE,qBAAW,qCAAqC,OAAO,EAAE,QAAQ,MAAM;AACnE,sCAA0B,MAAM;AAAA,UACpC,CAAC;AAAA,QACL,OAAO;AACH,oCAA0B,MAAM;AAAA,QACpC;AAAA,MACJ;AACA,kBAAY,iBAAiB,SAAS,aAAa;AAInD,YAAM,4BAA4B,IAAI,gBAAgB;AACtD,YAAM,mBAAmB,iBAAiB,qBAAqB,MAAM;AACrE,YAAM,aAAa,MAAM,UAAU,UAAU;AAAA,QACzC,SAAS;AAAA,QACT,QAAQ,0BAA0B;AAAA,MACtC,CAAC;AACD,eAAS,0BAA0B;AAC/B,oBAAY,oBAAoB,SAAS,aAAa;AAAA,MAC1D;AACA,8BAAwB,YAAY,uBAAuB;AAI3D,uBAAiB,WAAW,YAEzB;AACC,YAAI,QAAQ,WAAW,QAAQ,OAAO,iBAAiB,IAAI;AACvD,cAAI,WAAW,SAAS;AACpB,kBAAM,IAAI,SAAS,QAAQ,KAAK;AAAA,UACpC,OAAO;AACH,6BAAiB,QAAQ;AACzB;AAAA,UACJ;AAAA,QACJ;AAAA,MACJ;AACA,UAAI,kBAAkB,MAAM;AAExB,cAAM,IAAI,MAAM,oDAAoD;AAAA,MACxE;AAIA,aAAO;AAAA,QACH,QAAQ,OAAO,aAAa,IAAI;AAC5B,2BAAiB,WAAW,YAEzB;AACC,gBAAI,EAAE,YAAY,YAAY,QAAQ,OAAO,iBAAiB,gBAAgB;AAC1E;AAAA,YACJ;AACA,kBAAM,eAAe,QAAQ,OAAO;AACpC,kBAAM,sBACA,oBAAoB,cAAc,mBAAmB,IACrD;AAAA,UACV;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ;;;ACnKO,SAAS,0BACZ,QACgD;AAChD,SAAO,IAAI,MAAM,CAAC,GAAuD;AAAA,IACrE,iBAAiB;AACb,aAAO;AAAA,IACX;AAAA,IACA,iBAAiB;AACb,aAAO;AAAA,IACX;AAAA,IACA,OACO,MACL;AACE,YAAM,CAAC,GAAG,CAAC,IAAI;AACf,YAAM,mBAAmB,EAAE,SAAS;AACpC,aAAO,YACA,WAKgF;AACnF,cAAM,SAAS,QAAQ,wBACjB,QAAQ,sBAAsB,WAAW,gBAAgB,IACzD;AACN,cAAM,sBAAsB,QAAQ,sBAC9B,QAAQ,sBACR,CAAC,gBACG;AACV,cAAM,sBAAsB,QAAQ,uCAC9B,QAAQ,qCAAqC,gBAAgB,IAC7D;AACN,cAAM,wBAAwB,QAAQ,yCAChC,QAAQ,uCAAuC,gBAAgB,IAC/D;AACN,eAAO;AAAA,UACH;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ,CAAC;AACL","sourcesContent":["import {\n Callable,\n createRpcMessage,\n Flatten,\n OverloadImplementations,\n RpcError,\n RpcResponse,\n UnionToIntersection,\n} from '@solana/rpc-spec-types';\n\nimport { RpcSubscriptionsApi } from './rpc-subscriptions-api';\nimport {\n PendingRpcSubscriptionsRequest,\n RpcSubscribeOptions,\n RpcSubscriptionsRequest,\n} from './rpc-subscriptions-request';\nimport { RpcSubscriptionsTransport } from './rpc-subscriptions-transport';\n\nexport type RpcSubscriptionsConfig<\n TRpcMethods,\n TRpcSubscriptionsTransport extends RpcSubscriptionsTransport,\n> = Readonly<{\n api: RpcSubscriptionsApi<TRpcMethods>;\n transport: TRpcSubscriptionsTransport;\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\ntype RpcNotification<TNotification> = Readonly<{\n params: Readonly<{\n result: TNotification;\n subscription: number;\n }>;\n}>;\n\ntype RpcSubscriptionId = number;\n\nexport function createSubscriptionRpc<\n TRpcSubscriptionsApiMethods,\n TRpcSubscriptionsTransport extends RpcSubscriptionsTransport,\n>(\n rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods, TRpcSubscriptionsTransport>,\n): RpcSubscriptions<TRpcSubscriptionsApiMethods> {\n return makeProxy(rpcConfig);\n}\n\nfunction makeProxy<TRpcSubscriptionsApiMethods, TRpcSubscriptionsTransport extends RpcSubscriptionsTransport>(\n rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods, TRpcSubscriptionsTransport>,\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 methodName = p.toString();\n const createRpcSubscription = Reflect.get(target, methodName, receiver);\n if (p.toString().endsWith('Notifications') === false && !createRpcSubscription) {\n // TODO: Coded error.\n throw new Error(\n \"Either the notification name must end in 'Notifications' or the API \" +\n 'must supply a subscription creator function to map between the ' +\n 'notification name and the subscribe/unsubscribe method names.',\n );\n }\n const newRequest = createRpcSubscription\n ? createRpcSubscription(...rawParams)\n : {\n params: rawParams,\n subscribeMethodName: methodName.replace(/Notifications$/, 'Subscribe'),\n unsubscribeMethodName: methodName.replace(/Notifications$/, 'Unsubscribe'),\n };\n return createPendingRpcSubscription(rpcConfig, newRequest);\n };\n },\n }) as RpcSubscriptions<TRpcSubscriptionsApiMethods>;\n}\n\nfunction registerIterableCleanup(iterable: AsyncIterable<unknown>, cleanupFn: CallableFunction) {\n (async () => {\n try {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n for await (const _ of iterable);\n } catch {\n /* empty */\n } finally {\n // Run the cleanup function.\n cleanupFn();\n }\n })();\n}\n\nfunction createPendingRpcSubscription<\n TRpcSubscriptionsApiMethods,\n TRpcSubscriptionsTransport extends RpcSubscriptionsTransport,\n TNotification,\n>(\n rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods, TRpcSubscriptionsTransport>,\n { params, subscribeMethodName, unsubscribeMethodName, responseTransformer }: RpcSubscriptionsRequest<TNotification>,\n): PendingRpcSubscriptionsRequest<TNotification> {\n return {\n async subscribe({ abortSignal }: RpcSubscribeOptions): Promise<AsyncIterable<TNotification>> {\n abortSignal.throwIfAborted();\n let subscriptionId: number | undefined;\n function handleCleanup() {\n if (subscriptionId !== undefined) {\n const payload = createRpcMessage(unsubscribeMethodName, [subscriptionId]);\n connection.send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED(payload).finally(() => {\n connectionAbortController.abort();\n });\n } else {\n connectionAbortController.abort();\n }\n }\n abortSignal.addEventListener('abort', handleCleanup);\n /**\n * STEP 1: Send the subscribe message.\n */\n const connectionAbortController = new AbortController();\n const subscribeMessage = createRpcMessage(subscribeMethodName, params);\n const connection = await rpcConfig.transport({\n payload: subscribeMessage,\n signal: connectionAbortController.signal,\n });\n function handleConnectionCleanup() {\n abortSignal.removeEventListener('abort', handleCleanup);\n }\n registerIterableCleanup(connection, handleConnectionCleanup);\n /**\n * STEP 2: Wait for the acknowledgement from the server with the subscription id.\n */\n for await (const message of connection as AsyncIterable<\n RpcNotification<unknown> | RpcResponse<RpcSubscriptionId>\n >) {\n if ('id' in message && message.id === subscribeMessage.id) {\n if ('error' in message) {\n throw new RpcError(message.error);\n } else {\n subscriptionId = message.result as RpcSubscriptionId;\n break;\n }\n }\n }\n if (subscriptionId == null) {\n // TODO: Coded error.\n throw new Error('Failed to obtain a subscription id from the server');\n }\n /**\n * STEP 3: Return an iterable that yields notifications for this subscription id.\n */\n return {\n async *[Symbol.asyncIterator]() {\n for await (const message of connection as AsyncIterable<\n RpcNotification<unknown> | RpcResponse<RpcSubscriptionId>\n >) {\n if (!('params' in message) || message.params.subscription !== subscriptionId) {\n continue;\n }\n const notification = message.params.result as TNotification;\n yield responseTransformer\n ? responseTransformer(notification, subscribeMethodName)\n : notification;\n }\n },\n };\n },\n };\n}\n","import { Callable } from '@solana/rpc-spec-types';\n\nimport { RpcSubscriptionsRequest } from './rpc-subscriptions-request';\n\nexport type RpcSubscriptionsApiConfig = Readonly<{\n parametersTransformer?: <T extends unknown[]>(params: T, notificationName: string) => unknown[];\n responseTransformer?: <T>(response: unknown, notificationName: string) => T;\n subscribeNotificationNameTransformer?: (notificationName: string) => string;\n unsubscribeNotificationNameTransformer?: (notificationName: string) => string;\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[]) => RpcSubscriptionsRequest<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\nexport function createRpcSubscriptionsApi<TRpcSubscriptionsApiMethods extends RpcSubscriptionsApiMethods>(\n config?: RpcSubscriptionsApiConfig,\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 ...rawParams: Parameters<\n TRpcSubscriptionsApiMethods[TNotificationName] extends CallableFunction\n ? TRpcSubscriptionsApiMethods[TNotificationName]\n : never\n >\n ): RpcSubscriptionsRequest<ReturnType<TRpcSubscriptionsApiMethods[TNotificationName]>> {\n const params = config?.parametersTransformer\n ? config?.parametersTransformer(rawParams, notificationName)\n : rawParams;\n const responseTransformer = config?.responseTransformer\n ? config?.responseTransformer<ReturnType<TRpcSubscriptionsApiMethods[TNotificationName]>>\n : (rawResponse: unknown) =>\n rawResponse as ReturnType<TRpcSubscriptionsApiMethods[TNotificationName]>;\n const subscribeMethodName = config?.subscribeNotificationNameTransformer\n ? config?.subscribeNotificationNameTransformer(notificationName)\n : notificationName;\n const unsubscribeMethodName = config?.unsubscribeNotificationNameTransformer\n ? config?.unsubscribeNotificationNameTransformer(notificationName)\n : notificationName;\n return {\n params,\n responseTransformer,\n subscribeMethodName,\n unsubscribeMethodName,\n };\n };\n },\n });\n}\n"]}

package/dist/index.browser.js ADDED Viewed

@@ -0,0 +1,129 @@
+import { createRpcMessage, RpcError } from '@solana/rpc-spec-types';
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return makeProxy(rpcConfig);
+}
+function makeProxy(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 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 = createRpcMessage(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 = createRpcMessage(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 RpcError(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;
+          }
+        }
+      };
+    }
+  };
+}
+// src/rpc-subscriptions-api.ts
+function createRpcSubscriptionsApi(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
+        };
+      };
+    }
+  });
+}
+export { createRpcSubscriptionsApi, createSubscriptionRpc };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.native.js ADDED Viewed

@@ -0,0 +1,129 @@
+import { createRpcMessage, RpcError } from '@solana/rpc-spec-types';
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return makeProxy(rpcConfig);
+}
+function makeProxy(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 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 = createRpcMessage(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 = createRpcMessage(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 RpcError(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;
+          }
+        }
+      };
+    }
+  };
+}
+// src/rpc-subscriptions-api.ts
+function createRpcSubscriptionsApi(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
+        };
+      };
+    }
+  });
+}
+export { createRpcSubscriptionsApi, createSubscriptionRpc };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.native.js.map

package/dist/index.native.js.map ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.node.cjs ADDED Viewed

@@ -0,0 +1,132 @@
+'use strict';
+var rpcSpecTypes = require('@solana/rpc-spec-types');
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return makeProxy(rpcConfig);
+}
+function makeProxy(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 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 = rpcSpecTypes.createRpcMessage(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 = rpcSpecTypes.createRpcMessage(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 rpcSpecTypes.RpcError(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;
+          }
+        }
+      };
+    }
+  };
+}
+// src/rpc-subscriptions-api.ts
+function createRpcSubscriptionsApi(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
+        };
+      };
+    }
+  });
+}
+exports.createRpcSubscriptionsApi = createRpcSubscriptionsApi;
+exports.createSubscriptionRpc = createSubscriptionRpc;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.node.cjs.map

package/dist/index.node.cjs.map ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.node.js ADDED Viewed

@@ -0,0 +1,129 @@
+import { createRpcMessage, RpcError } from '@solana/rpc-spec-types';
+// src/rpc-subscriptions.ts
+function createSubscriptionRpc(rpcConfig) {
+  return makeProxy(rpcConfig);
+}
+function makeProxy(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 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 = createRpcMessage(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 = createRpcMessage(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 RpcError(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;
+          }
+        }
+      };
+    }
+  };
+}
+// src/rpc-subscriptions-api.ts
+function createRpcSubscriptionsApi(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
+        };
+      };
+    }
+  });
+}
+export { createRpcSubscriptionsApi, createSubscriptionRpc };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.node.js.map

package/dist/index.node.js.map ADDED Viewed

@@ -0,0 +1 @@

package/dist/types/index.d.ts ADDED Viewed

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

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

	@@ -0,0 +1 @@
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,+BAA+B,CAAC"}

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

@@ -0,0 +1,19 @@
+import { Callable } from '@solana/rpc-spec-types';
+import { RpcSubscriptionsRequest } from './rpc-subscriptions-request.js';
+export type RpcSubscriptionsApiConfig = Readonly<{
+    parametersTransformer?: <T extends unknown[]>(params: T, notificationName: string) => unknown[];
+    responseTransformer?: <T>(response: unknown, notificationName: string) => T;
+    subscribeNotificationNameTransformer?: (notificationName: string) => string;
+    unsubscribeNotificationNameTransformer?: (notificationName: string) => string;
+}>;
+export type RpcSubscriptionsApi<TRpcSubscriptionMethods> = {
+    [MethodName in keyof TRpcSubscriptionMethods]: RpcSubscriptionsReturnTypeMapper<TRpcSubscriptionMethods[MethodName]>;
+};
+type RpcSubscriptionsReturnTypeMapper<TRpcMethod> = TRpcMethod extends Callable ? (...rawParams: unknown[]) => RpcSubscriptionsRequest<ReturnType<TRpcMethod>> : never;
+type RpcSubscriptionsApiMethod = (...args: any) => any;
+export interface RpcSubscriptionsApiMethods {
+    [methodName: string]: RpcSubscriptionsApiMethod;
+}
+export declare function createRpcSubscriptionsApi<TRpcSubscriptionsApiMethods extends RpcSubscriptionsApiMethods>(config?: RpcSubscriptionsApiConfig): RpcSubscriptionsApi<TRpcSubscriptionsApiMethods>;
+export {};
+//# sourceMappingURL=rpc-subscriptions-api.d.ts.map

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

@@ -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;AAElD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAAC;IAC7C,qBAAqB,CAAC,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,gBAAgB,EAAE,MAAM,KAAK,OAAO,EAAE,CAAC;IAChG,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAC,CAAC;IAC5E,oCAAoC,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,MAAM,CAAC;IAC5E,sCAAsC,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,MAAM,CAAC;CACjF,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,uBAAuB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAC5E,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;AAED,wBAAgB,yBAAyB,CAAC,2BAA2B,SAAS,0BAA0B,EACpG,MAAM,CAAC,EAAE,yBAAyB,GACnC,mBAAmB,CAAC,2BAA2B,CAAC,CA0ClD"}

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,11 @@
+type RpcSubscriptionsTransportConfig = Readonly<{
+    payload: unknown;
+    signal: AbortSignal;
+}>;
+export interface RpcSubscriptionsTransport {
+    (config: RpcSubscriptionsTransportConfig): Promise<Readonly<AsyncIterable<unknown> & {
+        send_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: (payload: unknown) => Promise<void>;
+    }>>;
+}
+export {};
+//# sourceMappingURL=rpc-subscriptions-transport.d.ts.map

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

@@ -0,0 +1 @@

+ {"version":3,"file":"rpc-subscriptions-transport.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions-transport.ts"],"names":[],"mappings":"AAAA,KAAK,+BAA+B,GAAG,QAAQ,CAAC;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;CACvB,CAAC,CAAC;AAEH,MAAM,WAAW,yBAAyB;IACtC,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAC9C,QAAQ,CACJ,aAAa,CAAC,OAAO,CAAC,GAAG;QACrB,oCAAoC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KAC7E,CACJ,CACJ,CAAC;CACL"}

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

@@ -0,0 +1,18 @@
+import { Callable, Flatten, OverloadImplementations, UnionToIntersection } from '@solana/rpc-spec-types';
+import { RpcSubscriptionsApi } from './rpc-subscriptions-api.js';
+import { PendingRpcSubscriptionsRequest } from './rpc-subscriptions-request.js';
+import { RpcSubscriptionsTransport } from './rpc-subscriptions-transport.js';
+export type RpcSubscriptionsConfig<TRpcMethods, TRpcSubscriptionsTransport extends RpcSubscriptionsTransport> = Readonly<{
+    api: RpcSubscriptionsApi<TRpcMethods>;
+    transport: TRpcSubscriptionsTransport;
+}>;
+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, TRpcSubscriptionsTransport extends RpcSubscriptionsTransport>(rpcConfig: RpcSubscriptionsConfig<TRpcSubscriptionsApiMethods, TRpcSubscriptionsTransport>): RpcSubscriptions<TRpcSubscriptionsApiMethods>;
+export {};
+//# sourceMappingURL=rpc-subscriptions.d.ts.map

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

@@ -0,0 +1 @@

+ {"version":3,"file":"rpc-subscriptions.d.ts","sourceRoot":"","sources":["../../src/rpc-subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EAER,OAAO,EACP,uBAAuB,EAGvB,mBAAmB,EACtB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EACH,8BAA8B,EAGjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,MAAM,MAAM,sBAAsB,CAC9B,WAAW,EACX,0BAA0B,SAAS,yBAAyB,IAC5D,QAAQ,CAAC;IACT,GAAG,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACtC,SAAS,EAAE,0BAA0B,CAAC;CACzC,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;AAWhB,wBAAgB,qBAAqB,CACjC,2BAA2B,EAC3B,0BAA0B,SAAS,yBAAyB,EAE5D,SAAS,EAAE,sBAAsB,CAAC,2BAA2B,EAAE,0BAA0B,CAAC,GAC3F,gBAAgB,CAAC,2BAA2B,CAAC,CAE/C"}

package/package.json ADDED Viewed

@@ -0,0 +1,75 @@
+{
+  "name": "@solana/rpc-subscriptions-spec",
+  "version": "2.0.0-experimental.021706b",
+  "description": "A generic implementation of JSON RPC Subscriptions using proxies",
+  "exports": {
+    "browser": {
+      "import": "./dist/index.browser.js",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.js",
+      "require": "./dist/index.node.cjs"
+    },
+    "react-native": "./dist/index.native.js",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.js": "./dist/index.browser.js"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.js",
+  "react-native": "./dist/index.native.js",
+  "types": "./dist/types/index.d.ts",
+  "type": "module",
+  "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/rpc-spec-types": "2.0.0-experimental.021706b"
+  },
+  "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 && node node_modules/@solana/build-scripts/add-js-extension-to-types.mjs",
+    "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 experimental --access public --no-git-checks",
+    "publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
+    "style:fix": "pnpm eslint --fix src/* && pnpm prettier -w src/* package.json",
+    "test:lint": "jest -c node_modules/@solana/test-config/jest-lint.config.ts --rootDir . --silent",
+    "test:prettier": "jest -c node_modules/@solana/test-config/jest-prettier.config.ts --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.js",
+    "test:treeshakability:native": "agadoo dist/index.native.js",
+    "test:treeshakability:node": "agadoo dist/index.node.js",
+    "test:typecheck": "tsc --noEmit",
+    "test:unit:browser": "jest -c node_modules/@solana/test-config/jest-unit.config.browser.ts --rootDir . --silent",
+    "test:unit:node": "jest -c node_modules/@solana/test-config/jest-unit.config.node.ts --rootDir . --silent"
+  }
+}