@mysten/sui 1.40.0 → 1.41.0

package/grpc/package.json

@@ -0,0 +1,6 @@
+{
+	"private": true,
+	"import": "../dist/esm/grpc/index.js",
+	"main": "../dist/cjs/grpc/index.js",
+	"sideEffects": false
+}

package/jsonRpc/package.json

@@ -0,0 +1,6 @@
+{
+	"private": true,
+	"import": "../dist/esm/jsonRpc/index.js",
+	"main": "../dist/cjs/jsonRpc/index.js",
+	"sideEffects": false
+}

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "1.40.0",
+  "version": "1.41.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -18,6 +18,8 @@
     "experimental",
     "faucet",
     "graphql",
+    "grpc",
+    "jsonRpc",
     "keypairs",
     "multisig",
     "src",
@@ -55,6 +57,14 @@
       "import": "./dist/esm/graphql/index.js",
       "require": "./dist/cjs/graphql/index.js"
     },
+    "./grpc": {
+      "import": "./dist/esm/grpc/index.js",
+      "require": "./dist/cjs/grpc/index.js"
+    },
+    "./jsonRpc": {
+      "import": "./dist/esm/jsonRpc/index.js",
+      "require": "./dist/cjs/jsonRpc/index.js"
+    },
     "./keypairs/ed25519": {
       "import": "./dist/esm/keypairs/ed25519/index.js",
       "require": "./dist/cjs/keypairs/ed25519/index.js"
@@ -138,8 +148,11 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@noble/curves": "^1.9.4",
+    "@noble/curves": "=1.9.4",
     "@noble/hashes": "^1.8.0",
+    "@protobuf-ts/grpcweb-transport": "^2.11.1",
+    "@protobuf-ts/runtime": "^2.11.1",
+    "@protobuf-ts/runtime-rpc": "^2.11.1",
     "@scure/base": "^1.2.6",
     "@scure/bip32": "^1.7.0",
     "@scure/bip39": "^1.6.0",
@@ -147,13 +160,17 @@
     "graphql": "^16.11.0",
     "poseidon-lite": "0.2.1",
     "valibot": "^0.36.0",
-    "@mysten/bcs": "1.8.0",
+    "@mysten/bcs": "1.8.1",
     "@mysten/utils": "0.2.0"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "codegen": "pnpm codegen:graphql && pnpm codegen:grpc && pnpm lint:fix",
     "codegen:graphql": "graphql-codegen --config graphql-codegen.ts",
     "codegen:version": "node genversion.mjs",
+    "codegen:grpc": "rm -rf src/grpc/proto && mkdir src/grpc/proto && pnpm codegen:grpc-protoc && pnpm codegen:grpc-header",
+    "codegen:grpc-protoc": "protoc --ts_out ./src/grpc/proto --ts_opt force_server_none --ts_opt optimize_code_size --ts_opt ts_nocheck -I ../../../sui-apis/proto -I ../../../sui-apis/proto ../../../sui-apis/proto/sui/rpc/v2beta2/*.proto ../../../sui-apis/proto/google/*/*.proto",
+    "codegen:grpc-header": "find src/grpc/proto -type f -exec sh -c 'echo \"// Copyright (c) Mysten Labs, Inc.\\n// SPDX-License-Identifier: Apache-2.0\\n\" | cat - {} > temp && mv temp {}' \\;",
     "build": "node genversion.mjs && pnpm build:package",
     "build:package": "build-package",
     "vitest": "vitest",

package/src/client/index.ts

@@ -2,20 +2,20 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export {
-	type SuiTransport,
-	type SuiTransportRequestOptions,
-	type SuiTransportSubscribeOptions,
+	type JsonRpcTransport as SuiTransport,
+	type JsonRpcTransportRequestOptions as SuiTransportRequestOptions,
+	type JsonRpcTransportSubscribeOptions as SuiTransportSubscribeOptions,
 	type HttpHeaders,
-	type SuiHTTPTransportOptions,
-	SuiHTTPTransport,
-} from './http-transport.js';
+	type JsonRpcHTTPTransportOptions as SuiHTTPTransportOptions,
+	JsonRpcHTTPTransport as SuiHTTPTransport,
+} from '../jsonRpc/http-transport.js';
 export { getFullnodeUrl } from './network.js';
-export type * from './types/index.js';
+export type * from '../jsonRpc/types/index.js';
 export {
-	type SuiClientOptions,
+	type SuiJsonRpcClientOptions as SuiClientOptions,
 	type PaginationArguments,
 	type OrderArguments,
-	isSuiClient,
-	SuiClient,
-} from './client.js';
-export { SuiHTTPStatusError, SuiHTTPTransportError, JsonRpcError } from './errors.js';
+	isSuiJsonRpcClient as isSuiClient,
+	SuiJsonRpcClient as SuiClient,
+} from '../jsonRpc/client.js';
+export { SuiHTTPStatusError, SuiHTTPTransportError, JsonRpcError } from '../jsonRpc/errors.js';

package/src/experimental/core.ts

@@ -185,7 +185,7 @@ export abstract class Experimental_CoreClient
 					...input,
 					signal: abortSignal,
 				});
-			} catch (e) {
+			} catch {
 				await Promise.race([new Promise((resolve) => setTimeout(resolve, 2_000)), abortPromise]);
 			}
 		}

package/src/faucet/faucet.ts

@@ -55,7 +55,7 @@ async function faucetRequest<T>({ host, path, body, headers, method }: FaucetReq
 		body: body ? JSON.stringify(body) : undefined,
 		headers: {
 			'Content-Type': 'application/json',
-			...(headers || {}),
+			...headers,
 		},
 	});
 
@@ -76,7 +76,7 @@ async function faucetRequest<T>({ host, path, body, headers, method }: FaucetReq
 }
 
 /**
- * @deprecated("Use requestSuiFromFaucetV2 instead")
+ * @deprecated "Use requestSuiFromFaucetV2 instead"
  */
 export async function requestSuiFromFaucetV0(input: {
 	host: string;
@@ -103,7 +103,7 @@ export async function requestSuiFromFaucetV0(input: {
 }
 
 /**
- * @deprecated("Use requestSuiFromFaucetV2 instead")
+ * @deprecated "Use requestSuiFromFaucetV2 instead"
  */
 export async function requestSuiFromFaucetV1(input: {
 	host: string;
@@ -154,7 +154,7 @@ export async function requestSuiFromFaucetV2(input: {
 }
 
 /**
- * @deprecated("Use requestSuiFromFaucetV2 which returns directly a success or failure status")
+ * @deprecated "Use requestSuiFromFaucetV2 which returns directly a success or failure status"
  */
 export async function getFaucetRequestStatus(input: {
 	host: string;

package/src/graphql/client.ts

@@ -7,7 +7,7 @@ import type { DocumentNode } from 'graphql';
 import { print } from 'graphql';
 import { Experimental_BaseClient } from '../experimental/index.js';
 import type { Experimental_SuiClientTypes } from '../experimental/index.js';
-import { GraphQLTransport } from '../experimental/transports/graphql.js';
+import { GraphQLCoreClient } from './core.js';
 import type { TypedDocumentString } from './generated/queries.js';
 
 export type GraphQLDocument<
@@ -65,7 +65,7 @@ export class SuiGraphQLClient<
 	#queries: Queries;
 	#headers: Record<string, string>;
 	#fetch: typeof fetch;
-	core: GraphQLTransport;
+	core: GraphQLCoreClient;
 
 	constructor({
 		url,
@@ -82,7 +82,7 @@ export class SuiGraphQLClient<
 		this.#queries = queries;
 		this.#headers = headers;
 		this.#fetch = (...args) => fetchFn(...args);
-		this.core = new GraphQLTransport({
+		this.core = new GraphQLCoreClient({
 			graphqlClient: this,
 			mvr,
 		});

package/src/{experimental/transports/graphql.ts → graphql/core.ts}

@@ -1,14 +1,14 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Experimental_CoreClient } from '../core.js';
-import type { Experimental_SuiClientTypes } from '../types.js';
-import type { GraphQLQueryOptions, SuiGraphQLClient } from '../../graphql/client.js';
+import { Experimental_CoreClient } from '../experimental/core.js';
+import type { Experimental_SuiClientTypes } from '../experimental/types.js';
+import type { GraphQLQueryOptions, SuiGraphQLClient } from './client.js';
 import type {
 	Object_Owner_FieldsFragment,
 	Object_FieldsFragment,
 	Transaction_FieldsFragment,
-} from '../../graphql/generated/queries.js';
+} from './generated/queries.js';
 import {
 	DryRunTransactionBlockDocument,
 	ExecuteTransactionBlockDocument,
@@ -24,15 +24,18 @@ import {
 	ResolveNameServiceNamesDocument,
 	VerifyZkLoginSignatureDocument,
 	ZkLoginIntentScope,
-} from '../../graphql/generated/queries.js';
-import { ObjectError } from '../errors.js';
+} from './generated/queries.js';
+import { ObjectError } from '../experimental/errors.js';
 import { fromBase64, toBase64 } from '@mysten/utils';
-import { normalizeStructTag, normalizeSuiAddress } from '../../utils/sui-types.js';
-import { deriveDynamicFieldID } from '../../utils/dynamic-fields.js';
-import { parseTransactionBcs, parseTransactionEffectsBcs } from './utils.js';
-import type { OpenMoveTypeSignatureBody, OpenMoveTypeSignature } from '../../graphql/types.js';
+import { normalizeStructTag, normalizeSuiAddress } from '../utils/sui-types.js';
+import { deriveDynamicFieldID } from '../utils/dynamic-fields.js';
+import {
+	parseTransactionBcs,
+	parseTransactionEffectsBcs,
+} from '../experimental/transports/utils.js';
+import type { OpenMoveTypeSignatureBody, OpenMoveTypeSignature } from './types.js';
 
-export class GraphQLTransport extends Experimental_CoreClient {
+export class GraphQLCoreClient extends Experimental_CoreClient {
 	#graphqlClient: SuiGraphQLClient;
 
 	constructor({

package/src/grpc/client.ts

@@ -0,0 +1,59 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { GrpcWebOptions } from '@protobuf-ts/grpcweb-transport';
+import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
+import { TransactionExecutionServiceClient } from './proto/sui/rpc/v2beta2/transaction_execution_service.client.js';
+import { LedgerServiceClient } from './proto/sui/rpc/v2beta2/ledger_service.client.js';
+import { MovePackageServiceClient } from './proto/sui/rpc/v2beta2/move_package_service.client.js';
+import { SignatureVerificationServiceClient } from './proto/sui/rpc/v2beta2/signature_verification_service.client.js';
+import type { RpcTransport } from '@protobuf-ts/runtime-rpc';
+import { LiveDataServiceClient } from './proto/sui/rpc/v2beta2/live_data_service.client.js';
+import { SubscriptionServiceClient } from './proto/sui/rpc/v2beta2/subscription_service.client.js';
+import { GrpcCoreClient } from './core.js';
+import type { Experimental_SuiClientTypes } from '../experimental/index.js';
+import { Experimental_BaseClient } from '../experimental/index.js';
+
+interface SuiGrpcTransportOptions extends GrpcWebOptions {
+	transport?: never;
+}
+
+export type SuiGrpcClientOptions = {
+	network: Experimental_SuiClientTypes.Network;
+	mvr?: Experimental_SuiClientTypes.MvrOptions;
+} & (
+	| {
+			transport: RpcTransport;
+	  }
+	| SuiGrpcTransportOptions
+);
+
+export class SuiGrpcClient extends Experimental_BaseClient {
+	core: GrpcCoreClient;
+	transactionExecutionService: TransactionExecutionServiceClient;
+	ledgerService: LedgerServiceClient;
+	liveDataService: LiveDataServiceClient;
+	subscriptionService: SubscriptionServiceClient;
+	movePackageService: MovePackageServiceClient;
+	signatureVerificationService: SignatureVerificationServiceClient;
+
+	constructor(options: SuiGrpcClientOptions) {
+		super({ network: options.network });
+		const transport =
+			options.transport ??
+			new GrpcWebFetchTransport({ baseUrl: options.baseUrl, fetchInit: options.fetchInit });
+		this.transactionExecutionService = new TransactionExecutionServiceClient(transport);
+		this.ledgerService = new LedgerServiceClient(transport);
+		this.liveDataService = new LiveDataServiceClient(transport);
+		this.subscriptionService = new SubscriptionServiceClient(transport);
+		this.movePackageService = new MovePackageServiceClient(transport);
+		this.signatureVerificationService = new SignatureVerificationServiceClient(transport);
+
+		this.core = new GrpcCoreClient({
+			client: this,
+			base: this,
+			network: options.network,
+			mvr: options.mvr,
+		});
+	}
+}