@solana/rpc-subscriptions-api 2.0.0-20241006045741

package/dist/types/root-notifications.d.ts

@@ -0,0 +1,10 @@
+import type { Slot } from '@solana/rpc-types';
+type RootNotificationsApiNotification = Slot;
+export type RootNotificationsApi = {
+    /**
+     * Subscribe to receive notification anytime a new root is set by the validator
+     */
+    rootNotifications(NO_CONFIG?: Record<string, never>): RootNotificationsApiNotification;
+};
+export {};
+//# sourceMappingURL=root-notifications.d.ts.map

package/dist/types/root-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-notifications.d.ts","sourceRoot":"","sources":["../../src/root-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAE9C,KAAK,gCAAgC,GAAG,IAAI,CAAC;AAE7C,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,iBAAiB,CAEb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAClC,gCAAgC,CAAC;CACvC,CAAC"}

package/dist/types/signature-notifications.d.ts

@@ -0,0 +1,24 @@
+import type { Signature } from '@solana/keys';
+import type { Commitment, SolanaRpcResponse, TransactionError } from '@solana/rpc-types';
+type SignatureNotificationsApiNotificationReceived = SolanaRpcResponse<Readonly<string>>;
+type SignatureNotificationsApiNotificationProcessed = SolanaRpcResponse<Readonly<{
+    err: TransactionError | null;
+}>>;
+type SignatureNotificationsApiConfigBase = Readonly<{
+    commitment?: Commitment;
+}>;
+export type SignatureNotificationsApi = {
+    /**
+     * Subscribe to a transaction signature to receive notification when a given transaction is committed.
+     * On `signatureNotification` - the subscription is automatically cancelled.
+     * The signature must be a txid, the first signature of a transaction.
+     */
+    signatureNotifications(signature: Signature, config: Readonly<{
+        enableReceivedNotification: true;
+    }> & SignatureNotificationsApiConfigBase): SignatureNotificationsApiNotificationProcessed | SignatureNotificationsApiNotificationReceived;
+    signatureNotifications(signature: Signature, config?: Readonly<{
+        enableReceivedNotification?: false;
+    }> & SignatureNotificationsApiConfigBase): SignatureNotificationsApiNotificationProcessed;
+};
+export {};
+//# sourceMappingURL=signature-notifications.d.ts.map

package/dist/types/signature-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature-notifications.d.ts","sourceRoot":"","sources":["../../src/signature-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAEzF,KAAK,6CAA6C,GAAG,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAEzF,KAAK,8CAA8C,GAAG,iBAAiB,CACnE,QAAQ,CAAC;IAEL,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAChC,CAAC,CACL,CAAC;AAEF,KAAK,mCAAmC,GAAG,QAAQ,CAAC;IAChD,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG;IACpC;;;;OAIG;IACH,sBAAsB,CAElB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,QAAQ,CAAC;QAGb,0BAA0B,EAAE,IAAI,CAAC;KACpC,CAAC,GACE,mCAAmC,GACxC,8CAA8C,GAAG,6CAA6C,CAAC;IAClG,sBAAsB,CAClB,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,QAAQ,CAAC;QACd,0BAA0B,CAAC,EAAE,KAAK,CAAC;KACtC,CAAC,GACE,mCAAmC,GACxC,8CAA8C,CAAC;CACrD,CAAC"}

package/dist/types/slot-notifications.d.ts

@@ -0,0 +1,14 @@
+import type { Slot } from '@solana/rpc-types';
+type SlotNotificationsApiNotification = Readonly<{
+    parent: Slot;
+    root: Slot;
+    slot: Slot;
+}>;
+export type SlotNotificationsApi = {
+    /**
+     * Subscribe to receive notification anytime a slot is processed by the validator
+     */
+    slotNotifications(NO_CONFIG?: Record<string, never>): SlotNotificationsApiNotification;
+};
+export {};
+//# sourceMappingURL=slot-notifications.d.ts.map

package/dist/types/slot-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slot-notifications.d.ts","sourceRoot":"","sources":["../../src/slot-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAE9C,KAAK,gCAAgC,GAAG,QAAQ,CAAC;IAC7C,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;CACd,CAAC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,iBAAiB,CAEb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAClC,gCAAgC,CAAC;CACvC,CAAC"}

package/dist/types/slots-updates-notifications.d.ts

@@ -0,0 +1,32 @@
+import type { Slot, U64UnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
+type SlotsUpdatesNotificationsApiNotificationBase = Readonly<{
+    slot: Slot;
+    timestamp: U64UnsafeBeyond2Pow53Minus1;
+    type: 'completed' | 'firstShredReceived' | 'optimisticConfirmation' | 'root';
+}>;
+type SlotsUpdatesNotificationsApiNotificationCreatedBank = Readonly<{
+    parent: Slot;
+    type: 'createdBank';
+}> & SlotsUpdatesNotificationsApiNotificationBase;
+type SlotsUpdatesNotificationsApiNotificationDead = Readonly<{
+    err: string;
+    type: 'dead';
+}> & SlotsUpdatesNotificationsApiNotificationBase;
+type SlotsUpdatesNotificationsApiNotificationFrozen = Readonly<{
+    stats: Readonly<{
+        maxTransactionsPerEntry: U64UnsafeBeyond2Pow53Minus1;
+        numFailedTransactions: U64UnsafeBeyond2Pow53Minus1;
+        numSuccessfulTransactions: U64UnsafeBeyond2Pow53Minus1;
+        numTransactionEntries: U64UnsafeBeyond2Pow53Minus1;
+    }>;
+    type: 'frozen';
+}> & SlotsUpdatesNotificationsApiNotificationBase;
+type SlotsUpdatesNotificationsApiNotification = SlotsUpdatesNotificationsApiNotificationBase | SlotsUpdatesNotificationsApiNotificationCreatedBank | SlotsUpdatesNotificationsApiNotificationDead | SlotsUpdatesNotificationsApiNotificationFrozen;
+export type SlotsUpdatesNotificationsApi = {
+    /**
+     * Subscribe to receive a notification from the validator on a variety of updates on every slot
+     */
+    slotsUpdatesNotifications(NO_CONFIG?: Record<string, never>): SlotsUpdatesNotificationsApiNotification;
+};
+export {};
+//# sourceMappingURL=slots-updates-notifications.d.ts.map

package/dist/types/slots-updates-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slots-updates-notifications.d.ts","sourceRoot":"","sources":["../../src/slots-updates-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AAE3E,KAAK,4CAA4C,GAAG,QAAQ,CAAC;IACzD,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,2BAA2B,CAAC;IACvC,IAAI,EAAE,WAAW,GAAG,oBAAoB,GAAG,wBAAwB,GAAG,MAAM,CAAC;CAChF,CAAC,CAAC;AAEH,KAAK,mDAAmD,GAAG,QAAQ,CAAC;IAChE,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;CACvB,CAAC,GACE,4CAA4C,CAAC;AAEjD,KAAK,4CAA4C,GAAG,QAAQ,CAAC;IACzD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC,GACE,4CAA4C,CAAC;AAEjD,KAAK,8CAA8C,GAAG,QAAQ,CAAC;IAC3D,KAAK,EAAE,QAAQ,CAAC;QACZ,uBAAuB,EAAE,2BAA2B,CAAC;QACrD,qBAAqB,EAAE,2BAA2B,CAAC;QACnD,yBAAyB,EAAE,2BAA2B,CAAC;QACvD,qBAAqB,EAAE,2BAA2B,CAAC;KACtD,CAAC,CAAC;IACH,IAAI,EAAE,QAAQ,CAAC;CAClB,CAAC,GACE,4CAA4C,CAAC;AAEjD,KAAK,wCAAwC,GACvC,4CAA4C,GAC5C,mDAAmD,GACnD,4CAA4C,GAC5C,8CAA8C,CAAC;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACvC;;OAEG;IACH,yBAAyB,CAErB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAClC,wCAAwC,CAAC;CAC/C,CAAC"}

package/dist/types/vote-notifications.d.ts

@@ -0,0 +1,18 @@
+import type { Address } from '@solana/addresses';
+import type { Signature } from '@solana/keys';
+import type { Blockhash, Slot, UnixTimestampUnsafeBeyond2Pow53Minus1 } from '@solana/rpc-types';
+type VoteNotificationsApiNotification = Readonly<{
+    hash: Blockhash;
+    signature: Signature;
+    slots: readonly Slot[];
+    timestamp: UnixTimestampUnsafeBeyond2Pow53Minus1 | null;
+    votePubkey: Address;
+}>;
+export type VoteNotificationsApi = {
+    /**
+     * Subscribe to receive a notification from the validator on a variety of updates on every slot
+     */
+    voteNotifications(NO_CONFIG?: Record<string, never>): VoteNotificationsApiNotification;
+};
+export {};
+//# sourceMappingURL=vote-notifications.d.ts.map

package/dist/types/vote-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vote-notifications.d.ts","sourceRoot":"","sources":["../../src/vote-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,qCAAqC,EAAE,MAAM,mBAAmB,CAAC;AAEhG,KAAK,gCAAgC,GAAG,QAAQ,CAAC;IAC7C,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;IACvB,SAAS,EAAE,qCAAqC,GAAG,IAAI,CAAC;IACxD,UAAU,EAAE,OAAO,CAAC;CACvB,CAAC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,iBAAiB,CAEb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAClC,gCAAgC,CAAC;CACvC,CAAC"}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@solana/rpc-subscriptions-api",
+  "version": "2.0.0-20241006045741",
+  "description": "Defines all default Solana RPC subscriptions as types",
+  "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/addresses": "2.0.0-20241006045741",
+    "@solana/keys": "2.0.0-20241006045741",
+    "@solana/rpc-subscriptions-spec": "2.0.0-20241006045741",
+    "@solana/fast-stable-stringify": "2.0.0-20241006045741",
+    "@solana/rpc-transformers": "2.0.0-20241006045741",
+    "@solana/rpc-types": "2.0.0-20241006045741",
+    "@solana/transaction-messages": "2.0.0-20241006045741",
+    "@solana/transactions": "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 --globalSetup @solana/test-config/test-validator-setup.js --globalTeardown @solana/test-config/test-validator-teardown.js --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 --globalSetup @solana/test-config/test-validator-setup.js --globalTeardown @solana/test-config/test-validator-teardown.js --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 --globalSetup @solana/test-config/test-validator-setup.js --globalTeardown @solana/test-config/test-validator-teardown.js --rootDir . --silent"
+  }
+}