@mysten/sui 2.10.0 → 2.12.0

package/dist/zklogin/bcs.d.mts

@@ -1,31 +1,31 @@
-import * as _mysten_bcs810 from "@mysten/bcs";
+import * as _mysten_bcs1111 from "@mysten/bcs";
 import { InferBcsInput } from "@mysten/bcs";
 
 //#region src/zklogin/bcs.d.ts
-declare const zkLoginSignature: _mysten_bcs810.BcsStruct<{
-  inputs: _mysten_bcs810.BcsStruct<{
-    proofPoints: _mysten_bcs810.BcsStruct<{
-      a: _mysten_bcs810.BcsType<string[], Iterable<string> & {
+declare const zkLoginSignature: _mysten_bcs1111.BcsStruct<{
+  inputs: _mysten_bcs1111.BcsStruct<{
+    proofPoints: _mysten_bcs1111.BcsStruct<{
+      a: _mysten_bcs1111.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
-      b: _mysten_bcs810.BcsType<string[][], Iterable<Iterable<string> & {
+      b: _mysten_bcs1111.BcsType<string[][], Iterable<Iterable<string> & {
         length: number;
       }> & {
         length: number;
       }, string>;
-      c: _mysten_bcs810.BcsType<string[], Iterable<string> & {
+      c: _mysten_bcs1111.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
     }, string>;
-    issBase64Details: _mysten_bcs810.BcsStruct<{
-      value: _mysten_bcs810.BcsType<string, string, "string">;
-      indexMod4: _mysten_bcs810.BcsType<number, number, "u8">;
+    issBase64Details: _mysten_bcs1111.BcsStruct<{
+      value: _mysten_bcs1111.BcsType<string, string, "string">;
+      indexMod4: _mysten_bcs1111.BcsType<number, number, "u8">;
     }, string>;
-    headerBase64: _mysten_bcs810.BcsType<string, string, "string">;
-    addressSeed: _mysten_bcs810.BcsType<string, string, "string">;
+    headerBase64: _mysten_bcs1111.BcsType<string, string, "string">;
+    addressSeed: _mysten_bcs1111.BcsType<string, string, "string">;
   }, string>;
-  maxEpoch: _mysten_bcs810.BcsType<string, string | number | bigint, "u64">;
-  userSignature: _mysten_bcs810.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
+  maxEpoch: _mysten_bcs1111.BcsType<string, string | number | bigint, "u64">;
+  userSignature: _mysten_bcs1111.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
 }, string>;
 type ZkLoginSignature = InferBcsInput<typeof zkLoginSignature>;
 type ZkLoginSignatureInputs = ZkLoginSignature['inputs'];

package/dist/zklogin/bcs.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bcs.d.mts","names":[],"sources":["../../src/zklogin/bcs.ts"],"sourcesContent":[],"mappings":";;;;cAMa,iCAAgB;;;MAAhB,CAAA,wBAgBX,CAAA,MAAA,EAAA,UAAA,CAAA,MAAA,CAAA,GAAA;;;;;;;;;;;;;;;;;;;;eAhB2B,wBAAA,WAAA,gBAAA,CAAA,UAAA,CAAA,MAAA,CAAA,EAAA,YAAA,CAAA;CAAA,EAAA,MAAA,CAAA;AAkBjB,KAAA,gBAAA,GAAmB,aAAqB,CAAA,OAAA,gBAAR,CAAA;AAChC,KAAA,sBAAA,GAAyB,gBAAA,CAAA,QAAgB,CAAA"}
+{"version":3,"file":"bcs.d.mts","names":[],"sources":["../../src/zklogin/bcs.ts"],"sourcesContent":[],"mappings":";;;;cAMa,kCAAgB;;;MAAhB,CAAA,yBAgBX,CAAA,MAAA,EAAA,UAAA,CAAA,MAAA,CAAA,GAAA;;;;;;;;;;;;;;;;;;;;eAhB2B,yBAAA,WAAA,gBAAA,CAAA,UAAA,CAAA,MAAA,CAAA,EAAA,YAAA,CAAA;CAAA,EAAA,MAAA,CAAA;AAkBjB,KAAA,gBAAA,GAAmB,aAAqB,CAAA,OAAA,gBAAR,CAAA;AAChC,KAAA,sBAAA,GAAyB,gBAAA,CAAA,QAAgB,CAAA"}

package/docs/clients/core.md

@@ -342,6 +342,21 @@ console.log(result.effects);
 console.log(result.balanceChanges);
 ```
 
+#### Disabling Checks
+
+By default, `simulateTransaction` runs with full transaction validation. For example when inspecting
+non-public or non-entry Move functions set `checksEnabled: false`:
+
+```typescript
+const result = await client.core.simulateTransaction({
+	transaction: transactionBytes,
+	checksEnabled: false,
+	include: {
+		commandResults: true,
+	},
+});
+```
+
 ### signAndExecuteTransaction
 
 Sign and execute a transaction in one step.

package/docs/migrations/sui-2.0/json-rpc-migration.md

@@ -54,11 +54,27 @@ These JSON-RPC methods have direct replacements in the core API:
 | `multiGetObjects`            | `getObjects`                                      |
 | `getDynamicFields`           | `listDynamicFields`                               |
 | `getDynamicFieldObject`      | `getDynamicField`                                 |
-| `devInspectTransactionBlock` | `simulateTransaction`                             |
+| `devInspectTransactionBlock` | `simulateTransaction` with `checksEnabled: false` |
 | `dryRunTransactionBlock`     | `simulateTransaction`                             |
 | `getNormalizedMoveFunction`  | `getMoveFunction`                                 |
 | `getMoveFunctionArgTypes`    | `getMoveFunction`                                 |
 
+### Example: Migrating devInspectTransactionBlock
+
+```diff
+- const result = await jsonRpcClient.devInspectTransactionBlock({
+-   sender: '0xabc...',
+-   transactionBlock: tx,
+- });
+- const returnValues = result.results?.[0]?.returnValues;
++ const result = await client.core.simulateTransaction({
++   transaction: tx,
++   checksEnabled: false,
++   include: { commandResults: true },
++ });
++ const returnValues = result.commandResults?.[0]?.returnValues;
+```
+
 ### Example: Migrating getOwnedObjects
 
 ```diff

package/docs/utils/derived_objects.md

@@ -57,3 +57,24 @@ const key = bcsType.serialize({ value: 1 }).toBytes();
 // Derive the object ID for the key `DemoStruct { value: 1 }`.
 deriveObjectID('0xc0ffee', `0xc0ffee::demo::DemoStruct`, key);
 ```
+
+### Deriving with fieldless structs
+
+In Move, structs with no user-defined fields automatically get a `dummy_field: bool` injected by the
+compiler. This means their BCS encoding is not empty — it's a single `0x00` byte (the encoding of
+`false`). You can treat this as a constant.
+
+A real-world example is `0x2::coin_registry::CurrencyKey<T>`, which is a fieldless generic struct
+used to derive `Currency` objects from the coin registry (`0xc`) based on their type:
+
+```typescript
+// On-chain: `public struct CurrencyKey<phantom T>() has copy, store, drop`
+// The compiler injects `dummy_field: bool`, always `false`.
+const key = new Uint8Array([0]);
+
+const coinType = '0x2::sui::SUI';
+const currencyId = deriveObjectID('0xc', `0x2::coin_registry::CurrencyKey<${coinType}>`, key);
+```
+
+This applies to any struct with no fields — phantom type parameters don't add any BCS-encoded data,
+so the key is always `new Uint8Array([0])`.

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -142,7 +142,6 @@
     "@parcel/watcher": "^2.5.4",
     "@types/node": "^25.0.8",
     "@types/tmp": "^0.2.6",
-    "@types/ws": "^8.18.1",
     "cross-env": "^10.1.0",
     "graphql-config": "^5.1.5",
     "msw": "^2.12.7",
@@ -152,8 +151,7 @@
     "vite": "^7.3.1",
     "vite-tsconfig-paths": "^6.0.4",
     "vitest": "^4.0.17",
-    "wait-on": "^9.0.3",
-    "ws": "^8.19.0"
+    "wait-on": "^9.0.3"
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",

package/src/client/types.ts

@@ -442,6 +442,14 @@ export namespace SuiClientTypes {
 	> extends CoreClientMethodOptions {
 		transaction: Uint8Array | TransactionInstance;
 		include?: Include & SimulateTransactionInclude;
+		/**
+		 * When set to `false`, disables transaction validation checks during simulation.
+		 * This allows inspecting non-public/non-entry Move functions and other transactions
+		 * that would normally fail validation.
+		 *
+		 * Defaults to `true` (checks enabled).
+		 */
+		checksEnabled?: boolean;
 	}
 
 	export interface GetReferenceGasPriceOptions extends CoreClientMethodOptions {}

package/src/graphql/core.ts

@@ -406,6 +406,7 @@ export class GraphQLCoreClient extends CoreClient {
 					includeObjectTypes: options.include?.objectTypes ?? false,
 					includeCommandResults: options.include?.commandResults ?? false,
 					includeBcs: options.include?.bcs ?? false,
+					checksEnabled: options.checksEnabled ?? true,
 				},
 			},
 			(result) => result.simulateTransaction,

package/src/grpc/core.ts

@@ -44,6 +44,7 @@ import {
 	grpcTransactionToTransactionData,
 } from '../client/transaction-resolver.js';
 import { Value } from './proto/google/protobuf/struct.js';
+import { SimulateTransactionRequest_TransactionChecks } from './proto/sui/rpc/v2/transaction_execution_service.js';
 
 export interface GrpcCoreClientOptions extends CoreClientOptions {
 	client: SuiGrpcClient;
@@ -447,6 +448,10 @@ export class GrpcCoreClient extends CoreClient {
 				paths,
 			},
 			doGasSelection: false,
+			checks:
+				options.checksEnabled === false
+					? SimulateTransactionRequest_TransactionChecks.DISABLED
+					: SimulateTransactionRequest_TransactionChecks.ENABLED,
 		});
 
 		const transactionResult = parseTransaction(response.transaction!, options.include);

package/src/jsonRpc/core.ts

@@ -5,6 +5,8 @@ import { fromBase64, type InferBcsInput } from '@mysten/bcs';
 
 import { bcs, TypeTagSerializer } from '../bcs/index.js';
 import type {
+	DevInspectResults,
+	DryRunTransactionBlockResponse,
 	ExecutionStatus as JsonRpcExecutionStatus,
 	ObjectOwner,
 	SuiMoveAbilitySet,
@@ -356,14 +358,44 @@ export class JSONRpcCoreClient extends CoreClient {
 				})
 			: (options.transaction as Uint8Array);
 
-		const result = await this.#jsonRpcClient.dryRunTransactionBlock({
-			transactionBlock: transactionBytes,
-			signal: options.signal,
-		});
+		const sender = tx.getData().sender ?? normalizeSuiAddress('0x0');
+		const checksDisabled = options.checksEnabled === false;
+
+		let dryRunResult: DryRunTransactionBlockResponse | null = null;
+		try {
+			dryRunResult = await this.#jsonRpcClient.dryRunTransactionBlock({
+				transactionBlock: transactionBytes,
+				signal: options.signal,
+			});
+		} catch (e) {
+			if (!checksDisabled) {
+				throw e;
+			}
+		}
+
+		let devInspectResult: DevInspectResults | null = null;
+		if (options.include?.commandResults || checksDisabled) {
+			try {
+				devInspectResult = await this.#jsonRpcClient.devInspectTransactionBlock({
+					sender,
+					transactionBlock: tx,
+					signal: options.signal,
+				});
+			} catch {}
+		}
+
+		const dryRunFailed = !dryRunResult || dryRunResult.effects.status.status !== 'success';
+		const effectsSource =
+			checksDisabled && dryRunFailed && devInspectResult
+				? devInspectResult
+				: (dryRunResult ?? devInspectResult);
+		if (!effectsSource) {
+			throw new Error('simulateTransaction failed: no results from dryRun or devInspect');
+		}
 
 		const { effects, objectTypes } = parseTransactionEffectsJson({
-			effects: result.effects,
-			objectChanges: result.objectChanges,
+			effects: effectsSource.effects,
+			objectChanges: dryRunResult?.objectChanges ?? [],
 		});
 
 		const transactionData: SuiClientTypes.Transaction<Include> = {
@@ -391,15 +423,15 @@ export class JSONRpcCoreClient extends CoreClient {
 			bcs: (options.include?.bcs
 				? transactionBytes
 				: undefined) as SuiClientTypes.Transaction<Include>['bcs'],
-			balanceChanges: (options.include?.balanceChanges
-				? result.balanceChanges.map((change) => ({
+			balanceChanges: (options.include?.balanceChanges && dryRunResult
+				? dryRunResult.balanceChanges.map((change) => ({
 						coinType: normalizeStructTag(change.coinType),
 						address: parseOwnerAddress(change.owner)!,
 						amount: change.amount,
 					}))
 				: undefined) as SuiClientTypes.Transaction<Include>['balanceChanges'],
 			events: (options.include?.events
-				? (result.events?.map((event) => ({
+				? (effectsSource.events?.map((event) => ({
 						packageId: event.packageId,
 						module: event.transactionModule,
 						sender: event.sender,
@@ -411,26 +443,15 @@ export class JSONRpcCoreClient extends CoreClient {
 		};
 
 		let commandResults: SuiClientTypes.CommandResult[] | undefined;
-		if (options.include?.commandResults) {
-			try {
-				const sender = tx.getData().sender ?? normalizeSuiAddress('0x0');
-				const devInspectResult = await this.#jsonRpcClient.devInspectTransactionBlock({
-					sender,
-					transactionBlock: tx,
-					signal: options.signal,
-				});
-
-				if (devInspectResult.results) {
-					commandResults = devInspectResult.results.map((result) => ({
-						returnValues: (result.returnValues ?? []).map(([bytes]) => ({
-							bcs: new Uint8Array(bytes),
-						})),
-						mutatedReferences: (result.mutableReferenceOutputs ?? []).map(([, bytes]) => ({
-							bcs: new Uint8Array(bytes),
-						})),
-					}));
-				}
-			} catch {}
+		if (options.include?.commandResults && devInspectResult?.results) {
+			commandResults = devInspectResult.results.map((result) => ({
+				returnValues: (result.returnValues ?? []).map(([bytes]) => ({
+					bcs: new Uint8Array(bytes),
+				})),
+				mutatedReferences: (result.mutableReferenceOutputs ?? []).map(([, bytes]) => ({
+					bcs: new Uint8Array(bytes),
+				})),
+			}));
 		}
 
 		return effects.status.success

package/src/jsonRpc/http-transport.ts

@@ -3,8 +3,6 @@
 
 import { PACKAGE_VERSION, TARGETED_RPC_VERSION } from '../version.js';
 import { JsonRpcError, SuiHTTPStatusError } from './errors.js';
-import type { WebsocketClientOptions } from './rpc-websocket-client.js';
-import { WebsocketClient } from './rpc-websocket-client.js';
 
 /**
  * An object defining headers to be passed to the RPC server
@@ -13,15 +11,11 @@ export type HttpHeaders = { [header: string]: string };
 
 export interface JsonRpcHTTPTransportOptions {
 	fetch?: typeof fetch;
-	WebSocketConstructor?: typeof WebSocket;
 	url: string;
 	rpc?: {
 		headers?: HttpHeaders;
 		url?: string;
 	};
-	websocket?: WebsocketClientOptions & {
-		url?: string;
-	};
 }
 
 export interface JsonRpcTransportRequestOptions {
@@ -30,25 +24,13 @@ export interface JsonRpcTransportRequestOptions {
 	signal?: AbortSignal;
 }
 
-export interface JsonRpcTransportSubscribeOptions<T> {
-	method: string;
-	unsubscribe: string;
-	params: unknown[];
-	onMessage: (event: T) => void;
-	signal?: AbortSignal;
-}
-
 export interface JsonRpcTransport {
 	request<T = unknown>(input: JsonRpcTransportRequestOptions): Promise<T>;
-	subscribe<T = unknown>(
-		input: JsonRpcTransportSubscribeOptions<T>,
-	): Promise<() => Promise<boolean>>;
 }
 
 export class JsonRpcHTTPTransport implements JsonRpcTransport {
 	#requestId = 0;
 	#options: JsonRpcHTTPTransportOptions;
-	#websocketClient?: WebsocketClient;
 
 	constructor(options: JsonRpcHTTPTransportOptions) {
 		this.#options = options;
@@ -66,27 +48,6 @@ export class JsonRpcHTTPTransport implements JsonRpcTransport {
 		return fetchFn(input, init);
 	}
 
-	#getWebsocketClient(): WebsocketClient {
-		if (!this.#websocketClient) {
-			const WebSocketConstructor = this.#options.WebSocketConstructor ?? WebSocket;
-			if (!WebSocketConstructor) {
-				throw new Error(
-					'The current environment does not support WebSocket, you can provide a WebSocketConstructor in the options for SuiHTTPTransport.',
-				);
-			}
-
-			this.#websocketClient = new WebsocketClient(
-				this.#options.websocket?.url ?? this.#options.url,
-				{
-					WebSocketConstructor,
-					...this.#options.websocket,
-				},
-			);
-		}
-
-		return this.#websocketClient;
-	}
-
 	async request<T>(input: JsonRpcTransportRequestOptions): Promise<T> {
 		this.#requestId += 1;
 
@@ -125,17 +86,4 @@ export class JsonRpcHTTPTransport implements JsonRpcTransport {
 
 		return data.result;
 	}
-
-	async subscribe<T>(input: JsonRpcTransportSubscribeOptions<T>): Promise<() => Promise<boolean>> {
-		const unsubscribe = await this.#getWebsocketClient().subscribe(input);
-
-		if (input.signal) {
-			input.signal.throwIfAborted();
-			input.signal.addEventListener('abort', () => {
-				unsubscribe();
-			});
-		}
-
-		return async () => !!(await unsubscribe());
-	}
 }

package/src/jsonRpc/index.ts

@@ -4,7 +4,6 @@
 export {
 	type JsonRpcTransport,
 	type JsonRpcTransportRequestOptions,
-	type JsonRpcTransportSubscribeOptions,
 	type HttpHeaders,
 	type JsonRpcHTTPTransportOptions,
 	JsonRpcHTTPTransport,

package/src/jsonRpc/types/common.ts

@@ -2,4 +2,3 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export type Order = 'ascending' | 'descending';
-export type Unsubscribe = () => Promise<boolean>;

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '2.10.0';
+export const PACKAGE_VERSION = '2.12.0';
 export const TARGETED_RPC_VERSION = '1.69.0';

package/dist/jsonRpc/rpc-websocket-client.d.mts

@@ -1,26 +0,0 @@
-//#region src/jsonRpc/rpc-websocket-client.d.ts
-
-/**
- * Configuration options for the websocket connection
- */
-type WebsocketClientOptions = {
-  /**
-   * Custom WebSocket class to use. Defaults to the global WebSocket class, if available.
-   */
-  WebSocketConstructor?: typeof WebSocket;
-  /**
-   * Milliseconds before timing out while calling an RPC method
-   */
-  callTimeout?: number;
-  /**
-   * Milliseconds between attempts to connect
-   */
-  reconnectTimeout?: number;
-  /**
-   * Maximum number of times to try connecting before giving up
-   */
-  maxReconnects?: number;
-};
-//#endregion
-export { WebsocketClientOptions };
-//# sourceMappingURL=rpc-websocket-client.d.mts.map

package/dist/jsonRpc/rpc-websocket-client.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rpc-websocket-client.d.mts","names":[],"sources":["../../src/jsonRpc/rpc-websocket-client.ts"],"sourcesContent":[],"mappings":";;;;;KA8CY,sBAAA;;;;gCAImB"}

package/dist/jsonRpc/rpc-websocket-client.mjs

@@ -1,135 +0,0 @@
-import { JsonRpcError } from "./errors.mjs";
-
-//#region src/jsonRpc/rpc-websocket-client.ts
-function getWebsocketUrl(httpUrl) {
-	const url = new URL(httpUrl);
-	url.protocol = url.protocol.replace("http", "ws");
-	return url.toString();
-}
-const DEFAULT_CLIENT_OPTIONS = {
-	WebSocketConstructor: typeof WebSocket !== "undefined" ? WebSocket : void 0,
-	callTimeout: 3e4,
-	reconnectTimeout: 3e3,
-	maxReconnects: 5
-};
-var WebsocketClient = class {
-	#requestId = 0;
-	#disconnects = 0;
-	#webSocket = null;
-	#connectionPromise = null;
-	#subscriptions = /* @__PURE__ */ new Set();
-	#pendingRequests = /* @__PURE__ */ new Map();
-	constructor(endpoint, options = {}) {
-		this.endpoint = endpoint;
-		this.options = {
-			...DEFAULT_CLIENT_OPTIONS,
-			...options
-		};
-		if (!this.options.WebSocketConstructor) throw new Error("Missing WebSocket constructor");
-		if (this.endpoint.startsWith("http")) this.endpoint = getWebsocketUrl(this.endpoint);
-	}
-	async makeRequest(method, params, signal) {
-		const webSocket = await this.#setupWebSocket();
-		return new Promise((resolve, reject) => {
-			this.#requestId += 1;
-			this.#pendingRequests.set(this.#requestId, {
-				resolve,
-				reject,
-				timeout: setTimeout(() => {
-					this.#pendingRequests.delete(this.#requestId);
-					reject(/* @__PURE__ */ new Error(`Request timeout: ${method}`));
-				}, this.options.callTimeout)
-			});
-			signal?.addEventListener("abort", () => {
-				this.#pendingRequests.delete(this.#requestId);
-				reject(signal.reason);
-			});
-			webSocket.send(JSON.stringify({
-				jsonrpc: "2.0",
-				id: this.#requestId,
-				method,
-				params
-			}));
-		}).then(({ error, result }) => {
-			if (error) throw new JsonRpcError(error.message, error.code);
-			return result;
-		});
-	}
-	#setupWebSocket() {
-		if (this.#connectionPromise) return this.#connectionPromise;
-		this.#connectionPromise = new Promise((resolve) => {
-			this.#webSocket?.close();
-			this.#webSocket = new this.options.WebSocketConstructor(this.endpoint);
-			this.#webSocket.addEventListener("open", () => {
-				this.#disconnects = 0;
-				resolve(this.#webSocket);
-			});
-			this.#webSocket.addEventListener("close", () => {
-				this.#disconnects++;
-				if (this.#disconnects <= this.options.maxReconnects) setTimeout(() => {
-					this.#reconnect();
-				}, this.options.reconnectTimeout);
-			});
-			this.#webSocket.addEventListener("message", ({ data }) => {
-				let json;
-				try {
-					json = JSON.parse(data);
-				} catch (error) {
-					console.error(new Error(`Failed to parse RPC message: ${data}`, { cause: error }));
-					return;
-				}
-				if ("id" in json && json.id != null && this.#pendingRequests.has(json.id)) {
-					const { resolve: resolve$1, timeout } = this.#pendingRequests.get(json.id);
-					clearTimeout(timeout);
-					resolve$1(json);
-				} else if ("params" in json) {
-					const { params } = json;
-					this.#subscriptions.forEach((subscription) => {
-						if (subscription.subscriptionId === params.subscription) {
-							if (params.subscription === subscription.subscriptionId) subscription.onMessage(params.result);
-						}
-					});
-				}
-			});
-		});
-		return this.#connectionPromise;
-	}
-	async #reconnect() {
-		this.#webSocket?.close();
-		this.#connectionPromise = null;
-		return Promise.allSettled([...this.#subscriptions].map((subscription) => subscription.subscribe(this)));
-	}
-	async subscribe(input) {
-		const subscription = new RpcSubscription(input);
-		this.#subscriptions.add(subscription);
-		await subscription.subscribe(this);
-		return () => subscription.unsubscribe(this);
-	}
-};
-var RpcSubscription = class {
-	constructor(input) {
-		this.subscriptionId = null;
-		this.subscribed = false;
-		this.input = input;
-	}
-	onMessage(message) {
-		if (this.subscribed) this.input.onMessage(message);
-	}
-	async unsubscribe(client) {
-		const { subscriptionId } = this;
-		this.subscribed = false;
-		if (subscriptionId == null) return false;
-		this.subscriptionId = null;
-		return client.makeRequest(this.input.unsubscribe, [subscriptionId]);
-	}
-	async subscribe(client) {
-		this.subscriptionId = null;
-		this.subscribed = true;
-		const newSubscriptionId = await client.makeRequest(this.input.method, this.input.params, this.input.signal);
-		if (this.subscribed) this.subscriptionId = newSubscriptionId;
-	}
-};
-
-//#endregion
-export { WebsocketClient };
-//# sourceMappingURL=rpc-websocket-client.mjs.map

package/dist/jsonRpc/rpc-websocket-client.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"rpc-websocket-client.mjs","names":["#setupWebSocket","#requestId","#pendingRequests","#connectionPromise","#webSocket","#disconnects","#reconnect","#subscriptions"],"sources":["../../src/jsonRpc/rpc-websocket-client.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { JsonRpcError } from './errors.js';\n\nfunction getWebsocketUrl(httpUrl: string): string {\n\tconst url = new URL(httpUrl);\n\turl.protocol = url.protocol.replace('http', 'ws');\n\treturn url.toString();\n}\n\ntype JsonRpcMessage =\n\t| {\n\t\t\tid: number;\n\t\t\tresult: never;\n\t\t\terror: {\n\t\t\t\tcode: number;\n\t\t\t\tmessage: string;\n\t\t\t};\n\t  }\n\t| {\n\t\t\tid: number;\n\t\t\tresult: unknown;\n\t\t\terror: never;\n\t  }\n\t| {\n\t\t\tmethod: string;\n\t\t\tparams: NotificationMessageParams;\n\t  };\n\ntype NotificationMessageParams = {\n\tsubscription?: number;\n\tresult: object;\n};\n\ntype SubscriptionRequest<T = any> = {\n\tmethod: string;\n\tunsubscribe: string;\n\tparams: any[];\n\tonMessage: (event: T) => void;\n\tsignal?: AbortSignal;\n};\n\n/**\n * Configuration options for the websocket connection\n */\nexport type WebsocketClientOptions = {\n\t/**\n\t * Custom WebSocket class to use. Defaults to the global WebSocket class, if available.\n\t */\n\tWebSocketConstructor?: typeof WebSocket;\n\t/**\n\t * Milliseconds before timing out while calling an RPC method\n\t */\n\tcallTimeout?: number;\n\t/**\n\t * Milliseconds between attempts to connect\n\t */\n\treconnectTimeout?: number;\n\t/**\n\t * Maximum number of times to try connecting before giving up\n\t */\n\tmaxReconnects?: number;\n};\n\nexport const DEFAULT_CLIENT_OPTIONS = {\n\t// We fudge the typing because we also check for undefined in the constructor:\n\tWebSocketConstructor: (typeof WebSocket !== 'undefined'\n\t\t? WebSocket\n\t\t: undefined) as typeof WebSocket,\n\tcallTimeout: 30000,\n\treconnectTimeout: 3000,\n\tmaxReconnects: 5,\n} satisfies WebsocketClientOptions;\n\nexport class WebsocketClient {\n\tendpoint: string;\n\toptions: Required<WebsocketClientOptions>;\n\t#requestId = 0;\n\t#disconnects = 0;\n\t#webSocket: WebSocket | null = null;\n\t#connectionPromise: Promise<WebSocket> | null = null;\n\t#subscriptions = new Set<RpcSubscription>();\n\t#pendingRequests = new Map<\n\t\tnumber,\n\t\t{\n\t\t\tresolve: (result: Extract<JsonRpcMessage, { id: number }>) => void;\n\t\t\treject: (reason: unknown) => void;\n\t\t\ttimeout: ReturnType<typeof setTimeout>;\n\t\t}\n\t>();\n\n\tconstructor(endpoint: string, options: WebsocketClientOptions = {}) {\n\t\tthis.endpoint = endpoint;\n\t\tthis.options = { ...DEFAULT_CLIENT_OPTIONS, ...options };\n\n\t\tif (!this.options.WebSocketConstructor) {\n\t\t\tthrow new Error('Missing WebSocket constructor');\n\t\t}\n\n\t\tif (this.endpoint.startsWith('http')) {\n\t\t\tthis.endpoint = getWebsocketUrl(this.endpoint);\n\t\t}\n\t}\n\n\tasync makeRequest<T>(method: string, params: any[], signal?: AbortSignal): Promise<T> {\n\t\tconst webSocket = await this.#setupWebSocket();\n\n\t\treturn new Promise<Extract<JsonRpcMessage, { id: number }>>((resolve, reject) => {\n\t\t\tthis.#requestId += 1;\n\t\t\tthis.#pendingRequests.set(this.#requestId, {\n\t\t\t\tresolve: resolve,\n\t\t\t\treject,\n\t\t\t\ttimeout: setTimeout(() => {\n\t\t\t\t\tthis.#pendingRequests.delete(this.#requestId);\n\t\t\t\t\treject(new Error(`Request timeout: ${method}`));\n\t\t\t\t}, this.options.callTimeout),\n\t\t\t});\n\n\t\t\tsignal?.addEventListener('abort', () => {\n\t\t\t\tthis.#pendingRequests.delete(this.#requestId);\n\t\t\t\treject(signal.reason);\n\t\t\t});\n\n\t\t\twebSocket.send(JSON.stringify({ jsonrpc: '2.0', id: this.#requestId, method, params }));\n\t\t}).then(({ error, result }) => {\n\t\t\tif (error) {\n\t\t\t\tthrow new JsonRpcError(error.message, error.code);\n\t\t\t}\n\n\t\t\treturn result as T;\n\t\t});\n\t}\n\n\t#setupWebSocket() {\n\t\tif (this.#connectionPromise) {\n\t\t\treturn this.#connectionPromise;\n\t\t}\n\n\t\tthis.#connectionPromise = new Promise<WebSocket>((resolve) => {\n\t\t\tthis.#webSocket?.close();\n\t\t\tthis.#webSocket = new this.options.WebSocketConstructor(this.endpoint);\n\n\t\t\tthis.#webSocket.addEventListener('open', () => {\n\t\t\t\tthis.#disconnects = 0;\n\t\t\t\tresolve(this.#webSocket!);\n\t\t\t});\n\n\t\t\tthis.#webSocket.addEventListener('close', () => {\n\t\t\t\tthis.#disconnects++;\n\t\t\t\tif (this.#disconnects <= this.options.maxReconnects) {\n\t\t\t\t\tsetTimeout(() => {\n\t\t\t\t\t\tthis.#reconnect();\n\t\t\t\t\t}, this.options.reconnectTimeout);\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tthis.#webSocket.addEventListener('message', ({ data }: { data: string }) => {\n\t\t\t\tlet json: JsonRpcMessage;\n\t\t\t\ttry {\n\t\t\t\t\tjson = JSON.parse(data) as JsonRpcMessage;\n\t\t\t\t} catch (error) {\n\t\t\t\t\tconsole.error(new Error(`Failed to parse RPC message: ${data}`, { cause: error }));\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif ('id' in json && json.id != null && this.#pendingRequests.has(json.id)) {\n\t\t\t\t\tconst { resolve, timeout } = this.#pendingRequests.get(json.id)!;\n\n\t\t\t\t\tclearTimeout(timeout);\n\t\t\t\t\tresolve(json);\n\t\t\t\t} else if ('params' in json) {\n\t\t\t\t\tconst { params } = json;\n\t\t\t\t\tthis.#subscriptions.forEach((subscription) => {\n\t\t\t\t\t\tif (subscription.subscriptionId === params.subscription)\n\t\t\t\t\t\t\tif (params.subscription === subscription.subscriptionId) {\n\t\t\t\t\t\t\t\tsubscription.onMessage(params.result);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\n\t\treturn this.#connectionPromise;\n\t}\n\n\tasync #reconnect() {\n\t\tthis.#webSocket?.close();\n\t\tthis.#connectionPromise = null;\n\n\t\treturn Promise.allSettled(\n\t\t\t[...this.#subscriptions].map((subscription) => subscription.subscribe(this)),\n\t\t);\n\t}\n\n\tasync subscribe<T>(input: SubscriptionRequest<T>) {\n\t\tconst subscription = new RpcSubscription(input);\n\t\tthis.#subscriptions.add(subscription);\n\t\tawait subscription.subscribe(this);\n\t\treturn () => subscription.unsubscribe(this);\n\t}\n}\n\nclass RpcSubscription {\n\tsubscriptionId: number | null = null;\n\tinput: SubscriptionRequest<any>;\n\tsubscribed = false;\n\n\tconstructor(input: SubscriptionRequest) {\n\t\tthis.input = input;\n\t}\n\n\tonMessage(message: unknown) {\n\t\tif (this.subscribed) {\n\t\t\tthis.input.onMessage(message);\n\t\t}\n\t}\n\n\tasync unsubscribe(client: WebsocketClient) {\n\t\tconst { subscriptionId } = this;\n\t\tthis.subscribed = false;\n\t\tif (subscriptionId == null) return false;\n\t\tthis.subscriptionId = null;\n\n\t\treturn client.makeRequest(this.input.unsubscribe, [subscriptionId]);\n\t}\n\n\tasync subscribe(client: WebsocketClient) {\n\t\tthis.subscriptionId = null;\n\t\tthis.subscribed = true;\n\t\tconst newSubscriptionId = await client.makeRequest<number>(\n\t\t\tthis.input.method,\n\t\t\tthis.input.params,\n\t\t\tthis.input.signal,\n\t\t);\n\n\t\tif (this.subscribed) {\n\t\t\tthis.subscriptionId = newSubscriptionId;\n\t\t}\n\t}\n}\n"],"mappings":";;;AAKA,SAAS,gBAAgB,SAAyB;CACjD,MAAM,MAAM,IAAI,IAAI,QAAQ;AAC5B,KAAI,WAAW,IAAI,SAAS,QAAQ,QAAQ,KAAK;AACjD,QAAO,IAAI,UAAU;;AAyDtB,MAAa,yBAAyB;CAErC,sBAAuB,OAAO,cAAc,cACzC,YACA;CACH,aAAa;CACb,kBAAkB;CAClB,eAAe;CACf;AAED,IAAa,kBAAb,MAA6B;CAG5B,aAAa;CACb,eAAe;CACf,aAA+B;CAC/B,qBAAgD;CAChD,iCAAiB,IAAI,KAAsB;CAC3C,mCAAmB,IAAI,KAOpB;CAEH,YAAY,UAAkB,UAAkC,EAAE,EAAE;AACnE,OAAK,WAAW;AAChB,OAAK,UAAU;GAAE,GAAG;GAAwB,GAAG;GAAS;AAExD,MAAI,CAAC,KAAK,QAAQ,qBACjB,OAAM,IAAI,MAAM,gCAAgC;AAGjD,MAAI,KAAK,SAAS,WAAW,OAAO,CACnC,MAAK,WAAW,gBAAgB,KAAK,SAAS;;CAIhD,MAAM,YAAe,QAAgB,QAAe,QAAkC;EACrF,MAAM,YAAY,MAAM,MAAKA,gBAAiB;AAE9C,SAAO,IAAI,SAAkD,SAAS,WAAW;AAChF,SAAKC,aAAc;AACnB,SAAKC,gBAAiB,IAAI,MAAKD,WAAY;IACjC;IACT;IACA,SAAS,iBAAiB;AACzB,WAAKC,gBAAiB,OAAO,MAAKD,UAAW;AAC7C,4BAAO,IAAI,MAAM,oBAAoB,SAAS,CAAC;OAC7C,KAAK,QAAQ,YAAY;IAC5B,CAAC;AAEF,WAAQ,iBAAiB,eAAe;AACvC,UAAKC,gBAAiB,OAAO,MAAKD,UAAW;AAC7C,WAAO,OAAO,OAAO;KACpB;AAEF,aAAU,KAAK,KAAK,UAAU;IAAE,SAAS;IAAO,IAAI,MAAKA;IAAY;IAAQ;IAAQ,CAAC,CAAC;IACtF,CAAC,MAAM,EAAE,OAAO,aAAa;AAC9B,OAAI,MACH,OAAM,IAAI,aAAa,MAAM,SAAS,MAAM,KAAK;AAGlD,UAAO;IACN;;CAGH,kBAAkB;AACjB,MAAI,MAAKE,kBACR,QAAO,MAAKA;AAGb,QAAKA,oBAAqB,IAAI,SAAoB,YAAY;AAC7D,SAAKC,WAAY,OAAO;AACxB,SAAKA,YAAa,IAAI,KAAK,QAAQ,qBAAqB,KAAK,SAAS;AAEtE,SAAKA,UAAW,iBAAiB,cAAc;AAC9C,UAAKC,cAAe;AACpB,YAAQ,MAAKD,UAAY;KACxB;AAEF,SAAKA,UAAW,iBAAiB,eAAe;AAC/C,UAAKC;AACL,QAAI,MAAKA,eAAgB,KAAK,QAAQ,cACrC,kBAAiB;AAChB,WAAKC,WAAY;OACf,KAAK,QAAQ,iBAAiB;KAEjC;AAEF,SAAKF,UAAW,iBAAiB,YAAY,EAAE,WAA6B;IAC3E,IAAI;AACJ,QAAI;AACH,YAAO,KAAK,MAAM,KAAK;aACf,OAAO;AACf,aAAQ,MAAM,IAAI,MAAM,gCAAgC,QAAQ,EAAE,OAAO,OAAO,CAAC,CAAC;AAClF;;AAGD,QAAI,QAAQ,QAAQ,KAAK,MAAM,QAAQ,MAAKF,gBAAiB,IAAI,KAAK,GAAG,EAAE;KAC1E,MAAM,EAAE,oBAAS,YAAY,MAAKA,gBAAiB,IAAI,KAAK,GAAG;AAE/D,kBAAa,QAAQ;AACrB,eAAQ,KAAK;eACH,YAAY,MAAM;KAC5B,MAAM,EAAE,WAAW;AACnB,WAAKK,cAAe,SAAS,iBAAiB;AAC7C,UAAI,aAAa,mBAAmB,OAAO,cAC1C;WAAI,OAAO,iBAAiB,aAAa,eACxC,cAAa,UAAU,OAAO,OAAO;;OAEtC;;KAEF;IACD;AAEF,SAAO,MAAKJ;;CAGb,OAAMG,YAAa;AAClB,QAAKF,WAAY,OAAO;AACxB,QAAKD,oBAAqB;AAE1B,SAAO,QAAQ,WACd,CAAC,GAAG,MAAKI,cAAe,CAAC,KAAK,iBAAiB,aAAa,UAAU,KAAK,CAAC,CAC5E;;CAGF,MAAM,UAAa,OAA+B;EACjD,MAAM,eAAe,IAAI,gBAAgB,MAAM;AAC/C,QAAKA,cAAe,IAAI,aAAa;AACrC,QAAM,aAAa,UAAU,KAAK;AAClC,eAAa,aAAa,YAAY,KAAK;;;AAI7C,IAAM,kBAAN,MAAsB;CAKrB,YAAY,OAA4B;wBAJR;oBAEnB;AAGZ,OAAK,QAAQ;;CAGd,UAAU,SAAkB;AAC3B,MAAI,KAAK,WACR,MAAK,MAAM,UAAU,QAAQ;;CAI/B,MAAM,YAAY,QAAyB;EAC1C,MAAM,EAAE,mBAAmB;AAC3B,OAAK,aAAa;AAClB,MAAI,kBAAkB,KAAM,QAAO;AACnC,OAAK,iBAAiB;AAEtB,SAAO,OAAO,YAAY,KAAK,MAAM,aAAa,CAAC,eAAe,CAAC;;CAGpE,MAAM,UAAU,QAAyB;AACxC,OAAK,iBAAiB;AACtB,OAAK,aAAa;EAClB,MAAM,oBAAoB,MAAM,OAAO,YACtC,KAAK,MAAM,QACX,KAAK,MAAM,QACX,KAAK,MAAM,OACX;AAED,MAAI,KAAK,WACR,MAAK,iBAAiB"}