aftermath-ts-sdk 2.0.0 → 2.1.0-dev.2dc2267

package/README.md

@@ -13,8 +13,8 @@ npm i aftermath-ts-sdk
 For most integrations, use the Aftermath SDK for simplified access:
 
 ```typescript
-const afSdk = new Aftermath("MAINNET"); // "MAINNET" | "TESTNET"
-await afSdk.init(); // initialize provider
+// "MAINNET" | "TESTNET" | "DEVNET" | "LOCAL"
+const afSdk = await Aftermath.create({ network: "MAINNET" });
 
 // Access protocols
 const router = afSdk.Router();
@@ -29,16 +29,19 @@ const dca = afSdk.Dca();
 For complex transaction construction, use AftermathApi for direct control:
 
 ```typescript
-const afSdk = new Aftermath("MAINNET");
-const addresses = afSdk.getAddresses();
+import { SuiGrpcClient } from "@mysten/sui/grpc";
+import { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
+
+const afSdk = await Aftermath.create({ network: "MAINNET" });
+const addresses = await afSdk.getAddresses();
+
+const fullnodeUrl = "https://fullnode.mainnet.sui.io";
 
 const afApi = new AftermathApi(
-	new SuiClient({
-		transport: new SuiHTTPTransport({
-			url: "https://fullnode.mainnet.sui.io",
-		}),
-	}),
-	addresses // Configuration addresses
+	new SuiGrpcClient({ network: "mainnet", baseUrl: fullnodeUrl }),
+	addresses, // Configuration addresses
+	// Still required by the few helpers that have no gRPC equivalent — see below
+	new SuiJsonRpcClient({ network: "mainnet", url: fullnodeUrl })
 );
 
 // Access protocol APIs
@@ -47,6 +50,29 @@ const stakingApi = afApi.Staking();
 const farmsApi = afApi.Farms();
 ```
 
+`Aftermath.create`'s `fullnodeUrl` option takes a **gRPC base URL** (it is passed
+to `SuiGrpcClient` as `baseUrl`, and to `SuiJsonRpcClient` as `url`). Sui
+fullnodes serve both protocols from the same host, so a single URL is enough.
+
+### Remaining JSON-RPC surface
+
+Sui JSON-RPC is deprecated and scheduled for removal from fullnodes in
+mid-October 2026. Every fullnode call this SDK makes goes over gRPC **except**
+the following, which cannot be expressed with `SuiGrpcClient` without changing
+what they return:
+
+| Helper | Why |
+| --- | --- |
+| `Events().fetchCastEventsWithCursor` | `suix_queryEvents` has no `SuiGrpcClient` equivalent; `ledgerService.ListEvents` has a different filter model and BCS-only payloads |
+| `Transactions().fetchTransactionsWithCursor` | `suix_queryTransactionBlocks` has no gRPC equivalent at all |
+| `Objects().fetchObject` / `fetchObjectGeneral` / `fetchObjectBatch` / `fetchOwnedObjects` | gRPC returns Move object contents as BCS bytes or as a differently-shaped `json` view, so the parsed `content.fields` these helpers' casters consume cannot be reproduced |
+| `DynamicFields().fetchDynamicFieldObject` | same; gRPC returns the field value as BCS bytes |
+| `Sui().fetchSystemState` (deprecated) | gRPC has no `SuiSystemStateSummary` equivalent |
+
+Prefer the Aftermath API (`Aftermath.create(...)`'s high-level providers) for
+events, transaction history and system state — those already avoid the fullnode
+entirely.
+
 ## Available Protocols
 
 ### Pools (AMM)