@haneullabs/deepbook-v3 0.1.0

package/src/transactions/poolProxy.ts

@@ -0,0 +1,438 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import type { Transaction } from '@haneullabs/haneul/transactions';
+import type {
+	PlaceMarginLimitOrderParams,
+	PlaceMarginMarketOrderParams,
+	MarginProposalParams,
+} from '../types/index.js';
+
+import type { DeepBookConfig } from '../utils/config.js';
+import { OrderType, SelfMatchingOptions } from '../types/index.js';
+import { MAX_TIMESTAMP, FLOAT_SCALAR } from '../utils/config.js';
+
+/**
+ * PoolProxyContract class for managing PoolProxy operations.
+ */
+export class PoolProxyContract {
+	#config: DeepBookConfig;
+
+	/**
+	 * @param {DeepBookConfig} config Configuration for PoolProxyContract
+	 */
+	constructor(config: DeepBookConfig) {
+		this.#config = config;
+	}
+
+	/**
+	 * @description Place a limit order
+	 * @param {PlaceMarginLimitOrderParams} params Parameters for placing a limit order
+	 * @returns A function that takes a Transaction object
+	 */
+	placeLimitOrder = (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => {
+		const {
+			poolKey,
+			marginManagerKey,
+			clientOrderId,
+			price,
+			quantity,
+			isBid,
+			expiration = MAX_TIMESTAMP,
+			orderType = OrderType.NO_RESTRICTION,
+			selfMatchingOption = SelfMatchingOptions.SELF_MATCHING_ALLOWED,
+			payWithDeep = true,
+		} = params;
+		const pool = this.#config.getPool(poolKey);
+		const manager = this.#config.getMarginManager(marginManagerKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const inputPrice = Math.round((price * FLOAT_SCALAR * quoteCoin.scalar) / baseCoin.scalar);
+		const inputQuantity = Math.round(quantity * baseCoin.scalar);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_limit_order`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(manager.address),
+				tx.object(pool.address),
+				tx.pure.u64(clientOrderId),
+				tx.pure.u8(orderType),
+				tx.pure.u8(selfMatchingOption),
+				tx.pure.u64(inputPrice),
+				tx.pure.u64(inputQuantity),
+				tx.pure.bool(isBid),
+				tx.pure.bool(payWithDeep),
+				tx.pure.u64(expiration),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Place a market order
+	 * @param {PlaceMarginMarketOrderParams} params Parameters for placing a market order
+	 * @returns A function that takes a Transaction object
+	 */
+	placeMarketOrder = (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => {
+		const {
+			poolKey,
+			marginManagerKey,
+			clientOrderId,
+			quantity,
+			isBid,
+			selfMatchingOption = SelfMatchingOptions.SELF_MATCHING_ALLOWED,
+			payWithDeep = true,
+		} = params;
+		const pool = this.#config.getPool(poolKey);
+		const manager = this.#config.getMarginManager(marginManagerKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const inputQuantity = Math.round(quantity * baseCoin.scalar);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_market_order`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(manager.address),
+				tx.object(pool.address),
+				tx.pure.u64(clientOrderId),
+				tx.pure.u8(selfMatchingOption),
+				tx.pure.u64(inputQuantity),
+				tx.pure.bool(isBid),
+				tx.pure.bool(payWithDeep),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Place a reduce only limit order
+	 * @param {PlaceMarginLimitOrderParams} params Parameters for placing a reduce only limit order
+	 * @returns A function that takes a Transaction object
+	 */
+	placeReduceOnlyLimitOrder = (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => {
+		const {
+			poolKey,
+			marginManagerKey,
+			clientOrderId,
+			price,
+			quantity,
+			isBid,
+			expiration = MAX_TIMESTAMP,
+			orderType = OrderType.NO_RESTRICTION,
+			selfMatchingOption = SelfMatchingOptions.SELF_MATCHING_ALLOWED,
+			payWithDeep = true,
+		} = params;
+		const pool = this.#config.getPool(poolKey);
+		const manager = this.#config.getMarginManager(marginManagerKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const inputPrice = Math.round((price * FLOAT_SCALAR * quoteCoin.scalar) / baseCoin.scalar);
+		const inputQuantity = Math.round(quantity * baseCoin.scalar);
+		const marginPool = isBid
+			? this.#config.getMarginPool(pool.baseCoin)
+			: this.#config.getMarginPool(pool.quoteCoin);
+		const debtType = isBid ? baseCoin.type : quoteCoin.type;
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_limit_order`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(manager.address),
+				tx.object(pool.address),
+				tx.object(marginPool.address),
+				tx.pure.u64(clientOrderId),
+				tx.pure.u8(orderType),
+				tx.pure.u8(selfMatchingOption),
+				tx.pure.u64(inputPrice),
+				tx.pure.u64(inputQuantity),
+				tx.pure.bool(isBid),
+				tx.pure.bool(payWithDeep),
+				tx.pure.u64(expiration),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type, debtType],
+		});
+	};
+
+	/**
+	 * @description Place a reduce only market order
+	 * @param {PlaceMarginMarketOrderParams} params Parameters for placing a reduce only market order
+	 * @returns A function that takes a Transaction object
+	 */
+	placeReduceOnlyMarketOrder = (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => {
+		const {
+			poolKey,
+			marginManagerKey,
+			clientOrderId,
+			quantity,
+			isBid,
+			selfMatchingOption = SelfMatchingOptions.SELF_MATCHING_ALLOWED,
+			payWithDeep = true,
+		} = params;
+		const pool = this.#config.getPool(poolKey);
+		const manager = this.#config.getMarginManager(marginManagerKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const inputQuantity = Math.round(quantity * baseCoin.scalar);
+		const marginPool = isBid
+			? this.#config.getMarginPool(pool.baseCoin)
+			: this.#config.getMarginPool(pool.quoteCoin);
+		const debtType = isBid ? baseCoin.type : quoteCoin.type;
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_market_order`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(manager.address),
+				tx.object(pool.address),
+				tx.object(marginPool.address),
+				tx.pure.u64(clientOrderId),
+				tx.pure.u8(selfMatchingOption),
+				tx.pure.u64(inputQuantity),
+				tx.pure.bool(isBid),
+				tx.pure.bool(payWithDeep),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type, debtType],
+		});
+	};
+
+	/**
+	 * @description Modify an existing order
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {string} orderId Order ID to modify
+	 * @param {number} newQuantity New quantity for the order
+	 * @returns A function that takes a Transaction object
+	 */
+	modifyOrder =
+		(marginManagerKey: string, orderId: string, newQuantity: number) => (tx: Transaction) => {
+			const marginManager = this.#config.getMarginManager(marginManagerKey);
+			const pool = this.#config.getPool(marginManager.poolKey);
+			const baseCoin = this.#config.getCoin(pool.baseCoin);
+			const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+			const inputQuantity = Math.round(newQuantity * baseCoin.scalar);
+
+			tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::modify_order`,
+				arguments: [
+					tx.object(this.#config.MARGIN_REGISTRY_ID),
+					tx.object(marginManager.address),
+					tx.object(pool.address),
+					tx.pure.u128(orderId),
+					tx.pure.u64(inputQuantity),
+					tx.object.clock(),
+				],
+				typeArguments: [baseCoin.type, quoteCoin.type],
+			});
+		};
+
+	/**
+	 * @description Cancel an existing order
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {string} orderId Order ID to cancel
+	 * @returns A function that takes a Transaction object
+	 */
+	cancelOrder = (marginManagerKey: string, orderId: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::cancel_order`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+				tx.pure.u128(orderId),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Cancel multiple existing orders
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {string[]} orderIds Order IDs to cancel
+	 * @returns A function that takes a Transaction object
+	 */
+	cancelOrders = (marginManagerKey: string, orderIds: string[]) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::cancel_orders`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+				tx.pure.vector('u128', orderIds),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Cancel all existing orders
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @returns A function that takes a Transaction object
+	 */
+	cancelAllOrders = (marginManagerKey: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::cancel_all_orders`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Withdraw settled amounts
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @returns A function that takes a Transaction object
+	 */
+	withdrawSettledAmounts = (marginManagerKey: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::withdraw_settled_amounts`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Stake in the pool
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {number} stakeAmount The amount to stake
+	 * @returns A function that takes a Transaction object
+	 */
+	stake = (marginManagerKey: string, stakeAmount: number) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const deepCoin = this.#config.getCoin('DEEP');
+		const stakeInput = Math.round(stakeAmount * deepCoin.scalar);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::stake`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+				tx.pure.u64(stakeInput),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Unstake from the pool
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @returns A function that takes a Transaction object
+	 */
+	unstake = (marginManagerKey: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::unstake`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Submit a proposal
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {MarginProposalParams} params Parameters for the proposal
+	 * @returns A function that takes a Transaction object
+	 */
+	submitProposal =
+		(marginManagerKey: string, params: MarginProposalParams) => (tx: Transaction) => {
+			const { takerFee, makerFee, stakeRequired } = params;
+			const marginManager = this.#config.getMarginManager(marginManagerKey);
+			const pool = this.#config.getPool(marginManager.poolKey);
+			const baseCoin = this.#config.getCoin(pool.baseCoin);
+			const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+			const stakeInput = Math.round(stakeRequired * FLOAT_SCALAR);
+			const takerFeeInput = Math.round(takerFee * FLOAT_SCALAR);
+			const makerFeeInput = Math.round(makerFee * FLOAT_SCALAR);
+			tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::submit_proposal`,
+				arguments: [
+					tx.object(this.#config.MARGIN_REGISTRY_ID),
+					tx.object(marginManager.address),
+					tx.object(pool.address),
+					tx.pure.u64(takerFeeInput),
+					tx.pure.u64(makerFeeInput),
+					tx.pure.u64(stakeInput),
+				],
+				typeArguments: [baseCoin.type, quoteCoin.type],
+			});
+		};
+
+	/**
+	 * @description Vote on a proposal
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @param {string} proposalId The ID of the proposal to vote on
+	 * @returns A function that takes a Transaction object
+	 */
+	vote = (marginManagerKey: string, proposalId: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::vote`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+				tx.pure.id(proposalId),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Claim a rebate from a pool
+	 * @param {string} marginManagerKey The key to identify the MarginManager
+	 * @returns A function that takes a Transaction object
+	 */
+	claimRebate = (marginManagerKey: string) => (tx: Transaction) => {
+		const marginManager = this.#config.getMarginManager(marginManagerKey);
+		const pool = this.#config.getPool(marginManager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::claim_rebate`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(marginManager.address),
+				tx.object(pool.address),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+}

package/src/types/bcs.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export { Account } from '../contracts/deepbook/account.js';
+export { Balances } from '../contracts/deepbook/balances.js';
+export { OrderDeepPrice } from '../contracts/deepbook/deep_price.js';
+export { Order } from '../contracts/deepbook/order.js';
+export { VecSet } from '../contracts/deepbook/deps/sui/vec_set.js';

package/src/types/index.ts

@@ -0,0 +1,255 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { TransactionObjectArgument } from '@haneullabs/haneul/transactions';
+
+// SPDX-License-Identifier: Apache-2.0
+export interface BalanceManager {
+	address: string;
+	tradeCap?: string;
+	depositCap?: string;
+	withdrawCap?: string;
+}
+
+export interface MarginManager {
+	address: string;
+	poolKey: string;
+}
+
+export interface Coin {
+	address: string;
+	type: string;
+	scalar: number;
+	feed?: string;
+	currencyId?: string;
+	priceInfoObjectId?: string;
+}
+
+export interface Pool {
+	address: string;
+	baseCoin: string;
+	quoteCoin: string;
+}
+
+export interface MarginPool {
+	address: string;
+	type: string;
+}
+
+// Trading constants
+export enum OrderType {
+	NO_RESTRICTION,
+	IMMEDIATE_OR_CANCEL,
+	FILL_OR_KILL,
+	POST_ONLY,
+}
+
+// Self matching options
+export enum SelfMatchingOptions {
+	SELF_MATCHING_ALLOWED,
+	CANCEL_TAKER,
+	CANCEL_MAKER,
+}
+
+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 CanPlaceLimitOrderParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	price: number;
+	quantity: number;
+	isBid: boolean;
+	payWithDeep: boolean;
+	expireTimestamp: number;
+}
+
+export interface CanPlaceMarketOrderParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	quantity: number;
+	isBid: boolean;
+	payWithDeep: boolean;
+}
+
+export interface PlaceMarginLimitOrderParams {
+	poolKey: string;
+	marginManagerKey: string;
+	clientOrderId: string;
+	price: number;
+	quantity: number;
+	isBid: boolean;
+	expiration?: number | bigint;
+	orderType?: OrderType;
+	selfMatchingOption?: SelfMatchingOptions;
+	payWithDeep?: boolean;
+}
+
+export interface PlaceMarginMarketOrderParams {
+	poolKey: string;
+	marginManagerKey: string;
+	clientOrderId: string;
+	quantity: number;
+	isBid: boolean;
+	selfMatchingOption?: SelfMatchingOptions;
+	payWithDeep?: boolean;
+}
+
+export interface PendingLimitOrderParams {
+	clientOrderId: string;
+	orderType?: OrderType;
+	selfMatchingOption?: SelfMatchingOptions;
+	price: number;
+	quantity: number;
+	isBid: boolean;
+	payWithDeep?: boolean;
+	expireTimestamp?: number | bigint;
+}
+
+export interface PendingMarketOrderParams {
+	clientOrderId: string;
+	selfMatchingOption?: SelfMatchingOptions;
+	quantity: number;
+	isBid: boolean;
+	payWithDeep?: boolean;
+}
+
+export interface AddConditionalOrderParams {
+	marginManagerKey: string;
+	conditionalOrderId: string;
+	triggerBelowPrice: boolean;
+	triggerPrice: number;
+	pendingOrder: PendingLimitOrderParams | PendingMarketOrderParams;
+}
+
+export interface ProposalParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	takerFee: number;
+	makerFee: number;
+	stakeRequired: number;
+}
+
+export interface MarginProposalParams {
+	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 SwapWithManagerParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	tradeCap: string;
+	depositCap: string;
+	withdrawCap: string;
+	amount: number;
+	minOut: number;
+	baseCoin?: TransactionObjectArgument;
+	quoteCoin?: TransactionObjectArgument;
+}
+
+export interface StakeParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	amount: number;
+}
+
+export interface VoteParams {
+	poolKey: string;
+	balanceManagerKey: string;
+	proposalId: string;
+}
+
+export interface FlashLoanParams {
+	poolKey: string;
+	amount: number;
+}
+
+export interface CreatePoolAdminParams {
+	baseCoinKey: string;
+	quoteCoinKey: string;
+	tickSize: number;
+	lotSize: number;
+	minSize: number;
+	whitelisted: boolean;
+	stablePool: boolean;
+}
+
+export interface CreatePermissionlessPoolParams {
+	baseCoinKey: string;
+	quoteCoinKey: string;
+	tickSize: number;
+	lotSize: number;
+	minSize: number;
+	deepCoin?: TransactionObjectArgument;
+}
+
+export interface SetEwmaParams {
+	alpha: number;
+	zScoreThreshold: number;
+	additionalTakerFee: number;
+}
+
+export interface PoolConfigParams {
+	minWithdrawRiskRatio: number;
+	minBorrowRiskRatio: number;
+	liquidationRiskRatio: number;
+	targetLiquidationRiskRatio: number;
+	userLiquidationReward: number;
+	poolLiquidationReward: number;
+}
+
+export interface MarginPoolConfigParams {
+	supplyCap: number;
+	maxUtilizationRate: number;
+	referralSpread: number;
+	minBorrow: number;
+	rateLimitCapacity?: number;
+	rateLimitRefillRatePerMs?: number;
+	rateLimitEnabled?: boolean;
+}
+
+export interface InterestConfigParams {
+	baseRate: number;
+	baseSlope: number;
+	optimalUtilization: number;
+	excessSlope: number;
+}
+
+export interface Config {
+	DEEPBOOK_PACKAGE_ID: string;
+	REGISTRY_ID: string;
+	DEEP_TREASURY_ID: string;
+}
+
+export type Environment = 'mainnet' | 'testnet';