@suigar/sdk 2.0.0-beta.1 → 2.0.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @suigar/sdk
 
+## 2.0.0-beta.3
+
+### Patch Changes
+
+- e1cdedc: - Fix exported transaction option types so `BuildGameOptions` and `BuildPvPGameOptions` no longer require the internal `config` field
+  - Update installation and integration documentation for Sui 2.0+ by switching examples to `SuiGrpcClient`, clarifying required peer dependencies, and aligning transaction-result examples with the current client API.
+
+## 2.0.0-beta.2
+
+### Patch Changes
+
+- 128cb6c: - `suigar()` now only accepts the extension `name`.
+  - The SDK now validates the connected client network and supports `mainnet` and `testnet`.
+  - Added `client.suigar.getConfig()` to inspect the resolved network config at runtime.
+  - Exported the `SuiNetwork` type and `resolveGamePackageId()` helper.
+  - Reworked `SuigarConfig` into a network-resolved structure with `packageIds`, `coinTypes`, and `priceInfoObjectIds`.
+  - Replaced the old Pyth-specific price object resolution flow with supported-coin-based `priceInfoObjectId` resolution.
+  - Split package and coin configuration into explicit `mainnet` and `testnet` maps and updated transaction builders to use the new structure.
+  - Updated generated event helpers, tests, and documentation to match the new configuration and event parsing flow.
+
+  Notes:
+  - Existing prerelease integrations using `suigar({ ...configOverrides })` will need to migrate to `suigar()`.
+  - Runtime config inspection should now use `client.suigar.getConfig()`.
+
+## 2.0.0-beta.1
+
+### Patch Changes
+
+- Updated the npm release workflows to install dependencies without a committed lockfile and removed the obsolete Node.js cache configuration.
+- Simplified previous-release deprecation logic so prerelease publishes do not attempt to deprecate earlier npm versions.
+- Stopped tracking `package-lock.json` and removed the obsolete changeset file after the version bump.
+
 ## 2.0.0-beta.0
 
 ### Major Changes

package/README.md

@@ -5,13 +5,17 @@ TypeScript SDK for building Suigar v2 game transactions on Sui.
 ## Installation
 
 ```bash
-npm install @suigar/sdk
+npm install --save @suigar/sdk @mysten/sui @mysten/bcs
 ```
 
 Runtime requirements:
 
 - Node.js `>=22`
-- `@mysten/sui`
+- ESM project configuration (`"type": "module"`)
+- `@mysten/sui` v2
+- `@mysten/bcs` v2
+
+This SDK targets Sui TypeScript SDK 2.0+ only. Follow the official [Sui 2.0 migration guide](https://sdk.mystenlabs.com/sui/migrations/sui-2.0) if your app still uses the pre-2.0 client API.
 
 ## What This Package Exposes
 
@@ -27,9 +31,10 @@ It also does not export `SuigarClient` as a public root symbol.
 What you actually use at runtime is the registered extension instance:
 
 ```ts
-const client = new SuiClient({ url }).$extend(suigar());
+const client = new SuiGrpcClient({ baseUrl, network }).$extend(suigar());
 
 client.suigar.serializeTransactionToBase64(...);
+client.suigar.getConfig();
 client.suigar.bcs;
 client.suigar.tx;
 ```
@@ -37,19 +42,13 @@ client.suigar.tx;
 ## Quick Start
 
 ```ts
-import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { SuiGrpcClient } from '@mysten/sui/grpc';
 import { suigar } from '@suigar/sdk';
 
-const client = new SuiClient({
-	url: getFullnodeUrl('testnet'),
-}).$extend(
-	suigar({
-		pyth: {
-			suiPriceInfoObjectId: '0xPYTH_SUI_PRICE_INFO',
-			usdcPriceInfoObjectId: '0xPYTH_USDC_PRICE_INFO',
-		},
-	}),
-);
+const client = new SuiGrpcClient({
+	baseUrl: 'https://fullnode.testnet.sui.io:443',
+	network: 'testnet',
+}).$extend(suigar());
 
 const tx = client.suigar.tx.createBetTransaction('coinflip', {
 	owner: '0x123',
@@ -68,7 +67,7 @@ const base64 = await client.suigar.serializeTransactionToBase64(tx);
 Creates a named Sui client extension. By default, it registers under `client.suigar`.
 
 ```ts
-const client = new SuiClient({ url }).$extend(suigar());
+const client = new SuiGrpcClient({ baseUrl, network }).$extend(suigar());
 
 client.suigar;
 ```
@@ -76,69 +75,55 @@ client.suigar;
 You can rename the extension:
 
 ```ts
-const client = new SuiClient({ url }).$extend(suigar({ name: 'casino' }));
+const client = new SuiGrpcClient({ baseUrl, network }).$extend(
+	suigar({ name: 'games' }),
+);
 
-client.casino.tx;
-client.casino.bcs;
+client.games.tx;
+client.games.bcs;
 ```
 
 ## Config
 
 `suigar(options?)` resolves config from:
 
-- the connected Sui network
-- internal default package ids
-- internal default SweetHouse package id by network
-- default coin types for `SUI`, `USDC`, and FlowX `USDC`
-- user overrides
+- internal package ids by network
+- internal supported coin types by network
+- internal price info object ids by network
+- the connected client network
+- the extension name
 
 Supported override areas:
 
 - `name`
-- `sweetHousePackageId`
-- `coinTypes.sui`
-- `coinTypes.usdc`
-- `coinTypes.usdcFlowx`
-- `gamesPackageId.coinflip`
-- `gamesPackageId.limbo`
-- `gamesPackageId.plinko`
-- `gamesPackageId['pvp-coinflip']`
-- `gamesPackageId.range`
-- `gamesPackageId.wheel`
-- `pyth.packageId`
-- `pyth.suiPriceInfoObjectId`
-- `pyth.usdcPriceInfoObjectId`
-- `pyth.priceInfoObjectIds[coinType]`
-
-Example:
-
-```ts
-const client = new SuiClient({ url }).$extend(
-	suigar({
-		sweetHousePackageId: '0xsweethouse',
-		pyth: {
-			suiPriceInfoObjectId: '0xsui',
-			usdcPriceInfoObjectId: '0xusdc',
-			priceInfoObjectIds: {
-				'0x123::custom::TOKEN': '0xprice',
-			},
-		},
-		gamesPackageId: {
-			coinflip: '0xcoinflip',
-			wheel: '0xwheel',
-		},
-	}),
-);
-```
 
 ## Runtime Surface
 
 The registered extension instance exposes three main areas:
 
+- `getConfig()`
 - `serializeTransactionToBase64(transaction, options?)`
 - `bcs`
 - `tx`
 
+### `getConfig()`
+
+Returns the resolved SDK configuration for the connected network.
+
+This is intended mainly for debugging and inspection, for example to verify the
+resolved package ids or supported coin mappings for the active client network.
+
+It includes:
+
+- `packageIds`
+- `coinTypes`
+- `priceInfoObjectIds`
+
+```ts
+const config = client.suigar.getConfig();
+console.log(config.packageIds);
+```
+
 ### `serializeTransactionToBase64(transaction, options?)`
 
 Builds a transaction with the configured Sui client and returns base64-encoded transaction bytes.
@@ -191,7 +176,7 @@ Shared behavior:
 - `betCount` defaults to `1`
 - `sender` overrides the transaction sender
 - `metadata` is encoded into `keys` and `values` byte arrays
-- the SDK resolves the Pyth price info object from the configured coin mapping
+- the SDK resolves the price info object from the configured supported-coin mapping
 - the reward object is transferred back to `owner`
 
 Per-game options:
@@ -296,19 +281,45 @@ Current exposed helpers:
 - `PvPCoinflipGameResolved`
 - `PvPCoinflipGameCancelled`
 
-These are generated Move struct/event decoders. Use them to parse Suigar event payloads and structured onchain content.
+These are generated Move event decoders. Use them to parse Suigar event payloads from transaction results.
 
 ### Parse Standard Bet Result Data
 
 ```ts
-const { object } = await client.core.getObject({
-	objectId: '0xOBJECT_ID',
+const executeResult = await client.core.executeTransaction({
+	transaction: transactionBytes,
+	signatures: [signature],
 	include: {
-		content: true,
+		events: true,
 	},
 });
 
-const decoded = client.suigar.bcs.BetResultEvent.parse(object.content);
+const finalResult = await client.core.waitForTransaction({
+	result: executeResult,
+	include: {
+		effects: true,
+		events: true,
+	},
+});
+
+if (finalResult.$kind === 'FailedTransaction') {
+	throw new Error(finalResult.FailedTransaction.status.error?.message);
+}
+
+console.log(finalResult.Transaction.digest);
+
+const transactionResult = finalResult.Transaction;
+
+const betResults = [];
+
+for (const event of transactionResult.events ?? []) {
+	try {
+		const decoded = client.suigar.bcs.BetResultEvent.parse(event.bcs);
+		betResults.push(decoded);
+	} catch {
+		// Ignore non-BetResultEvent payloads.
+	}
+}
 ```
 
 Parsed fields include:
@@ -337,12 +348,16 @@ const metadata = new Map(
 
 Important:
 
-- use `content`, not `objectBcs`, with these generated parsers
-- the generated parser expects the struct payload, not a full object envelope
+- execute or wait for the transaction with `include: { events: true }`
+- unwrap the core API union with `result.$kind`, `result.Transaction`, and `result.FailedTransaction`
+- parse emitted events from the unwrapped transaction result
+- use `event.bcs` for consistent decoding across transports
+- `waitForTransaction({ result, include: { effects: true, events: true } })` is useful when you want the finalized transaction result before decoding
+- these helpers decode the event payload itself, not a full transaction response
 
 ### Parse PvP Coinflip Event Data
 
-Use the matching helper for the PvP coinflip event payload you fetched from chain:
+Use the matching helper for each PvP coinflip event payload found in `transactionResult.events`:
 
 - `client.suigar.bcs.PvPCoinflipGameCreated`
 - `client.suigar.bcs.PvPCoinflipGameResolved`