@haneullabs/deepbook-v3 0.1.0

package/src/contracts/deepbook/deps/sui/vec_map.ts

@@ -0,0 +1,33 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import { bcs } from '@haneullabs/haneul/bcs';
+import type { BcsType } from '@haneullabs/haneul/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+const $moduleName = '0x2::vec_map';
+/** An entry in the map */
+export function Entry<K extends BcsType<any>, V extends BcsType<any>>(...typeParameters: [K, V]) {
+	return new MoveStruct({
+		name: `${$moduleName}::Entry<${typeParameters[0].name as K['name']}, ${typeParameters[1].name as V['name']}>`,
+		fields: {
+			key: typeParameters[0],
+			value: typeParameters[1],
+		},
+	});
+}
+/**
+ * A map data structure backed by a vector. The map is guaranteed not to contain
+ * duplicate keys, but entries are _not_ sorted by key--entries are included in
+ * insertion order. All operations are O(N) in the size of the map--the intention
+ * of this data structure is only to provide the convenience of programming against
+ * a map API. Large maps should use handwritten parent/child relationships instead.
+ * Maps that need sorted iteration rather than insertion order iteration should
+ * also be handwritten.
+ */
+export function VecMap<K extends BcsType<any>, V extends BcsType<any>>(...typeParameters: [K, V]) {
+	return new MoveStruct({
+		name: `${$moduleName}::VecMap<${typeParameters[0].name as K['name']}, ${typeParameters[1].name as V['name']}>`,
+		fields: {
+			contents: bcs.vector(Entry(typeParameters[0], typeParameters[1])),
+		},
+	});
+}

package/src/contracts/deepbook/deps/sui/vec_set.ts

@@ -0,0 +1,22 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import { bcs } from '@haneullabs/haneul/bcs';
+import type { BcsType } from '@haneullabs/haneul/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+const $moduleName = '0x2::vec_set';
+/**
+ * A set data structure backed by a vector. The set is guaranteed not to contain
+ * duplicate keys. All operations are O(N) in the size of the set
+ *
+ * - the intention of this data structure is only to provide the convenience of
+ *   programming against a set API. Sets that need sorted iteration rather than
+ *   insertion order iteration should be handwritten.
+ */
+export function VecSet<K extends BcsType<any>>(...typeParameters: [K]) {
+	return new MoveStruct({
+		name: `${$moduleName}::VecSet<${typeParameters[0].name as K['name']}>`,
+		fields: {
+			contents: bcs.vector(typeParameters[0]),
+		},
+	});
+}

package/src/contracts/deepbook/deps/sui/versioned.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@haneullabs/haneul/bcs';
+import * as object from './object.js';
+const $moduleName = '0x2::versioned';
+export const Versioned = new MoveStruct({
+	name: `${$moduleName}::Versioned`,
+	fields: {
+		id: object.UID,
+		version: bcs.u64(),
+	},
+});

package/src/contracts/deepbook/ewma.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * The Exponentially Weighted Moving Average (EWMA) state for DeepBook This state
+ * is used to calculate the smoothed mean and variance of gas prices and apply a
+ * penalty to taker fees based on the Z-score of the current gas price relative to
+ * the smoothed mean and variance. The state is enabled by default and can be
+ * configured with different parameters.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@haneullabs/haneul/bcs';
+const $moduleName = '@deepbook/core::ewma';
+export const EWMAState = new MoveStruct({
+	name: `${$moduleName}::EWMAState`,
+	fields: {
+		mean: bcs.u64(),
+		variance: bcs.u64(),
+		alpha: bcs.u64(),
+		z_score_threshold: bcs.u64(),
+		additional_taker_fee: bcs.u64(),
+		last_updated_timestamp: bcs.u64(),
+		enabled: bcs.bool(),
+	},
+});

package/src/contracts/deepbook/fill.ts

@@ -0,0 +1,336 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/** `Fill` struct represents the results of a match between two orders. */
+
+import { MoveStruct, normalizeMoveArguments } from '../utils/index.js';
+import type { RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@haneullabs/haneul/bcs';
+import type { Transaction } from '@haneullabs/haneul/transactions';
+import * as deep_price from './deep_price.js';
+const $moduleName = '@deepbook/core::fill';
+export const Fill = new MoveStruct({
+	name: `${$moduleName}::Fill`,
+	fields: {
+		maker_order_id: bcs.u128(),
+		maker_client_order_id: bcs.u64(),
+		execution_price: bcs.u64(),
+		balance_manager_id: bcs.Address,
+		expired: bcs.bool(),
+		completed: bcs.bool(),
+		original_maker_quantity: bcs.u64(),
+		base_quantity: bcs.u64(),
+		quote_quantity: bcs.u64(),
+		taker_is_bid: bcs.bool(),
+		maker_epoch: bcs.u64(),
+		maker_deep_price: deep_price.OrderDeepPrice,
+		taker_fee: bcs.u64(),
+		taker_fee_is_deep: bcs.bool(),
+		maker_fee: bcs.u64(),
+		maker_fee_is_deep: bcs.bool(),
+	},
+});
+export interface MakerOrderIdArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerOrderIdOptions {
+	package?: string;
+	arguments: MakerOrderIdArguments | [self: RawTransactionArgument<string>];
+}
+export function makerOrderId(options: MakerOrderIdOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_order_id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface MakerClientOrderIdArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerClientOrderIdOptions {
+	package?: string;
+	arguments: MakerClientOrderIdArguments | [self: RawTransactionArgument<string>];
+}
+export function makerClientOrderId(options: MakerClientOrderIdOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_client_order_id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ExecutionPriceArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface ExecutionPriceOptions {
+	package?: string;
+	arguments: ExecutionPriceArguments | [self: RawTransactionArgument<string>];
+}
+export function executionPrice(options: ExecutionPriceOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'execution_price',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface BalanceManagerIdArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface BalanceManagerIdOptions {
+	package?: string;
+	arguments: BalanceManagerIdArguments | [self: RawTransactionArgument<string>];
+}
+export function balanceManagerId(options: BalanceManagerIdOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'balance_manager_id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ExpiredArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface ExpiredOptions {
+	package?: string;
+	arguments: ExpiredArguments | [self: RawTransactionArgument<string>];
+}
+export function expired(options: ExpiredOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'expired',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CompletedArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface CompletedOptions {
+	package?: string;
+	arguments: CompletedArguments | [self: RawTransactionArgument<string>];
+}
+export function completed(options: CompletedOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'completed',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface OriginalMakerQuantityArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface OriginalMakerQuantityOptions {
+	package?: string;
+	arguments: OriginalMakerQuantityArguments | [self: RawTransactionArgument<string>];
+}
+export function originalMakerQuantity(options: OriginalMakerQuantityOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'original_maker_quantity',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface BaseQuantityArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface BaseQuantityOptions {
+	package?: string;
+	arguments: BaseQuantityArguments | [self: RawTransactionArgument<string>];
+}
+export function baseQuantity(options: BaseQuantityOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'base_quantity',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface TakerIsBidArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface TakerIsBidOptions {
+	package?: string;
+	arguments: TakerIsBidArguments | [self: RawTransactionArgument<string>];
+}
+export function takerIsBid(options: TakerIsBidOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'taker_is_bid',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface QuoteQuantityArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface QuoteQuantityOptions {
+	package?: string;
+	arguments: QuoteQuantityArguments | [self: RawTransactionArgument<string>];
+}
+export function quoteQuantity(options: QuoteQuantityOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'quote_quantity',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface MakerEpochArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerEpochOptions {
+	package?: string;
+	arguments: MakerEpochArguments | [self: RawTransactionArgument<string>];
+}
+export function makerEpoch(options: MakerEpochOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_epoch',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface MakerDeepPriceArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerDeepPriceOptions {
+	package?: string;
+	arguments: MakerDeepPriceArguments | [self: RawTransactionArgument<string>];
+}
+export function makerDeepPrice(options: MakerDeepPriceOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_deep_price',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface TakerFeeArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface TakerFeeOptions {
+	package?: string;
+	arguments: TakerFeeArguments | [self: RawTransactionArgument<string>];
+}
+export function takerFee(options: TakerFeeOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'taker_fee',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface TakerFeeIsDeepArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface TakerFeeIsDeepOptions {
+	package?: string;
+	arguments: TakerFeeIsDeepArguments | [self: RawTransactionArgument<string>];
+}
+export function takerFeeIsDeep(options: TakerFeeIsDeepOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'taker_fee_is_deep',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface MakerFeeArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerFeeOptions {
+	package?: string;
+	arguments: MakerFeeArguments | [self: RawTransactionArgument<string>];
+}
+export function makerFee(options: MakerFeeOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_fee',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface MakerFeeIsDeepArguments {
+	self: RawTransactionArgument<string>;
+}
+export interface MakerFeeIsDeepOptions {
+	package?: string;
+	arguments: MakerFeeIsDeepArguments | [self: RawTransactionArgument<string>];
+}
+export function makerFeeIsDeep(options: MakerFeeIsDeepOptions) {
+	const packageAddress = options.package ?? '@deepbook/core';
+	const argumentsTypes = [`${packageAddress}::fill::Fill`] satisfies string[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'fill',
+			function: 'maker_fee_is_deep',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook/governance.ts

@@ -0,0 +1,52 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Governance module handles the governance of the `Pool` that it's attached to.
+ * Users with non zero stake can create proposals and vote on them. Winning
+ * proposals are used to set the trade parameters for the next epoch.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@haneullabs/haneul/bcs';
+import * as vec_map from './deps/sui/vec_map.js';
+import * as trade_params from './trade_params.js';
+const $moduleName = '@deepbook/core::governance';
+export const Proposal = new MoveStruct({
+	name: `${$moduleName}::Proposal`,
+	fields: {
+		taker_fee: bcs.u64(),
+		maker_fee: bcs.u64(),
+		stake_required: bcs.u64(),
+		votes: bcs.u64(),
+	},
+});
+export const Governance = new MoveStruct({
+	name: `${$moduleName}::Governance`,
+	fields: {
+		/** Tracks refreshes. */
+		epoch: bcs.u64(),
+		/** If Pool is whitelisted. */
+		whitelisted: bcs.bool(),
+		/** If Pool is stable or volatile. */
+		stable: bcs.bool(),
+		/** List of proposals for the current epoch. */
+		proposals: vec_map.VecMap(bcs.Address, Proposal),
+		/** Trade parameters for the current epoch. */
+		trade_params: trade_params.TradeParams,
+		/** Trade parameters for the next epoch. */
+		next_trade_params: trade_params.TradeParams,
+		/** All voting power from the current stakes. */
+		voting_power: bcs.u64(),
+		/** Quorum for the current epoch. */
+		quorum: bcs.u64(),
+	},
+});
+export const TradeParamsUpdateEvent = new MoveStruct({
+	name: `${$moduleName}::TradeParamsUpdateEvent`,
+	fields: {
+		taker_fee: bcs.u64(),
+		maker_fee: bcs.u64(),
+		stake_required: bcs.u64(),
+	},
+});

package/src/contracts/deepbook/history.ts

@@ -0,0 +1,51 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * History module tracks the volume data for the current epoch and past epochs. It
+ * also tracks past trade params. Past maker fees are used to calculate fills for
+ * old orders. The historic median is used to calculate rebates and burns.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@haneullabs/haneul/bcs';
+import * as balances from './balances.js';
+import * as trade_params from './trade_params.js';
+import * as table from './deps/sui/table.js';
+const $moduleName = '@deepbook/core::history';
+export const Volumes = new MoveStruct({
+	name: `${$moduleName}::Volumes`,
+	fields: {
+		total_volume: bcs.u128(),
+		total_staked_volume: bcs.u128(),
+		total_fees_collected: balances.Balances,
+		historic_median: bcs.u128(),
+		trade_params: trade_params.TradeParams,
+	},
+});
+export const History = new MoveStruct({
+	name: `${$moduleName}::History`,
+	fields: {
+		epoch: bcs.u64(),
+		epoch_created: bcs.u64(),
+		volumes: Volumes,
+		historic_volumes: table.Table,
+		balance_to_burn: bcs.u64(),
+	},
+});
+export const EpochData = new MoveStruct({
+	name: `${$moduleName}::EpochData`,
+	fields: {
+		epoch: bcs.u64(),
+		pool_id: bcs.Address,
+		total_volume: bcs.u128(),
+		total_staked_volume: bcs.u128(),
+		base_fees_collected: bcs.u64(),
+		quote_fees_collected: bcs.u64(),
+		deep_fees_collected: bcs.u64(),
+		historic_median: bcs.u128(),
+		taker_fee: bcs.u64(),
+		maker_fee: bcs.u64(),
+		stake_required: bcs.u64(),
+	},
+});