@mysten/deepbook-v3 0.0.0-experimental-20240730220552

package/dist/cjs/transactions/balanceManager.js

@@ -0,0 +1,185 @@
+"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 balanceManager_exports = {};
+__export(balanceManager_exports, {
+  BalanceManagerContract: () => BalanceManagerContract
+});
+module.exports = __toCommonJS(balanceManager_exports);
+var import_transactions = require("@mysten/sui/transactions");
+var _config;
+class BalanceManagerContract {
+  /**
+   * @param {DeepBookConfig} config Configuration for BalanceManagerContract
+   */
+  constructor(config) {
+    __privateAdd(this, _config);
+    /**
+     * @description Create and share a new BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    this.createAndShareBalanceManager = () => (tx) => {
+      const manager = tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::new`
+      });
+      tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::share`,
+        arguments: [manager]
+      });
+    };
+    /**
+     * @description Deposit funds into the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @param {string} coinKey The key of the coin to deposit
+     * @param {number} amountToDeposit The amount to deposit
+     * @returns A function that takes a Transaction object
+     */
+    this.depositIntoManager = (managerKey, coinKey, amountToDeposit) => (tx) => {
+      tx.setSenderIfNotSet(__privateGet(this, _config).address);
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      const coin = __privateGet(this, _config).getCoin(coinKey);
+      const deposit = (0, import_transactions.coinWithBalance)({
+        type: coin.type,
+        balance: amountToDeposit * coin.scalar
+      });
+      tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::deposit`,
+        arguments: [tx.object(managerId), deposit],
+        typeArguments: [coin.type]
+      });
+    };
+    /**
+     * @description Withdraw funds from the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @param {string} coinKey The key of the coin to withdraw
+     * @param {number} amountToWithdraw The amount to withdraw
+     * @param {string} recipient The recipient of the withdrawn funds
+     * @returns A function that takes a Transaction object
+     */
+    this.withdrawFromManager = (managerKey, coinKey, amountToWithdraw, recipient) => (tx) => {
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      const coin = __privateGet(this, _config).getCoin(coinKey);
+      const coinObject = tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::withdraw`,
+        arguments: [tx.object(managerId), tx.pure.u64(amountToWithdraw * coin.scalar)],
+        typeArguments: [coin.type]
+      });
+      tx.transferObjects([coinObject], recipient);
+    };
+    /**
+     * @description Withdraw all funds from the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @param {string} coinKey The key of the coin to withdraw
+     * @param {string} recipient The recipient of the withdrawn funds
+     * @returns A function that takes a Transaction object
+     */
+    this.withdrawAllFromManager = (managerKey, coinKey, recipient) => (tx) => {
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      const coin = __privateGet(this, _config).getCoin(coinKey);
+      const withdrawalCoin = tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::withdraw_all`,
+        arguments: [tx.object(managerId)],
+        typeArguments: [coin.type]
+      });
+      tx.transferObjects([withdrawalCoin], recipient);
+    };
+    /**
+     * @description Check the balance of the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @param {string} coinKey The key of the coin to check the balance of
+     * @returns A function that takes a Transaction object
+     */
+    this.checkManagerBalance = (managerKey, coinKey) => (tx) => {
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      const coin = __privateGet(this, _config).getCoin(coinKey);
+      tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::balance`,
+        arguments: [tx.object(managerId)],
+        typeArguments: [coin.type]
+      });
+    };
+    /**
+     * @description Generate a trade proof for the BalanceManager. Calls the appropriate function based on whether tradeCap is set.
+     * @param {string} managerKey The key of the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    this.generateProof = (managerKey) => (tx) => {
+      const balanceManager = __privateGet(this, _config).getBalanceManager(managerKey);
+      return tx.add(
+        balanceManager.tradeCap ? this.generateProofAsTrader(balanceManager.address, balanceManager.tradeCap) : this.generateProofAsOwner(balanceManager.address)
+      );
+    };
+    /**
+     * @description Generate a trade proof as the owner
+     * @param {string} managerId The ID of the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    this.generateProofAsOwner = (managerId) => (tx) => {
+      return tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::generate_proof_as_owner`,
+        arguments: [tx.object(managerId)]
+      });
+    };
+    /**
+     * @description Generate a trade proof as a trader
+     * @param {string} managerId The ID of the BalanceManager
+     * @param {string} tradeCapId The ID of the tradeCap
+     * @returns A function that takes a Transaction object
+     */
+    this.generateProofAsTrader = (managerId, tradeCapId) => (tx) => {
+      return tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::generate_proof_as_trader`,
+        arguments: [tx.object(managerId), tx.object(tradeCapId)]
+      });
+    };
+    /**
+     * @description Get the owner of the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    this.owner = (managerKey) => (tx) => {
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::owner`,
+        arguments: [tx.object(managerId)]
+      });
+    };
+    /**
+     * @description Get the ID of the BalanceManager
+     * @param {string} managerKey The key of the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    this.id = (managerKey) => (tx) => {
+      const managerId = __privateGet(this, _config).getBalanceManager(managerKey).address;
+      tx.moveCall({
+        target: `${__privateGet(this, _config).DEEPBOOK_PACKAGE_ID}::balance_manager::id`,
+        arguments: [tx.object(managerId)]
+      });
+    };
+    __privateSet(this, _config, config);
+  }
+}
+_config = new WeakMap();
+//# sourceMappingURL=balanceManager.js.map

package/dist/cjs/transactions/balanceManager.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/transactions/balanceManager.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\nimport { coinWithBalance } from '@mysten/sui/transactions';\nimport type { Transaction } from '@mysten/sui/transactions';\n\nimport type { DeepBookConfig } from '../utils/config.js';\n\n/**\n * BalanceManagerContract class for managing BalanceManager operations.\n */\nexport class BalanceManagerContract {\n\t#config: DeepBookConfig;\n\n\t/**\n\t * @param {DeepBookConfig} config Configuration for BalanceManagerContract\n\t */\n\tconstructor(config: DeepBookConfig) {\n\t\tthis.#config = config;\n\t}\n\n\t/**\n\t * @description Create and share a new BalanceManager\n\t * @returns A function that takes a Transaction object\n\t */\n\tcreateAndShareBalanceManager = () => (tx: Transaction) => {\n\t\tconst manager = tx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::new`,\n\t\t});\n\n\t\ttx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::share`,\n\t\t\targuments: [manager],\n\t\t});\n\t};\n\n\t/**\n\t * @description Deposit funds into the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @param {string} coinKey The key of the coin to deposit\n\t * @param {number} amountToDeposit The amount to deposit\n\t * @returns A function that takes a Transaction object\n\t */\n\tdepositIntoManager =\n\t\t(managerKey: string, coinKey: string, amountToDeposit: number) => (tx: Transaction) => {\n\t\t\ttx.setSenderIfNotSet(this.#config.address);\n\t\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\t\tconst coin = this.#config.getCoin(coinKey);\n\t\t\tconst deposit = coinWithBalance({\n\t\t\t\ttype: coin.type,\n\t\t\t\tbalance: amountToDeposit * coin.scalar,\n\t\t\t});\n\n\t\t\ttx.moveCall({\n\t\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::deposit`,\n\t\t\t\targuments: [tx.object(managerId), deposit],\n\t\t\t\ttypeArguments: [coin.type],\n\t\t\t});\n\t\t};\n\n\t/**\n\t * @description Withdraw funds from the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @param {string} coinKey The key of the coin to withdraw\n\t * @param {number} amountToWithdraw The amount to withdraw\n\t * @param {string} recipient The recipient of the withdrawn funds\n\t * @returns A function that takes a Transaction object\n\t */\n\twithdrawFromManager =\n\t\t(managerKey: string, coinKey: string, amountToWithdraw: number, recipient: string) =>\n\t\t(tx: Transaction) => {\n\t\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\t\tconst coin = this.#config.getCoin(coinKey);\n\t\t\tconst coinObject = tx.moveCall({\n\t\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::withdraw`,\n\t\t\t\targuments: [tx.object(managerId), tx.pure.u64(amountToWithdraw * coin.scalar)],\n\t\t\t\ttypeArguments: [coin.type],\n\t\t\t});\n\n\t\t\ttx.transferObjects([coinObject], recipient);\n\t\t};\n\n\t/**\n\t * @description Withdraw all funds from the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @param {string} coinKey The key of the coin to withdraw\n\t * @param {string} recipient The recipient of the withdrawn funds\n\t * @returns A function that takes a Transaction object\n\t */\n\twithdrawAllFromManager =\n\t\t(managerKey: string, coinKey: string, recipient: string) => (tx: Transaction) => {\n\t\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\t\tconst coin = this.#config.getCoin(coinKey);\n\t\t\tconst withdrawalCoin = tx.moveCall({\n\t\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::withdraw_all`,\n\t\t\t\targuments: [tx.object(managerId)],\n\t\t\t\ttypeArguments: [coin.type],\n\t\t\t});\n\n\t\t\ttx.transferObjects([withdrawalCoin], recipient);\n\t\t};\n\n\t/**\n\t * @description Check the balance of the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @param {string} coinKey The key of the coin to check the balance of\n\t * @returns A function that takes a Transaction object\n\t */\n\tcheckManagerBalance = (managerKey: string, coinKey: string) => (tx: Transaction) => {\n\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\tconst coin = this.#config.getCoin(coinKey);\n\t\ttx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::balance`,\n\t\t\targuments: [tx.object(managerId)],\n\t\t\ttypeArguments: [coin.type],\n\t\t});\n\t};\n\n\t/**\n\t * @description Generate a trade proof for the BalanceManager. Calls the appropriate function based on whether tradeCap is set.\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @returns A function that takes a Transaction object\n\t */\n\tgenerateProof = (managerKey: string) => (tx: Transaction) => {\n\t\tconst balanceManager = this.#config.getBalanceManager(managerKey);\n\t\treturn tx.add(\n\t\t\tbalanceManager.tradeCap\n\t\t\t\t? this.generateProofAsTrader(balanceManager.address, balanceManager.tradeCap)\n\t\t\t\t: this.generateProofAsOwner(balanceManager.address),\n\t\t);\n\t};\n\n\t/**\n\t * @description Generate a trade proof as the owner\n\t * @param {string} managerId The ID of the BalanceManager\n\t * @returns A function that takes a Transaction object\n\t */\n\tgenerateProofAsOwner = (managerId: string) => (tx: Transaction) => {\n\t\treturn tx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::generate_proof_as_owner`,\n\t\t\targuments: [tx.object(managerId)],\n\t\t});\n\t};\n\n\t/**\n\t * @description Generate a trade proof as a trader\n\t * @param {string} managerId The ID of the BalanceManager\n\t * @param {string} tradeCapId The ID of the tradeCap\n\t * @returns A function that takes a Transaction object\n\t */\n\tgenerateProofAsTrader = (managerId: string, tradeCapId: string) => (tx: Transaction) => {\n\t\treturn tx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::generate_proof_as_trader`,\n\t\t\targuments: [tx.object(managerId), tx.object(tradeCapId)],\n\t\t});\n\t};\n\n\t/**\n\t * @description Get the owner of the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @returns A function that takes a Transaction object\n\t */\n\towner = (managerKey: string) => (tx: Transaction) => {\n\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\ttx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::owner`,\n\t\t\targuments: [tx.object(managerId)],\n\t\t});\n\t};\n\n\t/**\n\t * @description Get the ID of the BalanceManager\n\t * @param {string} managerKey The key of the BalanceManager\n\t * @returns A function that takes a Transaction object\n\t */\n\tid = (managerKey: string) => (tx: Transaction) => {\n\t\tconst managerId = this.#config.getBalanceManager(managerKey).address;\n\t\ttx.moveCall({\n\t\t\ttarget: `${this.#config.DEEPBOOK_PACKAGE_ID}::balance_manager::id`,\n\t\t\targuments: [tx.object(managerId)],\n\t\t});\n\t};\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,0BAAgC;AAFhC;AAUO,MAAM,uBAAuB;AAAA;AAAA;AAAA;AAAA,EAMnC,YAAY,QAAwB;AALpC;AAaA;AAAA;AAAA;AAAA;AAAA,wCAA+B,MAAM,CAAC,OAAoB;AACzD,YAAM,UAAU,GAAG,SAAS;AAAA,QAC3B,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,MAC5C,CAAC;AAED,SAAG,SAAS;AAAA,QACX,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,OAAO;AAAA,MACpB,CAAC;AAAA,IACF;AASA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BACC,CAAC,YAAoB,SAAiB,oBAA4B,CAAC,OAAoB;AACtF,SAAG,kBAAkB,mBAAK,SAAQ,OAAO;AACzC,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,YAAM,OAAO,mBAAK,SAAQ,QAAQ,OAAO;AACzC,YAAM,cAAU,qCAAgB;AAAA,QAC/B,MAAM,KAAK;AAAA,QACX,SAAS,kBAAkB,KAAK;AAAA,MACjC,CAAC;AAED,SAAG,SAAS;AAAA,QACX,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,GAAG,OAAO;AAAA,QACzC,eAAe,CAAC,KAAK,IAAI;AAAA,MAC1B,CAAC;AAAA,IACF;AAUD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+BACC,CAAC,YAAoB,SAAiB,kBAA0B,cAChE,CAAC,OAAoB;AACpB,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,YAAM,OAAO,mBAAK,SAAQ,QAAQ,OAAO;AACzC,YAAM,aAAa,GAAG,SAAS;AAAA,QAC9B,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,GAAG,GAAG,KAAK,IAAI,mBAAmB,KAAK,MAAM,CAAC;AAAA,QAC7E,eAAe,CAAC,KAAK,IAAI;AAAA,MAC1B,CAAC;AAED,SAAG,gBAAgB,CAAC,UAAU,GAAG,SAAS;AAAA,IAC3C;AASD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kCACC,CAAC,YAAoB,SAAiB,cAAsB,CAAC,OAAoB;AAChF,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,YAAM,OAAO,mBAAK,SAAQ,QAAQ,OAAO;AACzC,YAAM,iBAAiB,GAAG,SAAS;AAAA,QAClC,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,QAChC,eAAe,CAAC,KAAK,IAAI;AAAA,MAC1B,CAAC;AAED,SAAG,gBAAgB,CAAC,cAAc,GAAG,SAAS;AAAA,IAC/C;AAQD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+BAAsB,CAAC,YAAoB,YAAoB,CAAC,OAAoB;AACnF,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,YAAM,OAAO,mBAAK,SAAQ,QAAQ,OAAO;AACzC,SAAG,SAAS;AAAA,QACX,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,QAChC,eAAe,CAAC,KAAK,IAAI;AAAA,MAC1B,CAAC;AAAA,IACF;AAOA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAgB,CAAC,eAAuB,CAAC,OAAoB;AAC5D,YAAM,iBAAiB,mBAAK,SAAQ,kBAAkB,UAAU;AAChE,aAAO,GAAG;AAAA,QACT,eAAe,WACZ,KAAK,sBAAsB,eAAe,SAAS,eAAe,QAAQ,IAC1E,KAAK,qBAAqB,eAAe,OAAO;AAAA,MACpD;AAAA,IACD;AAOA;AAAA;AAAA;AAAA;AAAA;AAAA,gCAAuB,CAAC,cAAsB,CAAC,OAAoB;AAClE,aAAO,GAAG,SAAS;AAAA,QAClB,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,MACjC,CAAC;AAAA,IACF;AAQA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iCAAwB,CAAC,WAAmB,eAAuB,CAAC,OAAoB;AACvF,aAAO,GAAG,SAAS;AAAA,QAClB,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,GAAG,GAAG,OAAO,UAAU,CAAC;AAAA,MACxD,CAAC;AAAA,IACF;AAOA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAAQ,CAAC,eAAuB,CAAC,OAAoB;AACpD,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,SAAG,SAAS;AAAA,QACX,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,MACjC,CAAC;AAAA,IACF;AAOA;AAAA;AAAA;AAAA;AAAA;AAAA,cAAK,CAAC,eAAuB,CAAC,OAAoB;AACjD,YAAM,YAAY,mBAAK,SAAQ,kBAAkB,UAAU,EAAE;AAC7D,SAAG,SAAS;AAAA,QACX,QAAQ,GAAG,mBAAK,SAAQ,mBAAmB;AAAA,QAC3C,WAAW,CAAC,GAAG,OAAO,SAAS,CAAC;AAAA,MACjC,CAAC;AAAA,IACF;AAnKC,uBAAK,SAAU;AAAA,EAChB;AAmKD;AA1KC;",
+  "names": []
+}

package/dist/cjs/transactions/deepbook.d.ts

@@ -0,0 +1,183 @@
+import type { Transaction } from '@mysten/sui/transactions';
+import type { PlaceLimitOrderParams, PlaceMarketOrderParams, SwapParams } from '../types/index.js';
+import type { DeepBookConfig } from '../utils/config.js';
+/**
+ * DeepBookContract class for managing DeepBook operations.
+ */
+export declare class DeepBookContract {
+    #private;
+    /**
+     * @param {DeepBookConfig} config Configuration for DeepBookContract
+     */
+    constructor(config: DeepBookConfig);
+    /**
+     * @description Place a limit order
+     * @param {PlaceLimitOrderParams} params Parameters for placing a limit order
+     * @returns A function that takes a Transaction object
+     */
+    placeLimitOrder: (params: PlaceLimitOrderParams) => (tx: Transaction) => void;
+    /**
+     * @description Place a market order
+     * @param {PlaceMarketOrderParams} params Parameters for placing a market order
+     * @returns A function that takes a Transaction object
+     */
+    placeMarketOrder: (params: PlaceMarketOrderParams) => (tx: Transaction) => void;
+    /**
+     * @description Modify an existing order
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} balanceManagerKey The key to identify the BalanceManager
+     * @param {string} orderId Order ID to modify
+     * @param {number} newQuantity New quantity for the order
+     * @returns A function that takes a Transaction object
+     */
+    modifyOrder: (poolKey: string, balanceManagerKey: string, orderId: string, newQuantity: number) => (tx: Transaction) => void;
+    /**
+     * @description Cancel an existing order
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} balanceManagerKey The key to identify the BalanceManager
+     * @param {string} orderId Order ID to cancel
+     * @returns A function that takes a Transaction object
+     */
+    cancelOrder: (poolKey: string, balanceManagerKey: string, orderId: string) => (tx: Transaction) => void;
+    /**
+     * @description Cancel all open orders for a balance manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} balanceManagerKey The key to identify the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    cancelAllOrders: (poolKey: string, balanceManagerKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Withdraw settled amounts for a balance manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} balanceManagerKey The key to identify the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    withdrawSettledAmounts: (poolKey: string, balanceManagerKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Add a deep price point for a target pool using a reference pool
+     * @param {string} targetPoolKey The key to identify the target pool
+     * @param {string} referencePoolKey The key to identify the reference pool
+     * @returns A function that takes a Transaction object
+     */
+    addDeepPricePoint: (targetPoolKey: string, referencePoolKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Claim rebates for a balance manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} balanceManagerKey The key to identify the BalanceManager
+     * @returns A function that takes a Transaction object
+     */
+    claimRebates: (poolKey: string, balanceManagerKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Gets an order
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} orderId Order ID to get
+     * @returns A function that takes a Transaction object
+     */
+    getOrder: (poolKey: string, orderId: string) => (tx: Transaction) => void;
+    /**
+     * @description Burn DEEP tokens from the pool
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    burnDeep: (poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Get the mid price for a pool
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    midPrice: (poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Check if a pool is whitelisted
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    whitelisted: (poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Get the quote quantity out for a given base quantity in
+     * @param {string} poolKey The key to identify the pool
+     * @param {number} baseQuantity Base quantity to convert
+     * @returns A function that takes a Transaction object
+     */
+    getQuoteQuantityOut: (poolKey: string, baseQuantity: number) => (tx: Transaction) => void;
+    /**
+     * @description Get the base quantity out for a given quote quantity in
+     * @param {string} poolKey The key to identify the pool
+     * @param {number} quoteQuantity Quote quantity to convert
+     * @returns A function that takes a Transaction object
+     */
+    getBaseQuantityOut: (poolKey: string, quoteQuantity: number) => (tx: Transaction) => void;
+    /**
+     * @description Get the quantity out for a given base or quote quantity
+     * @param {string} poolKey The key to identify the pool
+     * @param {number} baseQuantity Base quantity to convert
+     * @param {number} quoteQuantity Quote quantity to convert
+     * @returns A function that takes a Transaction object
+     */
+    getQuantityOut: (poolKey: string, baseQuantity: number, quoteQuantity: number) => (tx: Transaction) => void;
+    /**
+     * @description Get open orders for a balance manager in a pool
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} managerKey Key of the balance manager
+     * @returns A function that takes a Transaction object
+     */
+    accountOpenOrders: (poolKey: string, managerKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Get level 2 order book specifying range of price
+     * @param {string} poolKey The key to identify 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 A function that takes a Transaction object
+     */
+    getLevel2Range: (poolKey: string, priceLow: number, priceHigh: number, isBid: boolean) => (tx: Transaction) => void;
+    /**
+     * @description Get level 2 order book ticks from mid-price for a pool
+     * @param {string} poolKey The key to identify the pool
+     * @param {number} tickFromMid Number of ticks from mid-price
+     * @returns A function that takes a Transaction object
+     */
+    getLevel2TicksFromMid: (poolKey: string, tickFromMid: number) => (tx: Transaction) => void;
+    /**
+     * @description Get the vault balances for a pool
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    vaultBalances: (poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @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 A function that takes a Transaction object
+     */
+    getPoolIdByAssets: (baseType: string, quoteType: string) => (tx: Transaction) => void;
+    /**
+     * @description Swap exact base amount for quote amount
+     * @param {SwapParams} params Parameters for the swap
+     * @returns A function that takes a Transaction object
+     */
+    swapExactBaseForQuote: (params: SwapParams) => (tx: Transaction) => readonly [{
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }, {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }, {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }];
+    /**
+     * @description Swap exact quote amount for base amount
+     * @param {SwapParams} params Parameters for the swap
+     * @returns A function that takes a Transaction object
+     */
+    swapExactQuoteForBase: (params: SwapParams) => (tx: Transaction) => readonly [{
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }, {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }, {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }];
+}