@mysten/sui 2.28.0 → 2.29.0

package/dist/grpc/transport.mjs

@@ -0,0 +1,97 @@
+import { RpcError } from "@protobuf-ts/runtime-rpc";
+import { GrpcStatusCode, GrpcWebFetchTransport } from "@protobuf-ts/grpcweb-transport";
+
+//#region src/grpc/transport.ts
+const MESSAGE_DECODED = Symbol.for("@mysten/sui/grpc/decoded-status-message");
+function decodeGrpcStatusMessage(message) {
+	if (!message.includes("%")) return message;
+	try {
+		return decodeURIComponent(message);
+	} catch {
+		return message;
+	}
+}
+function markStatusMessageRead(error) {
+	if (MESSAGE_DECODED in error) return false;
+	Object.defineProperty(error, MESSAGE_DECODED, {
+		value: true,
+		configurable: true
+	});
+	return true;
+}
+function decodeStatusMessageOnce(error) {
+	if (markStatusMessageRead(error)) error.message = decodeGrpcStatusMessage(error.message);
+}
+/** Whether this package's transport decoded the error's status text. */
+function hasDecodedStatusMessage(error) {
+	return MESSAGE_DECODED in error;
+}
+function readProperty(value, key) {
+	if (typeof value !== "object" || value === null) return void 0;
+	try {
+		return value[key];
+	} catch {
+		return;
+	}
+}
+function abortStatus(reason) {
+	const code = readProperty(reason, "code");
+	if (typeof code === "string" && typeof GrpcStatusCode[code] === "number") return code;
+	return readProperty(reason, "name") === "TimeoutError" ? GrpcStatusCode[GrpcStatusCode.DEADLINE_EXCEEDED] : GrpcStatusCode[GrpcStatusCode.CANCELLED];
+}
+function isAbortReasonText(message, reason) {
+	if (typeof reason === "string") return message === reason;
+	const reasonMessage = readProperty(reason, "message");
+	return typeof reasonMessage === "string" && message === reasonMessage;
+}
+function normalizeGrpcError(error, signal) {
+	try {
+		normalize(error, signal);
+	} catch {}
+}
+function normalize(error, signal) {
+	if (!(error instanceof RpcError)) return;
+	if (signal?.aborted && (error.code === GrpcStatusCode[GrpcStatusCode.INTERNAL] || error.code === GrpcStatusCode[GrpcStatusCode.CANCELLED])) {
+		error.code = abortStatus(signal.reason);
+		if (isAbortReasonText(error.message, signal.reason)) markStatusMessageRead(error);
+		else decodeStatusMessageOnce(error);
+		return;
+	}
+	decodeStatusMessageOnce(error);
+}
+function normalizeRejections(promises, signal) {
+	for (const promise of promises) promise.then(void 0, (error) => normalizeGrpcError(error, signal));
+}
+/**
+* `GrpcWebFetchTransport` from `@protobuf-ts/grpcweb-transport`, subclassed to decode status
+* messages and to code an aborted call from its reason rather than as `INTERNAL`.
+*
+* `SuiGrpcClient` builds one by default. A transport imported from `@protobuf-ts/grpcweb-transport`
+* keeps that package's behaviour.
+*/
+var GrpcWebFetchTransport$1 = class extends GrpcWebFetchTransport {
+	unary(method, input, options) {
+		const call = super.unary(method, input, options);
+		normalizeRejections([
+			call.headers,
+			call.response,
+			call.status,
+			call.trailers
+		], options.abort);
+		return call;
+	}
+	serverStreaming(method, input, options) {
+		const call = super.serverStreaming(method, input, options);
+		call.responses.onError((error) => normalizeGrpcError(error, options.abort));
+		normalizeRejections([
+			call.headers,
+			call.status,
+			call.trailers
+		], options.abort);
+		return call;
+	}
+};
+
+//#endregion
+export { GrpcWebFetchTransport$1 as GrpcWebFetchTransport, hasDecodedStatusMessage };
+//# sourceMappingURL=transport.mjs.map

package/dist/grpc/transport.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.mjs","names":["GrpcWebFetchTransport","UpstreamGrpcWebFetchTransport"],"sources":["../../src/grpc/transport.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { GrpcStatusCode } from '@protobuf-ts/grpcweb-transport';\nimport { GrpcWebFetchTransport as UpstreamGrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';\nimport type {\n\tMethodInfo,\n\tRpcOptions,\n\tServerStreamingCall,\n\tUnaryCall,\n} from '@protobuf-ts/runtime-rpc';\nimport { RpcError } from '@protobuf-ts/runtime-rpc';\n\n// A failed call rejects four promises with the same error, so it is only decoded once. Registered\n// globally so another installed copy of this package sees the same marker.\nconst MESSAGE_DECODED = Symbol.for('@mysten/sui/grpc/decoded-status-message');\n\n// `grpc-message` is percent-encoded on the wire and the upstream transport does not decode it:\n// https://github.com/timostamm/protobuf-ts/pull/739\nfunction decodeGrpcStatusMessage(message: string): string {\n\tif (!message.includes('%')) return message;\n\n\ttry {\n\t\treturn decodeURIComponent(message);\n\t} catch {\n\t\treturn message;\n\t}\n}\n\nfunction markStatusMessageRead(error: RpcError): boolean {\n\tif (MESSAGE_DECODED in error) return false;\n\tObject.defineProperty(error, MESSAGE_DECODED, { value: true, configurable: true });\n\n\treturn true;\n}\n\nfunction decodeStatusMessageOnce(error: RpcError): void {\n\tif (markStatusMessageRead(error)) error.message = decodeGrpcStatusMessage(error.message);\n}\n\n/** Whether this package's transport decoded the error's status text. */\nexport function hasDecodedStatusMessage(error: object): boolean {\n\treturn MESSAGE_DECODED in error;\n}\n\n// An abort reason is arbitrary, and reading a property on it runs code the caller wrote. A read\n// that throws counts as absent, so one bad accessor does not decide the status.\nfunction readProperty(value: unknown, key: 'code' | 'name' | 'message'): unknown {\n\tif (typeof value !== 'object' || value === null) return undefined;\n\n\ttry {\n\t\treturn (value as Record<string, unknown>)[key];\n\t} catch {\n\t\treturn undefined;\n\t}\n}\n\n// The reason is read by shape, since another copy of runtime-rpc or another realm fails\n// `instanceof`. `AbortSignal.timeout` aborts with a `TimeoutError`.\nfunction abortStatus(reason: unknown): string {\n\tconst code = readProperty(reason, 'code');\n\n\t// A status name maps to a number; `in` would also match the enum's reverse mapping.\n\tif (\n\t\ttypeof code === 'string' &&\n\t\ttypeof GrpcStatusCode[code as keyof typeof GrpcStatusCode] === 'number'\n\t) {\n\t\treturn code;\n\t}\n\n\treturn readProperty(reason, 'name') === 'TimeoutError'\n\t\t? GrpcStatusCode[GrpcStatusCode.DEADLINE_EXCEEDED]\n\t\t: GrpcStatusCode[GrpcStatusCode.CANCELLED];\n}\n\n// The transport reuses the abort reason's message, so matching it says the text is local. A fetch\n// that substitutes its own error (node-fetch) gives text of its own, which holds nothing to decode.\n// The reason is never coerced: a symbol or a throwing hook would throw here.\nfunction isAbortReasonText(message: string, reason: unknown): boolean {\n\tif (typeof reason === 'string') return message === reason;\n\n\tconst reasonMessage = readProperty(reason, 'message');\n\n\treturn typeof reasonMessage === 'string' && message === reasonMessage;\n}\n\n// Rewritten in place, so every promise a call rejects surfaces the same error. Only the two codes\n// upstream uses for an abort are re-coded; a failure that raced the abort is relabelled with it.\nfunction normalizeGrpcError(error: unknown, signal: AbortSignal | undefined): void {\n\ttry {\n\t\tnormalize(error, signal);\n\t} catch {\n\t\t// Never an unhandled rejection from a discarded handler: the call reports what it was going\n\t\t// to report.\n\t}\n}\n\nfunction normalize(error: unknown, signal: AbortSignal | undefined): void {\n\tif (!(error instanceof RpcError)) return;\n\n\tif (\n\t\tsignal?.aborted &&\n\t\t(error.code === GrpcStatusCode[GrpcStatusCode.INTERNAL] ||\n\t\t\terror.code === GrpcStatusCode[GrpcStatusCode.CANCELLED])\n\t) {\n\t\terror.code = abortStatus(signal.reason);\n\n\t\t// Text the abort reason supplied is local and holds nothing to decode; anything else came off\n\t\t// the wire, even though the abort is what the caller sees. Settled here for the other promises\n\t\t// the call rejects, which no longer match the codes above.\n\t\tif (isAbortReasonText(error.message, signal.reason)) markStatusMessageRead(error);\n\t\telse decodeStatusMessageOnce(error);\n\n\t\treturn;\n\t}\n\n\tdecodeStatusMessageOnce(error);\n}\n\nfunction normalizeRejections(promises: Promise<unknown>[], signal: AbortSignal | undefined) {\n\tfor (const promise of promises) {\n\t\t// Registered before the call is returned, so it runs before the consumer's own await.\n\t\tpromise.then(undefined, (error: unknown) => normalizeGrpcError(error, signal));\n\t}\n}\n\n/**\n * `GrpcWebFetchTransport` from `@protobuf-ts/grpcweb-transport`, subclassed to decode status\n * messages and to code an aborted call from its reason rather than as `INTERNAL`.\n *\n * `SuiGrpcClient` builds one by default. A transport imported from `@protobuf-ts/grpcweb-transport`\n * keeps that package's behaviour.\n */\nexport class GrpcWebFetchTransport extends UpstreamGrpcWebFetchTransport {\n\toverride unary<I extends object, O extends object>(\n\t\tmethod: MethodInfo<I, O>,\n\t\tinput: I,\n\t\toptions: RpcOptions,\n\t): UnaryCall<I, O> {\n\t\tconst call = super.unary(method, input, options);\n\n\t\tnormalizeRejections([call.headers, call.response, call.status, call.trailers], options.abort);\n\n\t\treturn call;\n\t}\n\n\toverride serverStreaming<I extends object, O extends object>(\n\t\tmethod: MethodInfo<I, O>,\n\t\tinput: I,\n\t\toptions: RpcOptions,\n\t): ServerStreamingCall<I, O> {\n\t\tconst call = super.serverStreaming(method, input, options);\n\n\t\t// A finite stream is often read through `responses` without awaiting `status`.\n\t\tcall.responses.onError((error) => normalizeGrpcError(error, options.abort));\n\t\tnormalizeRejections([call.headers, call.status, call.trailers], options.abort);\n\n\t\treturn call;\n\t}\n}\n"],"mappings":";;;;AAeA,MAAM,kBAAkB,OAAO,IAAI,0CAA0C;AAI7E,SAAS,wBAAwB,SAAyB;AACzD,KAAI,CAAC,QAAQ,SAAS,IAAI,CAAE,QAAO;AAEnC,KAAI;AACH,SAAO,mBAAmB,QAAQ;SAC3B;AACP,SAAO;;;AAIT,SAAS,sBAAsB,OAA0B;AACxD,KAAI,mBAAmB,MAAO,QAAO;AACrC,QAAO,eAAe,OAAO,iBAAiB;EAAE,OAAO;EAAM,cAAc;EAAM,CAAC;AAElF,QAAO;;AAGR,SAAS,wBAAwB,OAAuB;AACvD,KAAI,sBAAsB,MAAM,CAAE,OAAM,UAAU,wBAAwB,MAAM,QAAQ;;;AAIzF,SAAgB,wBAAwB,OAAwB;AAC/D,QAAO,mBAAmB;;AAK3B,SAAS,aAAa,OAAgB,KAA2C;AAChF,KAAI,OAAO,UAAU,YAAY,UAAU,KAAM,QAAO;AAExD,KAAI;AACH,SAAQ,MAAkC;SACnC;AACP;;;AAMF,SAAS,YAAY,QAAyB;CAC7C,MAAM,OAAO,aAAa,QAAQ,OAAO;AAGzC,KACC,OAAO,SAAS,YAChB,OAAO,eAAe,UAAyC,SAE/D,QAAO;AAGR,QAAO,aAAa,QAAQ,OAAO,KAAK,iBACrC,eAAe,eAAe,qBAC9B,eAAe,eAAe;;AAMlC,SAAS,kBAAkB,SAAiB,QAA0B;AACrE,KAAI,OAAO,WAAW,SAAU,QAAO,YAAY;CAEnD,MAAM,gBAAgB,aAAa,QAAQ,UAAU;AAErD,QAAO,OAAO,kBAAkB,YAAY,YAAY;;AAKzD,SAAS,mBAAmB,OAAgB,QAAuC;AAClF,KAAI;AACH,YAAU,OAAO,OAAO;SACjB;;AAMT,SAAS,UAAU,OAAgB,QAAuC;AACzE,KAAI,EAAE,iBAAiB,UAAW;AAElC,KACC,QAAQ,YACP,MAAM,SAAS,eAAe,eAAe,aAC7C,MAAM,SAAS,eAAe,eAAe,aAC7C;AACD,QAAM,OAAO,YAAY,OAAO,OAAO;AAKvC,MAAI,kBAAkB,MAAM,SAAS,OAAO,OAAO,CAAE,uBAAsB,MAAM;MAC5E,yBAAwB,MAAM;AAEnC;;AAGD,yBAAwB,MAAM;;AAG/B,SAAS,oBAAoB,UAA8B,QAAiC;AAC3F,MAAK,MAAM,WAAW,SAErB,SAAQ,KAAK,SAAY,UAAmB,mBAAmB,OAAO,OAAO,CAAC;;;;;;;;;AAWhF,IAAaA,0BAAb,cAA2CC,sBAA8B;CACxE,AAAS,MACR,QACA,OACA,SACkB;EAClB,MAAM,OAAO,MAAM,MAAM,QAAQ,OAAO,QAAQ;AAEhD,sBAAoB;GAAC,KAAK;GAAS,KAAK;GAAU,KAAK;GAAQ,KAAK;GAAS,EAAE,QAAQ,MAAM;AAE7F,SAAO;;CAGR,AAAS,gBACR,QACA,OACA,SAC4B;EAC5B,MAAM,OAAO,MAAM,gBAAgB,QAAQ,OAAO,QAAQ;AAG1D,OAAK,UAAU,SAAS,UAAU,mBAAmB,OAAO,QAAQ,MAAM,CAAC;AAC3E,sBAAoB;GAAC,KAAK;GAAS,KAAK;GAAQ,KAAK;GAAS,EAAE,QAAQ,MAAM;AAE9E,SAAO"}

package/dist/transactions/Transaction.d.mts

@@ -8,7 +8,7 @@ import { createPure } from "./pure.mjs";
 import { SignatureWithBytes, Signer } from "../cryptography/keypair.mjs";
 import "../cryptography/index.mjs";
 import { ClientWithCoreApi } from "../client/core.mjs";
-import * as _mysten_bcs1240 from "@mysten/bcs";
+import * as _mysten_bcs1391 from "@mysten/bcs";
 import { SerializedBcs } from "@mysten/bcs";
 import { InferInput } from "valibot";
 
@@ -91,7 +91,7 @@ declare class Transaction {
   getData(): {
     version: 2;
     sender?: string | null | undefined;
-    expiration?: _mysten_bcs1240.EnumOutputShapeWithKeys<{
+    expiration?: _mysten_bcs1391.EnumOutputShapeWithKeys<{
       None: true;
       Epoch: string | number;
       ValidDuring: {
@@ -114,7 +114,7 @@ declare class Transaction {
         chain: string;
         nonce: number;
       };
-    }, "Epoch" | "None" | "ValidDuring" | "Validity"> | null | undefined;
+    }, "None" | "Epoch" | "ValidDuring" | "Validity"> | null | undefined;
     gasData: {
       budget: string | number | null;
       price: string | number | null;
@@ -125,8 +125,8 @@ declare class Transaction {
         digest: string;
       }[] | null;
     };
-    inputs: _mysten_bcs1240.EnumOutputShapeWithKeys<{
-      Object: _mysten_bcs1240.EnumOutputShapeWithKeys<{
+    inputs: _mysten_bcs1391.EnumOutputShapeWithKeys<{
+      Object: _mysten_bcs1391.EnumOutputShapeWithKeys<{
         ImmOrOwnedObject: {
           objectId: string;
           version: string | number;
@@ -142,7 +142,7 @@ declare class Transaction {
           version: string | number;
           digest: string;
         };
-      }, "Receiving" | "ImmOrOwnedObject" | "SharedObject">;
+      }, "ImmOrOwnedObject" | "SharedObject" | "Receiving">;
       Pure: {
         bytes: string;
       };
@@ -165,13 +165,13 @@ declare class Transaction {
           Balance: string;
           $kind: "Balance";
         };
-        withdrawFrom: _mysten_bcs1240.EnumOutputShapeWithKeys<{
+        withdrawFrom: _mysten_bcs1391.EnumOutputShapeWithKeys<{
           Sender: true;
           Sponsor: true;
         }, "Sender" | "Sponsor">;
       };
-    }, "Object" | "Pure" | "FundsWithdrawal" | "UnresolvedPure" | "UnresolvedObject">[];
-    commands: _mysten_bcs1240.EnumOutputShapeWithKeys<{
+    }, "Pure" | "Object" | "FundsWithdrawal" | "UnresolvedPure" | "UnresolvedObject">[];
+    commands: _mysten_bcs1391.EnumOutputShapeWithKeys<{
       MoveCall: {
         package: string;
         module: string;