@mysten/deepbook-v3 0.0.0-experimental-20240730220552

package/dist/cjs/types/index.d.ts

@@ -0,0 +1,80 @@
+import type { TransactionObjectArgument } from '@mysten/sui/transactions';
+export interface BalanceManager {
+    address: string;
+    tradeCap: string | undefined;
+}
+export interface Coin {
+    address: string;
+    type: string;
+    scalar: number;
+}
+export interface Pool {
+    address: string;
+    baseCoin: string;
+    quoteCoin: string;
+}
+export declare enum OrderType {
+    NO_RESTRICTION = 0,
+    IMMEDIATE_OR_CANCEL = 1,
+    FILL_OR_KILL = 2,
+    POST_ONLY = 3
+}
+export declare enum SelfMatchingOptions {
+    SELF_MATCHING_ALLOWED = 0,
+    CANCEL_TAKER = 1,
+    CANCEL_MAKER = 2
+}
+export interface PlaceLimitOrderParams {
+    poolKey: string;
+    balanceManagerKey: string;
+    clientOrderId: string;
+    price: number;
+    quantity: number;
+    isBid: boolean;
+    expiration?: number | bigint;
+    orderType?: OrderType;
+    selfMatchingOption?: SelfMatchingOptions;
+    payWithDeep?: boolean;
+}
+export interface PlaceMarketOrderParams {
+    poolKey: string;
+    balanceManagerKey: string;
+    clientOrderId: string;
+    quantity: number;
+    isBid: boolean;
+    selfMatchingOption?: SelfMatchingOptions;
+    payWithDeep?: boolean;
+}
+export interface ProposalParams {
+    poolKey: string;
+    balanceManagerKey: string;
+    takerFee: number;
+    makerFee: number;
+    stakeRequired: number;
+}
+export interface SwapParams {
+    poolKey: string;
+    amount: number;
+    deepAmount: number;
+    minOut: number;
+    deepCoin?: TransactionObjectArgument;
+    baseCoin?: TransactionObjectArgument;
+    quoteCoin?: TransactionObjectArgument;
+}
+export interface CreatePoolAdminParams {
+    baseCoinKey: string;
+    quoteCoinKey: string;
+    tickSize: number;
+    lotSize: number;
+    minSize: number;
+    whitelisted: boolean;
+    stablePool: boolean;
+    deepCoin?: TransactionObjectArgument;
+    baseCoin?: TransactionObjectArgument;
+}
+export interface Config {
+    DEEPBOOK_PACKAGE_ID: string;
+    REGISTRY_ID: string;
+    DEEP_TREASURY_ID: string;
+}
+export type Environment = 'mainnet' | 'testnet';

package/dist/cjs/types/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+__export(types_exports, {
+  OrderType: () => OrderType,
+  SelfMatchingOptions: () => SelfMatchingOptions
+});
+module.exports = __toCommonJS(types_exports);
+var OrderType = /* @__PURE__ */ ((OrderType2) => {
+  OrderType2[OrderType2["NO_RESTRICTION"] = 0] = "NO_RESTRICTION";
+  OrderType2[OrderType2["IMMEDIATE_OR_CANCEL"] = 1] = "IMMEDIATE_OR_CANCEL";
+  OrderType2[OrderType2["FILL_OR_KILL"] = 2] = "FILL_OR_KILL";
+  OrderType2[OrderType2["POST_ONLY"] = 3] = "POST_ONLY";
+  return OrderType2;
+})(OrderType || {});
+var SelfMatchingOptions = /* @__PURE__ */ ((SelfMatchingOptions2) => {
+  SelfMatchingOptions2[SelfMatchingOptions2["SELF_MATCHING_ALLOWED"] = 0] = "SELF_MATCHING_ALLOWED";
+  SelfMatchingOptions2[SelfMatchingOptions2["CANCEL_TAKER"] = 1] = "CANCEL_TAKER";
+  SelfMatchingOptions2[SelfMatchingOptions2["CANCEL_MAKER"] = 2] = "CANCEL_MAKER";
+  return SelfMatchingOptions2;
+})(SelfMatchingOptions || {});
+//# sourceMappingURL=index.js.map

package/dist/cjs/types/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/types/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { TransactionObjectArgument } from '@mysten/sui/transactions';\n\n// SPDX-License-Identifier: Apache-2.0\nexport interface BalanceManager {\n\taddress: string;\n\ttradeCap: string | undefined;\n}\n\nexport interface Coin {\n\taddress: string;\n\ttype: string;\n\tscalar: number;\n}\n\nexport interface Pool {\n\taddress: string;\n\tbaseCoin: string;\n\tquoteCoin: string;\n}\n\n// Trading constants\nexport enum OrderType {\n\tNO_RESTRICTION,\n\tIMMEDIATE_OR_CANCEL,\n\tFILL_OR_KILL,\n\tPOST_ONLY,\n}\n\n// Self matching options\nexport enum SelfMatchingOptions {\n\tSELF_MATCHING_ALLOWED,\n\tCANCEL_TAKER,\n\tCANCEL_MAKER,\n}\n\nexport interface PlaceLimitOrderParams {\n\tpoolKey: string;\n\tbalanceManagerKey: string;\n\tclientOrderId: string;\n\tprice: number;\n\tquantity: number;\n\tisBid: boolean;\n\texpiration?: number | bigint;\n\torderType?: OrderType;\n\tselfMatchingOption?: SelfMatchingOptions;\n\tpayWithDeep?: boolean;\n}\n\nexport interface PlaceMarketOrderParams {\n\tpoolKey: string;\n\tbalanceManagerKey: string;\n\tclientOrderId: string;\n\tquantity: number;\n\tisBid: boolean;\n\tselfMatchingOption?: SelfMatchingOptions;\n\tpayWithDeep?: boolean;\n}\n\nexport interface ProposalParams {\n\tpoolKey: string;\n\tbalanceManagerKey: string;\n\ttakerFee: number;\n\tmakerFee: number;\n\tstakeRequired: number;\n}\n\nexport interface SwapParams {\n\tpoolKey: string;\n\tamount: number;\n\tdeepAmount: number;\n\tminOut: number;\n\tdeepCoin?: TransactionObjectArgument;\n\tbaseCoin?: TransactionObjectArgument;\n\tquoteCoin?: TransactionObjectArgument;\n}\n\nexport interface CreatePoolAdminParams {\n\tbaseCoinKey: string;\n\tquoteCoinKey: string;\n\ttickSize: number;\n\tlotSize: number;\n\tminSize: number;\n\twhitelisted: boolean;\n\tstablePool: boolean;\n\tdeepCoin?: TransactionObjectArgument;\n\tbaseCoin?: TransactionObjectArgument;\n}\n\nexport interface Config {\n\tDEEPBOOK_PACKAGE_ID: string;\n\tREGISTRY_ID: string;\n\tDEEP_TREASURY_ID: string;\n}\n\nexport type Environment = 'mainnet' | 'testnet';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwBO,IAAK,YAAL,kBAAKA,eAAL;AACN,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AACA,EAAAA,sBAAA;AAJW,SAAAA;AAAA,GAAA;AAQL,IAAK,sBAAL,kBAAKC,yBAAL;AACN,EAAAA,0CAAA;AACA,EAAAA,0CAAA;AACA,EAAAA,0CAAA;AAHW,SAAAA;AAAA,GAAA;",
+  "names": ["OrderType", "SelfMatchingOptions"]
+}

package/dist/cjs/utils/config.d.ts

@@ -0,0 +1,38 @@
+import { BalanceManagerContract } from '../transactions/balanceManager.js';
+import type { BalanceManager, Environment } from '../types/index.js';
+import type { CoinMap, PoolMap } from './constants.js';
+export declare const FLOAT_SCALAR = 1000000000;
+export declare const POOL_CREATION_FEE: number;
+export declare const MAX_TIMESTAMP = 1844674407370955161n;
+export declare const GAS_BUDGET: number;
+export declare const DEEP_SCALAR = 1000000;
+export declare class DeepBookConfig {
+    #private;
+    balanceManagers: {
+        [key: string]: BalanceManager;
+    };
+    address: string;
+    DEEPBOOK_PACKAGE_ID: string;
+    REGISTRY_ID: string;
+    DEEP_TREASURY_ID: string;
+    adminCap?: string;
+    balanceManager: BalanceManagerContract;
+    constructor({ env, address, adminCap, balanceManagers, coins, pools, }: {
+        env: Environment;
+        address: string;
+        adminCap?: string;
+        balanceManagers?: {
+            [key: string]: BalanceManager;
+        };
+        coins?: CoinMap;
+        pools?: PoolMap;
+    });
+    getCoin(key: string): import("../types/index.js").Coin;
+    getPool(key: string): import("../types/index.js").Pool;
+    /**
+     * @description Get the balance manager by key
+     * @param managerKey Key of the balance manager
+     * @returns The BalanceManager object
+     */
+    getBalanceManager(managerKey: string): BalanceManager;
+}

package/dist/cjs/utils/config.js

@@ -0,0 +1,103 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var config_exports = {};
+__export(config_exports, {
+  DEEP_SCALAR: () => DEEP_SCALAR,
+  DeepBookConfig: () => DeepBookConfig,
+  FLOAT_SCALAR: () => FLOAT_SCALAR,
+  GAS_BUDGET: () => GAS_BUDGET,
+  MAX_TIMESTAMP: () => MAX_TIMESTAMP,
+  POOL_CREATION_FEE: () => POOL_CREATION_FEE
+});
+module.exports = __toCommonJS(config_exports);
+var import_utils = require("@mysten/sui/utils");
+var import_balanceManager = require("../transactions/balanceManager.js");
+var import_constants = require("./constants.js");
+var _coins, _pools;
+const FLOAT_SCALAR = 1e9;
+const POOL_CREATION_FEE = 1e4 * 1e6;
+const MAX_TIMESTAMP = 1844674407370955161n;
+const GAS_BUDGET = 0.5 * 5e8;
+const DEEP_SCALAR = 1e6;
+class DeepBookConfig {
+  constructor({
+    env,
+    address,
+    adminCap,
+    balanceManagers,
+    coins,
+    pools
+  }) {
+    __privateAdd(this, _coins);
+    __privateAdd(this, _pools);
+    this.address = (0, import_utils.normalizeSuiAddress)(address);
+    this.adminCap = adminCap;
+    this.balanceManagers = balanceManagers || {};
+    if (env === "mainnet") {
+      __privateSet(this, _coins, coins || import_constants.mainnetCoins);
+      __privateSet(this, _pools, pools || import_constants.mainnetPools);
+      this.DEEPBOOK_PACKAGE_ID = import_constants.mainnetPackageIds.DEEPBOOK_PACKAGE_ID;
+      this.REGISTRY_ID = import_constants.mainnetPackageIds.REGISTRY_ID;
+      this.DEEP_TREASURY_ID = import_constants.mainnetPackageIds.DEEP_TREASURY_ID;
+    } else {
+      __privateSet(this, _coins, coins || import_constants.testnetCoins);
+      __privateSet(this, _pools, pools || import_constants.testnetPools);
+      this.DEEPBOOK_PACKAGE_ID = import_constants.testnetPackageIds.DEEPBOOK_PACKAGE_ID;
+      this.REGISTRY_ID = import_constants.testnetPackageIds.REGISTRY_ID;
+      this.DEEP_TREASURY_ID = import_constants.testnetPackageIds.DEEP_TREASURY_ID;
+    }
+    this.balanceManager = new import_balanceManager.BalanceManagerContract(this);
+  }
+  // Getters
+  getCoin(key) {
+    const coin = __privateGet(this, _coins)[key];
+    if (!coin) {
+      throw new Error(`Coin not found for key: ${key}`);
+    }
+    return coin;
+  }
+  getPool(key) {
+    const pool = __privateGet(this, _pools)[key];
+    if (!pool) {
+      throw new Error(`Pool not found for key: ${key}`);
+    }
+    return pool;
+  }
+  /**
+   * @description Get the balance manager by key
+   * @param managerKey Key of the balance manager
+   * @returns The BalanceManager object
+   */
+  getBalanceManager(managerKey) {
+    if (!Object.hasOwn(this.balanceManagers, managerKey)) {
+      throw new Error(`Balance manager with key ${managerKey} not found.`);
+    }
+    return this.balanceManagers[managerKey];
+  }
+}
+_coins = new WeakMap();
+_pools = new WeakMap();
+//# sourceMappingURL=config.js.map

package/dist/cjs/utils/config.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/utils/config.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\nimport { normalizeSuiAddress } from '@mysten/sui/utils';\n\nimport { BalanceManagerContract } from '../transactions/balanceManager.js';\nimport type { BalanceManager, Environment } from '../types/index.js';\nimport type { CoinMap, PoolMap } from './constants.js';\nimport {\n\tmainnetCoins,\n\tmainnetPackageIds,\n\tmainnetPools,\n\ttestnetCoins,\n\ttestnetPackageIds,\n\ttestnetPools,\n} from './constants.js';\n\nexport const FLOAT_SCALAR = 1000000000;\nexport const POOL_CREATION_FEE = 10000 * 1000000;\nexport const MAX_TIMESTAMP = 1844674407370955161n;\nexport const GAS_BUDGET = 0.5 * 500000000; // Adjust based on benchmarking\nexport const DEEP_SCALAR = 1000000;\n\nexport class DeepBookConfig {\n\t#coins: CoinMap;\n\t#pools: PoolMap;\n\tbalanceManagers: { [key: string]: BalanceManager };\n\taddress: string;\n\n\tDEEPBOOK_PACKAGE_ID: string;\n\tREGISTRY_ID: string;\n\tDEEP_TREASURY_ID: string;\n\tadminCap?: string;\n\n\tbalanceManager: BalanceManagerContract;\n\n\tconstructor({\n\t\tenv,\n\t\taddress,\n\t\tadminCap,\n\t\tbalanceManagers,\n\t\tcoins,\n\t\tpools,\n\t}: {\n\t\tenv: Environment;\n\t\taddress: string;\n\t\tadminCap?: string;\n\t\tbalanceManagers?: { [key: string]: BalanceManager };\n\t\tcoins?: CoinMap;\n\t\tpools?: PoolMap;\n\t}) {\n\t\tthis.address = normalizeSuiAddress(address);\n\t\tthis.adminCap = adminCap;\n\t\tthis.balanceManagers = balanceManagers || {};\n\n\t\tif (env === 'mainnet') {\n\t\t\tthis.#coins = coins || mainnetCoins;\n\t\t\tthis.#pools = pools || mainnetPools;\n\t\t\tthis.DEEPBOOK_PACKAGE_ID = mainnetPackageIds.DEEPBOOK_PACKAGE_ID;\n\t\t\tthis.REGISTRY_ID = mainnetPackageIds.REGISTRY_ID;\n\t\t\tthis.DEEP_TREASURY_ID = mainnetPackageIds.DEEP_TREASURY_ID;\n\t\t} else {\n\t\t\tthis.#coins = coins || testnetCoins;\n\t\t\tthis.#pools = pools || testnetPools;\n\t\t\tthis.DEEPBOOK_PACKAGE_ID = testnetPackageIds.DEEPBOOK_PACKAGE_ID;\n\t\t\tthis.REGISTRY_ID = testnetPackageIds.REGISTRY_ID;\n\t\t\tthis.DEEP_TREASURY_ID = testnetPackageIds.DEEP_TREASURY_ID;\n\t\t}\n\n\t\tthis.balanceManager = new BalanceManagerContract(this);\n\t}\n\n\t// Getters\n\tgetCoin(key: string) {\n\t\tconst coin = this.#coins[key];\n\t\tif (!coin) {\n\t\t\tthrow new Error(`Coin not found for key: ${key}`);\n\t\t}\n\n\t\treturn coin;\n\t}\n\n\tgetPool(key: string) {\n\t\tconst pool = this.#pools[key];\n\t\tif (!pool) {\n\t\t\tthrow new Error(`Pool not found for key: ${key}`);\n\t\t}\n\n\t\treturn pool;\n\t}\n\n\t/**\n\t * @description Get the balance manager by key\n\t * @param managerKey Key of the balance manager\n\t * @returns The BalanceManager object\n\t */\n\tgetBalanceManager(managerKey: string): BalanceManager {\n\t\tif (!Object.hasOwn(this.balanceManagers, managerKey)) {\n\t\t\tthrow new Error(`Balance manager with key ${managerKey} not found.`);\n\t\t}\n\n\t\treturn this.balanceManagers[managerKey];\n\t}\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,mBAAoC;AAEpC,4BAAuC;AAGvC,uBAOO;AAdP;AAgBO,MAAM,eAAe;AACrB,MAAM,oBAAoB,MAAQ;AAClC,MAAM,gBAAgB;AACtB,MAAM,aAAa,MAAM;AACzB,MAAM,cAAc;AAEpB,MAAM,eAAe;AAAA,EAa3B,YAAY;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,GAOG;AA1BH;AACA;AA0BC,SAAK,cAAU,kCAAoB,OAAO;AAC1C,SAAK,WAAW;AAChB,SAAK,kBAAkB,mBAAmB,CAAC;AAE3C,QAAI,QAAQ,WAAW;AACtB,yBAAK,QAAS,SAAS;AACvB,yBAAK,QAAS,SAAS;AACvB,WAAK,sBAAsB,mCAAkB;AAC7C,WAAK,cAAc,mCAAkB;AACrC,WAAK,mBAAmB,mCAAkB;AAAA,IAC3C,OAAO;AACN,yBAAK,QAAS,SAAS;AACvB,yBAAK,QAAS,SAAS;AACvB,WAAK,sBAAsB,mCAAkB;AAC7C,WAAK,cAAc,mCAAkB;AACrC,WAAK,mBAAmB,mCAAkB;AAAA,IAC3C;AAEA,SAAK,iBAAiB,IAAI,6CAAuB,IAAI;AAAA,EACtD;AAAA;AAAA,EAGA,QAAQ,KAAa;AACpB,UAAM,OAAO,mBAAK,QAAO,GAAG;AAC5B,QAAI,CAAC,MAAM;AACV,YAAM,IAAI,MAAM,2BAA2B,GAAG,EAAE;AAAA,IACjD;AAEA,WAAO;AAAA,EACR;AAAA,EAEA,QAAQ,KAAa;AACpB,UAAM,OAAO,mBAAK,QAAO,GAAG;AAC5B,QAAI,CAAC,MAAM;AACV,YAAM,IAAI,MAAM,2BAA2B,GAAG,EAAE;AAAA,IACjD;AAEA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,kBAAkB,YAAoC;AACrD,QAAI,CAAC,OAAO,OAAO,KAAK,iBAAiB,UAAU,GAAG;AACrD,YAAM,IAAI,MAAM,4BAA4B,UAAU,aAAa;AAAA,IACpE;AAEA,WAAO,KAAK,gBAAgB,UAAU;AAAA,EACvC;AACD;AA/EC;AACA;",
+  "names": []
+}

package/dist/cjs/utils/constants.d.ts

@@ -0,0 +1,22 @@
+import type { Coin, Pool } from '../types/index.js';
+export type CoinMap = Record<string, Coin>;
+export type PoolMap = Record<string, Pool>;
+export interface DeepbookPackageIds {
+    DEEPBOOK_PACKAGE_ID: string;
+    REGISTRY_ID: string;
+    DEEP_TREASURY_ID: string;
+}
+export declare const testnetPackageIds: {
+    DEEPBOOK_PACKAGE_ID: string;
+    REGISTRY_ID: string;
+    DEEP_TREASURY_ID: string;
+};
+export declare const mainnetPackageIds: {
+    DEEPBOOK_PACKAGE_ID: string;
+    REGISTRY_ID: string;
+    DEEP_TREASURY_ID: string;
+};
+export declare const testnetCoins: CoinMap;
+export declare const mainnetCoins: CoinMap;
+export declare const testnetPools: PoolMap;
+export declare const mainnetPools: PoolMap;

package/dist/cjs/utils/constants.js

@@ -0,0 +1,117 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var constants_exports = {};
+__export(constants_exports, {
+  mainnetCoins: () => mainnetCoins,
+  mainnetPackageIds: () => mainnetPackageIds,
+  mainnetPools: () => mainnetPools,
+  testnetCoins: () => testnetCoins,
+  testnetPackageIds: () => testnetPackageIds,
+  testnetPools: () => testnetPools
+});
+module.exports = __toCommonJS(constants_exports);
+const testnetPackageIds = {
+  DEEPBOOK_PACKAGE_ID: "0xbf8c499152c205dc5af0a89e95911e2c7d6d1c8b6a4d3a96058aee5fef3ae03a",
+  REGISTRY_ID: "0x1e9619bb7e1ffb94f2ba9d1bd55d922921931e138dd0b7a1a3c5ede8d1cf9424",
+  DEEP_TREASURY_ID: "0x69fffdae0075f8f71f4fa793549c11079266910e8905169845af1f5d00e09dcb"
+};
+const mainnetPackageIds = {
+  DEEPBOOK_PACKAGE_ID: "",
+  REGISTRY_ID: "",
+  DEEP_TREASURY_ID: ""
+};
+const testnetCoins = {
+  DEEP: {
+    address: `0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8`,
+    type: `0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP`,
+    scalar: 1e6
+  },
+  SUI: {
+    address: `0x0000000000000000000000000000000000000000000000000000000000000002`,
+    type: `0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI`,
+    scalar: 1e9
+  },
+  DBUSDC: {
+    address: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7`,
+    type: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC`,
+    scalar: 1e6
+  },
+  DBUSDT: {
+    address: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7`,
+    type: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT`,
+    scalar: 1e6
+  }
+};
+const mainnetCoins = {
+  DEEP: {
+    address: `0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270`,
+    type: `0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP`,
+    scalar: 1e6
+  },
+  SUI: {
+    address: `0x0000000000000000000000000000000000000000000000000000000000000002`,
+    type: `0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI`,
+    scalar: 1e9
+  },
+  USDC: {
+    address: `0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf`,
+    type: `0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN`,
+    scalar: 1e6
+  },
+  WETH: {
+    address: `0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5`,
+    type: `0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5::coin::COIN`,
+    scalar: 1e8
+  },
+  USDT: {
+    address: `0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c`,
+    type: `0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c::coin::COIN`,
+    scalar: 1e6
+  }
+};
+const testnetPools = {
+  DEEP_SUI: {
+    address: `0xfd25055cdcfff6ef7031c941d4fd407880fa19dd24d0f526c3b38c633fefe49e`,
+    baseCoin: "DEEP",
+    quoteCoin: "SUI"
+  },
+  SUI_DBUSDC: {
+    address: `0x9b7d3cf0c35cdebb9909705548249c4240004f7300e1b0dfc90ac232c8f431d1`,
+    baseCoin: "SUI",
+    quoteCoin: "DBUSDC"
+  },
+  DEEP_DBUSDC: {
+    address: `0xa136f878686acd23ea6881f31b937ffd378bbdb4eaebf54bd793c5f9e2ab53f0`,
+    baseCoin: "DEEP",
+    quoteCoin: "DBUSDC"
+  },
+  DBUSDT_DBUSDC: {
+    address: `0x19a667bb5c80ee40155b8bf9aada0d787d7a86cb44f51b4b8a88df7d5a4cd0d0`,
+    baseCoin: "DBUSDT",
+    quoteCoin: "DBUSDC"
+  }
+};
+const mainnetPools = {
+  DEEP_SUI: {
+    address: ``,
+    baseCoin: "DEEP",
+    quoteCoin: "SUI"
+  }
+};
+//# sourceMappingURL=constants.js.map

package/dist/cjs/utils/constants.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/utils/constants.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Coin, Pool } from '../types/index.js';\n\nexport type CoinMap = Record<string, Coin>;\nexport type PoolMap = Record<string, Pool>;\nexport interface DeepbookPackageIds {\n\tDEEPBOOK_PACKAGE_ID: string;\n\tREGISTRY_ID: string;\n\tDEEP_TREASURY_ID: string;\n}\n\nexport const testnetPackageIds = {\n\tDEEPBOOK_PACKAGE_ID: '0xbf8c499152c205dc5af0a89e95911e2c7d6d1c8b6a4d3a96058aee5fef3ae03a',\n\tREGISTRY_ID: '0x1e9619bb7e1ffb94f2ba9d1bd55d922921931e138dd0b7a1a3c5ede8d1cf9424',\n\tDEEP_TREASURY_ID: '0x69fffdae0075f8f71f4fa793549c11079266910e8905169845af1f5d00e09dcb',\n} satisfies DeepbookPackageIds;\n\nexport const mainnetPackageIds = {\n\tDEEPBOOK_PACKAGE_ID: '',\n\tREGISTRY_ID: '',\n\tDEEP_TREASURY_ID: '',\n};\n\nexport const testnetCoins: CoinMap = {\n\tDEEP: {\n\t\taddress: `0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8`,\n\t\ttype: `0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP`,\n\t\tscalar: 1000000,\n\t},\n\tSUI: {\n\t\taddress: `0x0000000000000000000000000000000000000000000000000000000000000002`,\n\t\ttype: `0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI`,\n\t\tscalar: 1000000000,\n\t},\n\tDBUSDC: {\n\t\taddress: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7`,\n\t\ttype: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC`,\n\t\tscalar: 1000000,\n\t},\n\tDBUSDT: {\n\t\taddress: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7`,\n\t\ttype: `0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT`,\n\t\tscalar: 1000000,\n\t},\n};\n\nexport const mainnetCoins: CoinMap = {\n\tDEEP: {\n\t\taddress: `0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270`,\n\t\ttype: `0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP`,\n\t\tscalar: 1000000,\n\t},\n\tSUI: {\n\t\taddress: `0x0000000000000000000000000000000000000000000000000000000000000002`,\n\t\ttype: `0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI`,\n\t\tscalar: 1000000000,\n\t},\n\tUSDC: {\n\t\taddress: `0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf`,\n\t\ttype: `0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN`,\n\t\tscalar: 1000000,\n\t},\n\tWETH: {\n\t\taddress: `0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5`,\n\t\ttype: `0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5::coin::COIN`,\n\t\tscalar: 100000000,\n\t},\n\tUSDT: {\n\t\taddress: `0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c`,\n\t\ttype: `0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c::coin::COIN`,\n\t\tscalar: 1000000,\n\t},\n};\n\nexport const testnetPools: PoolMap = {\n\tDEEP_SUI: {\n\t\taddress: `0xfd25055cdcfff6ef7031c941d4fd407880fa19dd24d0f526c3b38c633fefe49e`,\n\t\tbaseCoin: 'DEEP',\n\t\tquoteCoin: 'SUI',\n\t},\n\tSUI_DBUSDC: {\n\t\taddress: `0x9b7d3cf0c35cdebb9909705548249c4240004f7300e1b0dfc90ac232c8f431d1`,\n\t\tbaseCoin: 'SUI',\n\t\tquoteCoin: 'DBUSDC',\n\t},\n\tDEEP_DBUSDC: {\n\t\taddress: `0xa136f878686acd23ea6881f31b937ffd378bbdb4eaebf54bd793c5f9e2ab53f0`,\n\t\tbaseCoin: 'DEEP',\n\t\tquoteCoin: 'DBUSDC',\n\t},\n\tDBUSDT_DBUSDC: {\n\t\taddress: `0x19a667bb5c80ee40155b8bf9aada0d787d7a86cb44f51b4b8a88df7d5a4cd0d0`,\n\t\tbaseCoin: 'DBUSDT',\n\t\tquoteCoin: 'DBUSDC',\n\t},\n};\n\nexport const mainnetPools: PoolMap = {\n\tDEEP_SUI: {\n\t\taddress: ``,\n\t\tbaseCoin: 'DEEP',\n\t\tquoteCoin: 'SUI',\n\t},\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAaO,MAAM,oBAAoB;AAAA,EAChC,qBAAqB;AAAA,EACrB,aAAa;AAAA,EACb,kBAAkB;AACnB;AAEO,MAAM,oBAAoB;AAAA,EAChC,qBAAqB;AAAA,EACrB,aAAa;AAAA,EACb,kBAAkB;AACnB;AAEO,MAAM,eAAwB;AAAA,EACpC,MAAM;AAAA,IACL,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,KAAK;AAAA,IACJ,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,QAAQ;AAAA,IACP,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,QAAQ;AAAA,IACP,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AACD;AAEO,MAAM,eAAwB;AAAA,EACpC,MAAM;AAAA,IACL,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,KAAK;AAAA,IACJ,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,MAAM;AAAA,IACL,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,MAAM;AAAA,IACL,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AAAA,EACA,MAAM;AAAA,IACL,SAAS;AAAA,IACT,MAAM;AAAA,IACN,QAAQ;AAAA,EACT;AACD;AAEO,MAAM,eAAwB;AAAA,EACpC,UAAU;AAAA,IACT,SAAS;AAAA,IACT,UAAU;AAAA,IACV,WAAW;AAAA,EACZ;AAAA,EACA,YAAY;AAAA,IACX,SAAS;AAAA,IACT,UAAU;AAAA,IACV,WAAW;AAAA,EACZ;AAAA,EACA,aAAa;AAAA,IACZ,SAAS;AAAA,IACT,UAAU;AAAA,IACV,WAAW;AAAA,EACZ;AAAA,EACA,eAAe;AAAA,IACd,SAAS;AAAA,IACT,UAAU;AAAA,IACV,WAAW;AAAA,EACZ;AACD;AAEO,MAAM,eAAwB;AAAA,EACpC,UAAU;AAAA,IACT,SAAS;AAAA,IACT,UAAU;AAAA,IACV,WAAW;AAAA,EACZ;AACD;",
+  "names": []
+}

package/dist/esm/client.d.ts

@@ -0,0 +1,177 @@
+import type { SuiClient } from '@mysten/sui/client';
+import { BalanceManagerContract } from './transactions/balanceManager.js';
+import { DeepBookContract } from './transactions/deepbook.js';
+import { DeepBookAdminContract } from './transactions/deepbookAdmin.js';
+import { FlashLoanContract } from './transactions/flashLoans.js';
+import { GovernanceContract } from './transactions/governance.js';
+import type { BalanceManager, Environment } from './types/index.js';
+import type { CoinMap, PoolMap } from './utils/constants.js';
+/**
+ * DeepBookClient class for managing DeepBook operations.
+ */
+export declare class DeepBookClient {
+    #private;
+    client: SuiClient;
+    balanceManager: BalanceManagerContract;
+    deepBook: DeepBookContract;
+    deepBookAdmin: DeepBookAdminContract;
+    flashLoans: FlashLoanContract;
+    governance: GovernanceContract;
+    /**
+     * @param {SuiClient} client SuiClient instance
+     * @param {string} address Address of the client
+     * @param {Environment} env Environment configuration
+     * @param {Object.<string, BalanceManager>} [balanceManagers] Optional initial BalanceManager map
+     * @param {CoinMap} [coins] Optional initial CoinMap
+     * @param {PoolMap} [pools] Optional initial PoolMap
+     * @param {string} [adminCap] Optional admin capability
+     */
+    constructor({ client, address, env, balanceManagers, coins, pools, adminCap, }: {
+        client: SuiClient;
+        address: string;
+        env: Environment;
+        balanceManagers?: {
+            [key: string]: BalanceManager;
+        };
+        coins?: CoinMap;
+        pools?: PoolMap;
+        adminCap?: string;
+    });
+    /**
+     * @description Check the balance of a balance manager for a specific coin
+     * @param {string} managerKey Key of the balance manager
+     * @param {string} coinKey Key of the coin
+     * @returns {Promise<{ coinType: string, balance: number }>} An object with coin type and balance
+     */
+    checkManagerBalance(managerKey: string, coinKey: string): Promise<{
+        coinType: string;
+        balance: number;
+    }>;
+    /**
+     * @description Check if a pool is whitelisted
+     * @param {string} poolKey Key of the pool
+     * @returns {Promise<boolean>} Boolean indicating if the pool is whitelisted
+     */
+    whitelisted(poolKey: string): Promise<boolean>;
+    /**
+     * @description Get the quote quantity out for a given base quantity
+     * @param {string} poolKey Key of the pool
+     * @param {number} baseQuantity Base quantity to convert
+     * @returns {Promise<{ baseQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+     * An object with base quantity, base out, quote out, and deep required for the dry run
+     */
+    getQuoteQuantityOut(poolKey: string, baseQuantity: number): Promise<{
+        baseQuantity: number;
+        baseOut: number;
+        quoteOut: number;
+        deepRequired: number;
+    }>;
+    /**
+     * @description Get the base quantity out for a given quote quantity
+     * @param {string} poolKey Key of the pool
+     * @param {number} quoteQuantity Quote quantity to convert
+     * @returns {Promise<{ quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+     * An object with quote quantity, base out, quote out, and deep required for the dry run
+     */
+    getBaseQuantityOut(poolKey: string, quoteQuantity: number): Promise<{
+        quoteQuantity: number;
+        baseOut: number;
+        quoteOut: number;
+        deepRequired: number;
+    }>;
+    /**
+     * @description Get the output quantities for given base and quote quantities. Only one quantity can be non-zero
+     * @param {string} poolKey Key of the pool
+     * @param {number} baseQuantity Base quantity to convert
+     * @param {number} quoteQuantity Quote quantity to convert
+     * @returns {Promise<{ baseQuantity: number, quoteQuantity: number, baseOut: number, quoteOut: number, deepRequired: number }>}
+     * An object with base quantity, quote quantity, base out, quote out, and deep required for the dry run
+     */
+    getQuantityOut(poolKey: string, baseQuantity: number, quoteQuantity: number): Promise<{
+        baseQuantity: number;
+        quoteQuantity: number;
+        baseOut: number;
+        quoteOut: number;
+        deepRequired: number;
+    }>;
+    /**
+     * @description Get open orders for a balance manager in a pool
+     * @param {string} poolKey Key of the pool
+     * @param {string} managerKey Key of the balance manager
+     * @returns {Promise<Array>} An array of open order IDs
+     */
+    accountOpenOrders(poolKey: string, managerKey: string): Promise<string[]>;
+    /**
+     * @description Get the order information for a specific order in a pool
+     * @param {string} poolKey Key of the pool
+     * @param {string} orderId Order ID
+     * @returns {Promise<Object>} A promise that resolves to an object containing the order information
+     */
+    getOrder(poolKey: string, orderId: string): Promise<{
+        balance_manager_id: {
+            bytes: string;
+        };
+        order_id: string;
+        client_order_id: string;
+        quantity: string;
+        filled_quantity: string;
+        fee_is_deep: boolean;
+        order_deep_price: {
+            asset_is_base: boolean;
+            deep_per_asset: string;
+        };
+        epoch: string;
+        status: number;
+        expire_timestamp: string;
+    }>;
+    /**
+     * @description Get level 2 order book specifying range of price
+     * @param {string} poolKey Key of the pool
+     * @param {number} priceLow Lower bound of the price range
+     * @param {number} priceHigh Upper bound of the price range
+     * @param {boolean} isBid Whether to get bid or ask orders
+     * @returns {Promise<{ prices: Array<number>, quantities: Array<number> }>}
+     * An object with arrays of prices and quantities
+     */
+    getLevel2Range(poolKey: string, priceLow: number, priceHigh: number, isBid: boolean): Promise<{
+        prices: number[];
+        quantities: number[];
+    }>;
+    /**
+     * @description Get level 2 order book ticks from mid-price for a pool
+     * @param {string} poolKey Key of the pool
+     * @param {number} ticks Number of ticks from mid-price
+     * @returns {Promise<{ bid_prices: Array<number>, bid_quantities: Array<number>, ask_prices: Array<number>, ask_quantities: Array<number> }>}
+     * An object with arrays of prices and quantities
+     */
+    getLevel2TicksFromMid(poolKey: string, ticks: number): Promise<{
+        bid_prices: number[];
+        bid_quantities: number[];
+        ask_prices: number[];
+        ask_quantities: number[];
+    }>;
+    /**
+     * @description Get the vault balances for a pool
+     * @param {string} poolKey Key of the pool
+     * @returns {Promise<{ base: number, quote: number, deep: number }>}
+     * An object with base, quote, and deep balances in the vault
+     */
+    vaultBalances(poolKey: string): Promise<{
+        base: number;
+        quote: number;
+        deep: number;
+    }>;
+    /**
+     * @description Get the pool ID by asset types
+     * @param {string} baseType Type of the base asset
+     * @param {string} quoteType Type of the quote asset
+     * @returns {Promise<string>} The address of the pool
+     */
+    getPoolIdByAssets(baseType: string, quoteType: string): Promise<string>;
+    /**
+     * @description Get the mid price for a pool
+     * @param {string} poolKey Key of the pool
+     * @returns {Promise<number>} The mid price
+     */
+    midPrice(poolKey: string): Promise<number>;
+}