@mysten/docs 0.1.56 → 0.1.58

package/dist/sui/clients/grpc.md

@@ -55,16 +55,39 @@ console.log(transaction.digest, result.protoJson);
 
 ## Transport options
 
-By default, `SuiGrpcClient` uses `GrpcWebFetchTransport` from
-[protobuf-ts](https://github.com/timostamm/protobuf-ts), which works in browsers and Node.js through
-the Fetch API. The `GrpcWebFetchTransport` class, `GrpcWebOptions` type, and `RpcTransport` type are
-re-exported from `@mysten/sui/grpc`, so you can configure a transport without adding
-`@protobuf-ts/*` as a direct dependency.
+By default, `SuiGrpcClient` uses `GrpcWebFetchTransport`, which works in browsers and Node.js
+through the Fetch API. `@mysten/sui/grpc` exports it alongside the `GrpcWebOptions` and
+`RpcTransport` types, and the `RpcError` class and `GrpcStatusCode` enum that gRPC failures use, so
+you can configure a transport and handle its errors without adding `@protobuf-ts/*` as a direct
+dependency.
+
+That class extends the transport of the same name from
+[protobuf-ts](https://github.com/timostamm/protobuf-ts) and fixes two defects in it:
+
+- It decodes status messages, rather than delivering them as `Object%20not%20found:%200x1`.
+- It codes a call that an abort ended from the reason the abort carried: `DEADLINE_EXCEEDED` for an
+  `AbortSignal.timeout`, the status on a reason carrying one, and `CANCELLED` otherwise. Upstream
+  reports all but a standard `AbortError` cancellation as `INTERNAL`.
+
+Build custom transports from this class. `SuiGrpcClient` uses a transport you pass it as given.
 
 ### gRPC-web transport (default)
 
-The default transport uses the gRPC-web protocol over HTTP/1.1 or HTTP/2. Pass
-`GrpcWebFetchTransport` options to customize it:
+The default transport uses the gRPC-web protocol over HTTP/1.1 or HTTP/2. `SuiGrpcClient` passes the
+`GrpcWebOptions` it is given to the transport it builds, so most configuration needs no transport of
+your own. The one exception is `abort`: Core API calls each carry their own signal, so a client-wide
+one is not forwarded.
+
+```typescript
+
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://your-custom-grpc-endpoint.com',
+	format: 'binary', // default is 'text' (base64-encoded)
+});
+```
+
+Build the transport yourself to share one between clients, or to subclass it:
 
 ```typescript
 
@@ -228,6 +251,7 @@ const result = parseGrpcTransactionResponse(response.transaction!, {
 | `parseGrpcTransactionResponse`                            | Raw `ExecutedTransaction` to the unified result shape |
 | `parseGrpcSimulateTransactionResponse`                    | Raw simulation response to the unified result shape   |
 | `GrpcWebFetchTransport`, `GrpcWebOptions`, `RpcTransport` | Configuring a [transport](#transport-options)         |
+| `RpcError`, `GrpcStatusCode`                              | Narrowing and coding gRPC failures                    |
 | `SuiGrpcClientOptions`, `GrpcTransactionInclude`, …       | Typing your own wrappers around the client            |
 | `isSuiGrpcClient`                                         | Type guard for narrowing an unknown client            |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten/docs",
-  "version": "0.1.56",
+  "version": "0.1.58",
   "description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
   "license": "Apache-2.0",
   "repository": {
@@ -28,27 +28,27 @@
     "next": "^16.3.1",
     "react": "^19.2.8",
     "react-dom": "^19.2.8",
-    "@mysten/aws-kms-signer": "0.3.18",
+    "@mysten/aws-kms-signer": "0.3.19",
     "@mysten/bcs": "2.1.1",
-    "@mysten/deepbook-v3": "2.1.3",
-    "@mysten/dapp-kit-react": "2.1.23",
-    "@mysten/dapp-kit-core": "1.6.21",
-    "@mysten/enoki": "1.2.19",
-    "@mysten/enoki-connect": "1.1.21",
-    "@mysten/kiosk": "1.4.7",
-    "@mysten/ledger-signer": "0.2.21",
-    "@mysten/payment-kit": "0.2.21",
-    "@mysten/gcp-kms-signer": "0.2.21",
-    "@mysten/seal": "1.4.7",
-    "@mysten/slush-wallet": "1.1.21",
-    "@mysten/signers": "1.1.21",
-    "@mysten/sui": "2.28.0",
+    "@mysten/dapp-kit-react": "2.1.25",
+    "@mysten/deepbook-v3": "2.1.4",
+    "@mysten/dapp-kit-core": "1.6.23",
+    "@mysten/enoki": "1.2.20",
+    "@mysten/enoki-connect": "1.1.22",
+    "@mysten/gcp-kms-signer": "0.2.22",
+    "@mysten/kiosk": "1.4.8",
+    "@mysten/seal": "1.4.8",
+    "@mysten/signers": "1.1.22",
+    "@mysten/ledger-signer": "0.2.22",
+    "@mysten/slush-wallet": "1.1.23",
+    "@mysten/payment-kit": "0.2.22",
+    "@mysten/sui": "2.29.0",
+    "@mysten/suins": "2.0.4",
     "@mysten/utils": "0.4.1",
-    "@mysten/wallet-standard": "0.21.21",
-    "@mysten/suins": "2.0.3",
-    "@mysten/walrus": "1.2.22",
-    "@mysten/webcrypto-signer": "0.2.21",
-    "@mysten/zksend": "1.2.22"
+    "@mysten/wallet-standard": "0.21.22",
+    "@mysten/walrus": "1.2.23",
+    "@mysten/webcrypto-signer": "0.2.22",
+    "@mysten/zksend": "1.2.23"
   },
   "devDependencies": {
     "@tailwindcss/postcss": "^4.3.3",