@suigar/sdk 2.0.0-beta.10 → 2.0.0-beta.11

package/dist/index.cjs

@@ -3,6 +3,7 @@
 var utils = require('@mysten/sui/utils');
 var bcs = require('@mysten/sui/bcs');
 var transactions = require('@mysten/sui/transactions');
+var client = require('@mysten/sui/client');
 
 // src/client.ts
 var MOVE_STDLIB_ADDRESS = utils.normalizeSuiAddress("0x1");
@@ -239,6 +240,12 @@ function VecMap2(...typeParameters) {
 
 // src/contracts/pvp-coinflip/pvp_coinflip.ts
 var $moduleName9 = "0xb43cf6583c0c15315c7e66f173af4be79ac40c38aad1fd92ec08638ab2026202::pvp_coinflip";
+var PvpCoinflipSettingsKey = new MoveStruct({
+  name: `${$moduleName9}::PvpCoinflipSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
 var Game = new MoveStruct({
   name: `${$moduleName9}::Game<phantom T0>`,
   fields: {
@@ -295,6 +302,14 @@ var GameCancelledEvent = new MoveStruct({
     coin_type: TypeName2
   }
 });
+var Parameters = new MoveStruct({
+  name: `${$moduleName9}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    house_edge_bps: bcs.bcs.u64(),
+    min_stake: bcs.bcs.u64()
+  }
+});
 function createGame(options) {
   const packageAddress = options.package ?? "0xb43cf6583c0c15315c7e66f173af4be79ac40c38aad1fd92ec08638ab2026202";
   const argumentsTypes = [
@@ -416,6 +431,7 @@ var REGISTRY_IDS = {
 };
 
 // src/helpers/config.ts
+var DEFAULT_CACHE_TTL_MS = 30 * 60 * 1e3;
 function resolveSuigarConfig(network) {
   const packageIds = PACKAGE_IDS[network];
   const registryIds = REGISTRY_IDS[network];
@@ -477,6 +493,22 @@ function resolveSupportedCoin(config, coinType) {
   }
   return supportedCoin;
 }
+function replaceStructTagAddress(structName, address) {
+  return utils.normalizeStructTag({
+    ...utils.parseStructTag(structName),
+    address
+  });
+}
+function resolveGameSettingsKeyType(structName, packageId) {
+  return replaceStructTagAddress(structName, packageId);
+}
+function resolveCoinTypeNameForTypeNameKey(structName) {
+  const { address } = utils.parseStructTag(structName);
+  return replaceStructTagAddress(
+    structName,
+    utils.normalizeSuiAddress(address).replace(/^0x/, "")
+  );
+}
 var PARTNER_METADATA_KEY = "partner";
 var RESERVED_METADATA_KEYS = /* @__PURE__ */ new Set([PARTNER_METADATA_KEY, "referrer"]);
 var textEncoder = new TextEncoder();
@@ -521,8 +553,22 @@ function encodeBetMetadata(metadata, partner) {
     values
   };
 }
-
-// src/contracts/coinflip/coinflip.ts
+var $moduleName10 = "0xb35c5f286c443752afc8ccb40125a578a4f32df35617170ccfa17fe180ab80ea::coinflip";
+var CoinFlipSettingsKey = new MoveStruct({
+  name: `${$moduleName10}::CoinFlipSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
+var Parameters2 = new MoveStruct({
+  name: `${$moduleName10}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    house_edge: bcs.bcs.u64(),
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64()
+  }
+});
 function play(options) {
   const packageAddress = options.package ?? "0xb35c5f286c443752afc8ccb40125a578a4f32df35617170ccfa17fe180ab80ea";
   const argumentsTypes = [
@@ -550,36 +596,43 @@ var DEFAULT_RANGE_SCALE = 1e6;
 var DEFAULT_LIMBO_MULTIPLIER_SCALE = 100;
 
 // src/utils/numeric.ts
-function isFiniteNumber(value, message) {
-  if (typeof value !== "number") {
-    throw new Error(`${message}: ${String(value)}`);
-  }
-  if (!Number.isFinite(value)) {
-    throw new Error(`Value must be a finite number: ${value}`);
+function assertFiniteNumber(value, errorMessage) {
+  if (typeof value !== "number" || !Number.isFinite(value)) {
+    throw new TypeError(`${errorMessage}: ${String(value)}`);
   }
 }
 function toBigInt(value) {
-  if (typeof value === "bigint") {
-    if (value < 0n) {
-      throw new Error(`Value must be non-negative: ${value}`);
+  let result;
+  try {
+    if (typeof value === "bigint" || typeof value === "string" || typeof value === "boolean") {
+      result = BigInt(value);
+    } else {
+      assertFiniteNumber(
+        value,
+        "Value must be a bigint, number, integer string, or boolean"
+      );
+      result = BigInt(Math.trunc(value));
     }
-    return value;
+  } catch {
+    throw new TypeError(
+      `Value must be a bigint, number, integer string, or boolean: ${value}`
+    );
   }
-  isFiniteNumber(value, "Value must be a bigint or number");
-  if (value < 0) {
-    throw new Error(`Value must be a finite non-negative number: ${value}`);
+  if (result < 0n) {
+    throw new RangeError(`Value must be non-negative: ${value}`);
   }
-  return BigInt(Math.trunc(value));
+  return result;
 }
-function toU8(value) {
-  isFiniteNumber(value, "Value must be a number");
-  if (!Number.isInteger(value)) {
-    throw new Error(`Value must be an integer: ${value}`);
-  }
-  if (value < 0 || value > 255) {
-    throw new Error(`Value must be an integer between 0 and 255: ${value}`);
+function toBoundedInt(value, max, typeName) {
+  const num = typeof value === "string" && value.trim() === "" ? NaN : Number(value);
+  assertFiniteNumber(num, "Value must be a finite number or integer string");
+  if (typeof value === "boolean" || value == null || !Number.isInteger(num) || num < 0 || num > max) {
+    throw new Error(`Value must be a ${typeName} integer (0-${max}): ${value}`);
   }
-  return value;
+  return num;
+}
+function toU8(value) {
+  return toBoundedInt(value, 255, "u8");
 }
 
 // src/types/network.type.ts
@@ -697,8 +750,47 @@ function buildCoinflipTransaction(options) {
     })(tx)
   });
 }
+var $moduleName11 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::i64";
+var I642 = new MoveStruct({
+  name: `${$moduleName11}::I64`,
+  fields: {
+    bits: bcs.bcs.u64()
+  }
+});
+
+// src/contracts/limbo/deps/0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc/float.ts
+var $moduleName12 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::float";
+var Float2 = new MoveStruct({
+  name: `${$moduleName12}::Float`,
+  fields: {
+    is_negative: bcs.bcs.bool(),
+    exp: I642,
+    mant: bcs.bcs.u64()
+  }
+});
 
 // src/contracts/limbo/limbo.ts
+var $moduleName13 = "0x96c7841b9b32c59a219760fd656f1c3aceb53cc74a68ec9844a3a696374309f4::limbo";
+var LimboSettingsKey = new MoveStruct({
+  name: `${$moduleName13}::LimboSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
+var Parameters3 = new MoveStruct({
+  name: `${$moduleName13}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    max_payout: bcs.bcs.u64(),
+    min_target_multiplier: Float2,
+    max_target_multiplier: Float2,
+    max_number_of_games: bcs.bcs.u64(),
+    min_rtp: Float2,
+    max_rtp: Float2
+  }
+});
 function play2(options) {
   const packageAddress = options.package ?? "0x96c7841b9b32c59a219760fd656f1c3aceb53cc74a68ec9844a3a696374309f4";
   const argumentsTypes = [
@@ -756,8 +848,71 @@ function buildLimboTransaction(options) {
     })(tx)
   });
 }
+var $moduleName14 = "0x2::vec_map";
+function Entry3(...typeParameters) {
+  return new MoveStruct({
+    name: `${$moduleName14}::Entry<${typeParameters[0].name}, ${typeParameters[1].name}>`,
+    fields: {
+      key: typeParameters[0],
+      value: typeParameters[1]
+    }
+  });
+}
+function VecMap3(...typeParameters) {
+  return new MoveStruct({
+    name: `${$moduleName14}::VecMap<${typeParameters[0].name}, ${typeParameters[1].name}>`,
+    fields: {
+      contents: bcs.bcs.vector(Entry3(typeParameters[0], typeParameters[1]))
+    }
+  });
+}
+var $moduleName15 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::i64";
+var I643 = new MoveStruct({
+  name: `${$moduleName15}::I64`,
+  fields: {
+    bits: bcs.bcs.u64()
+  }
+});
+
+// src/contracts/plinko/deps/0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc/float.ts
+var $moduleName16 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::float";
+var Float3 = new MoveStruct({
+  name: `${$moduleName16}::Float`,
+  fields: {
+    is_negative: bcs.bcs.bool(),
+    exp: I643,
+    mant: bcs.bcs.u64()
+  }
+});
 
 // src/contracts/plinko/plinko.ts
+var $moduleName17 = "0xd3dd2200883af10811724f0bed97591ad155a02efd6332d471ff8b346030dfb7::plinko";
+var PlinkoSettingsKey = new MoveStruct({
+  name: `${$moduleName17}::PlinkoSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
+var PlinkoConfig = new MoveStruct({
+  name: `${$moduleName17}::PlinkoConfig`,
+  fields: {
+    num_rows: bcs.bcs.u8(),
+    multipliers: bcs.bcs.vector(Float3),
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    is_playable: bcs.bcs.bool()
+  }
+});
+var Parameters4 = new MoveStruct({
+  name: `${$moduleName17}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    max_number_of_balls: bcs.bcs.u64(),
+    configs: VecMap3(bcs.bcs.u8(), PlinkoConfig)
+  }
+});
 function play3(options) {
   const packageAddress = options.package ?? "0xd3dd2200883af10811724f0bed97591ad155a02efd6332d471ff8b346030dfb7";
   const argumentsTypes = [
@@ -884,8 +1039,46 @@ function buildPvPCoinflipTransaction(action, options) {
       throw new Error(`Unsupported PvP coinflip action: ${action}`);
   }
 }
+var $moduleName18 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::i64";
+var I644 = new MoveStruct({
+  name: `${$moduleName18}::I64`,
+  fields: {
+    bits: bcs.bcs.u64()
+  }
+});
+
+// src/contracts/range/deps/0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc/float.ts
+var $moduleName19 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::float";
+var Float4 = new MoveStruct({
+  name: `${$moduleName19}::Float`,
+  fields: {
+    is_negative: bcs.bcs.bool(),
+    exp: I644,
+    mant: bcs.bcs.u64()
+  }
+});
 
 // src/contracts/range/range.ts
+var $moduleName20 = "0x096a4cf18b3661e76b2c62b90785418345d52f45b272448794f123a4cb6b6416::range";
+var RangeSettingsKey = new MoveStruct({
+  name: `${$moduleName20}::RangeSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
+var Parameters5 = new MoveStruct({
+  name: `${$moduleName20}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    min_zone_size: bcs.bcs.u64(),
+    max_zone_size: bcs.bcs.u64(),
+    max_number_of_games: bcs.bcs.u64(),
+    min_rtp: Float4,
+    max_rtp: Float4
+  }
+});
 function play4(options) {
   const packageAddress = options.package ?? "0x096a4cf18b3661e76b2c62b90785418345d52f45b272448794f123a4cb6b6416";
   const argumentsTypes = [
@@ -946,8 +1139,71 @@ function buildRangeTransaction(options) {
     })(tx)
   });
 }
+var $moduleName21 = "0x2::vec_map";
+function Entry4(...typeParameters) {
+  return new MoveStruct({
+    name: `${$moduleName21}::Entry<${typeParameters[0].name}, ${typeParameters[1].name}>`,
+    fields: {
+      key: typeParameters[0],
+      value: typeParameters[1]
+    }
+  });
+}
+function VecMap4(...typeParameters) {
+  return new MoveStruct({
+    name: `${$moduleName21}::VecMap<${typeParameters[0].name}, ${typeParameters[1].name}>`,
+    fields: {
+      contents: bcs.bcs.vector(Entry4(typeParameters[0], typeParameters[1]))
+    }
+  });
+}
+var $moduleName22 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::i64";
+var I645 = new MoveStruct({
+  name: `${$moduleName22}::I64`,
+  fields: {
+    bits: bcs.bcs.u64()
+  }
+});
+
+// src/contracts/wheel/deps/0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc/float.ts
+var $moduleName23 = "0xf391858d2a08473e8d4defcc8df89976bd7b123d3865c6b9341b237f7853dbbc::float";
+var Float5 = new MoveStruct({
+  name: `${$moduleName23}::Float`,
+  fields: {
+    is_negative: bcs.bcs.bool(),
+    exp: I645,
+    mant: bcs.bcs.u64()
+  }
+});
 
 // src/contracts/wheel/wheel.ts
+var $moduleName24 = "0x0997852ded7e13301c42317004bc49704a893aa82997c5706cebee59053a31b7::wheel";
+var WheelSettingsKey = new MoveStruct({
+  name: `${$moduleName24}::WheelSettingsKey`,
+  fields: {
+    dummy_field: bcs.bcs.bool()
+  }
+});
+var WheelConfig = new MoveStruct({
+  name: `${$moduleName24}::WheelConfig`,
+  fields: {
+    num_cases: bcs.bcs.u8(),
+    multipliers: bcs.bcs.vector(Float5),
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    is_playable: bcs.bcs.bool()
+  }
+});
+var Parameters6 = new MoveStruct({
+  name: `${$moduleName24}::Parameters<phantom T0>`,
+  fields: {
+    id: bcs.bcs.Address,
+    min_stake: bcs.bcs.u64(),
+    max_stake: bcs.bcs.u64(),
+    max_number_of_spins: bcs.bcs.u64(),
+    configs: VecMap4(bcs.bcs.u8(), WheelConfig)
+  }
+});
 function play5(options) {
   const packageAddress = options.package ?? "0x0997852ded7e13301c42317004bc49704a893aa82997c5706cebee59053a31b7";
   const argumentsTypes = [
@@ -1002,16 +1258,127 @@ function buildWheelTransaction(options) {
     })(tx)
   });
 }
+var TtlClientCache = class extends client.ClientCache {
+  #ttlMs;
+  constructor({ ttlMs, ...options }) {
+    super({
+      ...options,
+      prefix: options.prefix ?? ["ttl"]
+    });
+    this.#ttlMs = ttlMs;
+  }
+  read(key, load, options) {
+    if (options?.ignoreCache) {
+      super.clear(key);
+    }
+    if (this.#ttlMs <= 0) {
+      return load();
+    }
+    const cached = super.read(
+      key,
+      () => this.#loadEntry(key, load)
+    );
+    if (cached && cached.expiresAt > Date.now()) {
+      return cached.value;
+    }
+    super.clear(key);
+    return super.read(
+      key,
+      () => this.#loadEntry(key, load)
+    ).value;
+  }
+  readSync(key, load, options) {
+    if (options?.ignoreCache) {
+      super.clear(key);
+    }
+    if (this.#ttlMs <= 0) {
+      return load();
+    }
+    const cached = super.readSync(
+      key,
+      () => this.#loadSyncEntry(load)
+    );
+    if (cached.expiresAt > Date.now()) {
+      return cached.value;
+    }
+    super.clear(key);
+    return super.readSync(key, () => this.#loadSyncEntry(load)).value;
+  }
+  #loadEntry(key, load) {
+    const value = load();
+    const entry = {
+      value,
+      expiresAt: Date.now() + this.#ttlMs
+    };
+    if (isPromiseLike(value)) {
+      entry.value = Promise.resolve(value).then((resolved) => {
+        super.clear(key);
+        super.read(key, () => ({
+          value: resolved,
+          expiresAt: Date.now() + this.#ttlMs
+        }));
+        return resolved;
+      }).catch((error) => {
+        super.clear(key);
+        throw error;
+      });
+    }
+    return entry;
+  }
+  #loadSyncEntry(load) {
+    return {
+      value: load(),
+      expiresAt: Date.now() + this.#ttlMs
+    };
+  }
+};
+function isPromiseLike(value) {
+  return (typeof value === "object" || typeof value === "function") && value !== null && "then" in value;
+}
+
+// src/types/game-settings.type.ts
+var GAME_SETTINGS = {
+  coinflip: {
+    settingsKey: CoinFlipSettingsKey,
+    parameters: Parameters2
+  },
+  limbo: {
+    settingsKey: LimboSettingsKey,
+    parameters: Parameters3
+  },
+  plinko: {
+    settingsKey: PlinkoSettingsKey,
+    parameters: Parameters4
+  },
+  "pvp-coinflip": {
+    settingsKey: PvpCoinflipSettingsKey,
+    parameters: Parameters
+  },
+  range: {
+    settingsKey: RangeSettingsKey,
+    parameters: Parameters5
+  },
+  wheel: {
+    settingsKey: WheelSettingsKey,
+    parameters: Parameters6
+  }
+};
 
 // src/client.ts
 function suigar({
   name = "suigar",
-  partner
+  partner,
+  cacheTtl
 } = {}) {
   return {
     name,
     register: (client) => {
-      return new SuigarClient({ client, partner });
+      return new SuigarClient({
+        client,
+        name: String(name),
+        partner,
+        cacheTtl
+      });
     }
   };
 }
@@ -1019,12 +1386,20 @@ var SuigarClient = class {
   #client;
   #config;
   #partner;
+  #cache;
   constructor({
     client,
-    partner
+    name,
+    partner,
+    cacheTtl
   }) {
     this.#client = client;
     this.#partner = partner;
+    this.#cache = client.cache.scope("@suigar/sdk").readSync([name, "ttl-cache"], () => {
+      return new TtlClientCache({
+        ttlMs: cacheTtl ?? DEFAULT_CACHE_TTL_MS
+      });
+    });
     const network = this.#client.network;
     if (!SUPPORTED_SUI_NETWORKS.includes(network)) {
       throw new Error(`Unsupported network: ${network}`);
@@ -1035,8 +1410,8 @@ var SuigarClient = class {
    * Returns the resolved SDK configuration for the connected network.
    *
    * This is primarily useful for debugging or inspecting which package ids,
-   * supported coin types, and price info object ids the SDK resolved for the
-   * current client network.
+   * registry ids, supported coin types, and price info object ids the SDK
+   * resolved for the current client network.
    *
    * @returns Network-resolved Suigar configuration.
    */
@@ -1058,6 +1433,29 @@ var SuigarClient = class {
     const bytes = await transaction.build({ ...options, client: this.#client });
     return utils.toBase64(bytes);
   }
+  /**
+   * Reads on-chain game parameters for the requested game.
+   *
+   * The SDK first reads the selected game's settings object from SweetHouse,
+   * then reads that game's coin-specific `Parameters<T>` object. Results are
+   * cached according to the extension `cacheTtl` option. Pass
+   * `ignoreCache: true` to refresh the onchain read and replace the cached
+   * value.
+   *
+   * @param game Game whose parameters should be loaded.
+   * @param options Optional coin type, cache override, and abort signal.
+   * @returns Parsed game parameters typed for the requested game.
+   */
+  async getGameParameters(game, options = {}) {
+    const coinType = utils.normalizeStructTag(
+      options.coinType ?? this.#config.coinTypes.sui
+    );
+    return this.#cache.read(
+      ["parameters", this.#client.network, game, coinType],
+      () => this.#fetchGameParameters(game, coinType, options.signal),
+      { ignoreCache: options.ignoreCache }
+    );
+  }
   /**
    * Lists unresolved PvP coinflip games from the configured registry and resolves
    * each entry into parsed onchain game state.
@@ -1122,6 +1520,41 @@ var SuigarClient = class {
       (game) => game instanceof Error ? [] : [game]
     );
   }
+  async #fetchGameParameters(game, coinType, signal) {
+    const gameDefinition = GAME_SETTINGS[game];
+    const { object: settingsObject } = await this.#client.core.getDynamicObjectField({
+      parentId: this.#config.packageIds.sweetHouse,
+      name: {
+        type: resolveGameSettingsKeyType(
+          gameDefinition.settingsKey.name,
+          resolveGamePackageId(this.#config, game)
+        ),
+        bcs: gameDefinition.settingsKey.serialize({ dummy_field: false }).toBytes()
+      },
+      signal
+    });
+    const { object } = await this.#client.core.getDynamicObjectField({
+      parentId: settingsObject.objectId,
+      name: {
+        type: TypeName.name,
+        bcs: TypeName.serialize({
+          name: resolveCoinTypeNameForTypeNameKey(coinType)
+        }).toBytes()
+      },
+      include: {
+        content: true
+      },
+      signal
+    });
+    if (!object?.content) {
+      throw new Error(
+        `Missing parameters object content for ${game} and coin type ${coinType}`
+      );
+    }
+    return gameDefinition.parameters.parse(
+      object.content
+    );
+  }
   /**
    * BCS struct constructors for decoding on-chain objects and events related to Suigar games.
    *