@instadapp/fluid-sui-read-sdk 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# fluid-sui-read-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Read-only TypeScript SDK for Fluid on Sui. Same shape as the Solana reader `@jup-ag/lend-read`: `client.liquidity`, `client.lending`, `client.vault`, `client.oracle`. Built on `@mysten/sui` v2.
+
+```sh
+npm i @instadapp/fluid-sui-read-sdk @mysten/sui
+```
+
+```ts
+import { Client } from "@instadapp/fluid-sui-read-sdk";
+
+const client = new Client(); // staging deployment on Sui mainnet, pure on-chain state
+console.log(await client.vault.getTotalVaults());
+const vault = await client.vault.getVaultEntireData(1);
+const fUsdc = await client.lending.getFTokenDetails(
+  "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
+);
+const price = await client.oracle.getOraclePrice(1); // { operate, liquidate, source: "v2" }
+```
+
+Endpoint failover: `new Client(["https://fullnode.mainnet.sui.io:443", "jsonrpc+https://my-node.example:9000"])`.
+
+## Positions per wallet
+
+The default client can't enumerate a wallet's positions (`getAllUserPositions` throws `NeedsDiscoveryError`). Enable fullnode discovery:
+
+```ts
+const client = new Client(undefined, { discovery: "fullnode" });
+const mine = await client.vault.getAllUserPositions("0x<wallet>");
+```
+
+Discovery levels: `"state"` (default, pure object reads + view simulation), `"fullnode"` (adds fullnode indexes), `"indexer"` (adds GraphQL event scans, last resort). A read that needs more throws `NeedsDiscoveryError`; it never silently falls back.
+
+## Units
+
+- Vault-side amounts: the vault's internal 1e9 space. Liquidity-side: token units. `Vault.unscale(x, decimals)` converts.
+- Oracle rates: debt-per-collateral × 1e15.
+
+## Config
+
+**The built-in ids are the STAGING deployment on Sui mainnet, not production** and will change at launch. `"mainnet"` / `MAINNET` are deprecated aliases of it.
+
+To use your own deployment, pass a config built from a deployment record (`packages.{library,liquidity,lending,oracle,vaults}.packageId`, plus `objects.registry` for all but `library`):
+
+```ts
+import { Client, configFromDeployment, STAGING } from "@instadapp/fluid-sui-read-sdk";
+
+const cfg = configFromDeployment(rec, { network: "mainnet", oracleV2: STAGING.oracleV2 });
+const client = new Client(undefined, { network: cfg });
+```
+
+## Tests
+
+```
+npm test            # offline
+npm run test:live   # mainnet, read-only
+```

package/dist/chunk-15K8U1wQ.mjs

@@ -0,0 +1,18 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+export { __exportAll as t };