@mysten/deepbook-v3 1.5.9 → 1.6.2

package/src/contracts/deepbook_margin/position_manager.ts

@@ -0,0 +1,28 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Position manager is responsible for managing users' positions. It is used to
+ * track the supply and loan shares of the users.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import * as table from './deps/sui/table.js';
+import * as vec_map from './deps/sui/vec_map.js';
+const $moduleName = '@deepbook/margin::position_manager';
+export const PositionManager = new MoveStruct({
+	name: `${$moduleName}::PositionManager`,
+	fields: {
+		positions: table.Table,
+		extra_fields: vec_map.VecMap(bcs.string(), bcs.u64()),
+	},
+});
+export const Position = new MoveStruct({
+	name: `${$moduleName}::Position`,
+	fields: {
+		shares: bcs.u64(),
+		referral: bcs.option(bcs.Address),
+	},
+});

package/src/contracts/deepbook_margin/protocol_config.ts

@@ -0,0 +1,163 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as vec_map from './deps/sui/vec_map.js';
+const $moduleName = '@deepbook/margin::protocol_config';
+export const MarginPoolConfig = new MoveStruct({
+	name: `${$moduleName}::MarginPoolConfig`,
+	fields: {
+		supply_cap: bcs.u64(),
+		max_utilization_rate: bcs.u64(),
+		protocol_spread: bcs.u64(),
+		min_borrow: bcs.u64(),
+		rate_limit_capacity: bcs.u64(),
+		rate_limit_refill_rate_per_ms: bcs.u64(),
+		rate_limit_enabled: bcs.bool(),
+	},
+});
+export const InterestConfig = new MoveStruct({
+	name: `${$moduleName}::InterestConfig`,
+	fields: {
+		base_rate: bcs.u64(),
+		base_slope: bcs.u64(),
+		optimal_utilization: bcs.u64(),
+		excess_slope: bcs.u64(),
+	},
+});
+export const ProtocolConfig = new MoveStruct({
+	name: `${$moduleName}::ProtocolConfig`,
+	fields: {
+		margin_pool_config: MarginPoolConfig,
+		interest_config: InterestConfig,
+		extra_fields: vec_map.VecMap(bcs.string(), bcs.u64()),
+	},
+});
+export interface NewProtocolConfigArguments {
+	marginPoolConfig: TransactionArgument;
+	interestConfig: TransactionArgument;
+}
+export interface NewProtocolConfigOptions {
+	package?: string;
+	arguments:
+		| NewProtocolConfigArguments
+		| [marginPoolConfig: TransactionArgument, interestConfig: TransactionArgument];
+}
+export function newProtocolConfig(options: NewProtocolConfigOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['marginPoolConfig', 'interestConfig'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_config',
+			function: 'new_protocol_config',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface NewMarginPoolConfigArguments {
+	supplyCap: RawTransactionArgument<number | bigint>;
+	maxUtilizationRate: RawTransactionArgument<number | bigint>;
+	protocolSpread: RawTransactionArgument<number | bigint>;
+	minBorrow: RawTransactionArgument<number | bigint>;
+}
+export interface NewMarginPoolConfigOptions {
+	package?: string;
+	arguments:
+		| NewMarginPoolConfigArguments
+		| [
+				supplyCap: RawTransactionArgument<number | bigint>,
+				maxUtilizationRate: RawTransactionArgument<number | bigint>,
+				protocolSpread: RawTransactionArgument<number | bigint>,
+				minBorrow: RawTransactionArgument<number | bigint>,
+		  ];
+}
+export function newMarginPoolConfig(options: NewMarginPoolConfigOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = ['u64', 'u64', 'u64', 'u64'] satisfies (string | null)[];
+	const parameterNames = ['supplyCap', 'maxUtilizationRate', 'protocolSpread', 'minBorrow'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_config',
+			function: 'new_margin_pool_config',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface NewMarginPoolConfigWithRateLimitArguments {
+	supplyCap: RawTransactionArgument<number | bigint>;
+	maxUtilizationRate: RawTransactionArgument<number | bigint>;
+	protocolSpread: RawTransactionArgument<number | bigint>;
+	minBorrow: RawTransactionArgument<number | bigint>;
+	rateLimitCapacity: RawTransactionArgument<number | bigint>;
+	rateLimitRefillRatePerMs: RawTransactionArgument<number | bigint>;
+	rateLimitEnabled: RawTransactionArgument<boolean>;
+}
+export interface NewMarginPoolConfigWithRateLimitOptions {
+	package?: string;
+	arguments:
+		| NewMarginPoolConfigWithRateLimitArguments
+		| [
+				supplyCap: RawTransactionArgument<number | bigint>,
+				maxUtilizationRate: RawTransactionArgument<number | bigint>,
+				protocolSpread: RawTransactionArgument<number | bigint>,
+				minBorrow: RawTransactionArgument<number | bigint>,
+				rateLimitCapacity: RawTransactionArgument<number | bigint>,
+				rateLimitRefillRatePerMs: RawTransactionArgument<number | bigint>,
+				rateLimitEnabled: RawTransactionArgument<boolean>,
+		  ];
+}
+export function newMarginPoolConfigWithRateLimit(options: NewMarginPoolConfigWithRateLimitOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = ['u64', 'u64', 'u64', 'u64', 'u64', 'u64', 'bool'] satisfies (
+		| string
+		| null
+	)[];
+	const parameterNames = [
+		'supplyCap',
+		'maxUtilizationRate',
+		'protocolSpread',
+		'minBorrow',
+		'rateLimitCapacity',
+		'rateLimitRefillRatePerMs',
+		'rateLimitEnabled',
+	];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_config',
+			function: 'new_margin_pool_config_with_rate_limit',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface NewInterestConfigArguments {
+	baseRate: RawTransactionArgument<number | bigint>;
+	baseSlope: RawTransactionArgument<number | bigint>;
+	optimalUtilization: RawTransactionArgument<number | bigint>;
+	excessSlope: RawTransactionArgument<number | bigint>;
+}
+export interface NewInterestConfigOptions {
+	package?: string;
+	arguments:
+		| NewInterestConfigArguments
+		| [
+				baseRate: RawTransactionArgument<number | bigint>,
+				baseSlope: RawTransactionArgument<number | bigint>,
+				optimalUtilization: RawTransactionArgument<number | bigint>,
+				excessSlope: RawTransactionArgument<number | bigint>,
+		  ];
+}
+export function newInterestConfig(options: NewInterestConfigOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = ['u64', 'u64', 'u64', 'u64'] satisfies (string | null)[];
+	const parameterNames = ['baseRate', 'baseSlope', 'optimalUtilization', 'excessSlope'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_config',
+			function: 'new_interest_config',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_margin/protocol_fees.ts

@@ -0,0 +1,153 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as table from './deps/sui/table.js';
+import * as vec_map from './deps/sui/vec_map.js';
+const $moduleName = '@deepbook/margin::protocol_fees';
+export const ProtocolFees = new MoveStruct({
+	name: `${$moduleName}::ProtocolFees`,
+	fields: {
+		referrals: table.Table,
+		total_shares: bcs.u64(),
+		fees_per_share: bcs.u64(),
+		maintainer_fees: bcs.u64(),
+		protocol_fees: bcs.u64(),
+		extra_fields: vec_map.VecMap(bcs.string(), bcs.u64()),
+	},
+});
+export const ReferralTracker = new MoveStruct({
+	name: `${$moduleName}::ReferralTracker`,
+	fields: {
+		current_shares: bcs.u64(),
+		last_fees_per_share: bcs.u64(),
+		unclaimed_fees: bcs.u64(),
+	},
+});
+export const SupplyReferral = new MoveStruct({
+	name: `${$moduleName}::SupplyReferral`,
+	fields: {
+		id: bcs.Address,
+		owner: bcs.Address,
+	},
+});
+export const ProtocolFeesIncreasedEvent = new MoveStruct({
+	name: `${$moduleName}::ProtocolFeesIncreasedEvent`,
+	fields: {
+		margin_pool_id: bcs.Address,
+		total_shares: bcs.u64(),
+		referral_fees: bcs.u64(),
+		maintainer_fees: bcs.u64(),
+		protocol_fees: bcs.u64(),
+	},
+});
+export const ReferralFeesClaimedEvent = new MoveStruct({
+	name: `${$moduleName}::ReferralFeesClaimedEvent`,
+	fields: {
+		referral_id: bcs.Address,
+		owner: bcs.Address,
+		fees: bcs.u64(),
+	},
+});
+export interface MaintainerFeesArguments {
+	self: TransactionArgument;
+}
+export interface MaintainerFeesOptions {
+	package?: string;
+	arguments: MaintainerFeesArguments | [self: TransactionArgument];
+}
+/** Get the maintainer fees. */
+export function maintainerFees(options: MaintainerFeesOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_fees',
+			function: 'maintainer_fees',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ProtocolFeesArguments {
+	self: TransactionArgument;
+}
+export interface ProtocolFeesOptions {
+	package?: string;
+	arguments: ProtocolFeesArguments | [self: TransactionArgument];
+}
+/** Get the protocol fees. */
+export function protocolFees(options: ProtocolFeesOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_fees',
+			function: 'protocol_fees',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ReferralTrackerArguments {
+	self: TransactionArgument;
+	referral: RawTransactionArgument<string>;
+}
+export interface ReferralTrackerOptions {
+	package?: string;
+	arguments:
+		| ReferralTrackerArguments
+		| [self: TransactionArgument, referral: RawTransactionArgument<string>];
+}
+export function referralTracker(options: ReferralTrackerOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null, '0x2::object::ID'] satisfies (string | null)[];
+	const parameterNames = ['self', 'referral'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_fees',
+			function: 'referral_tracker',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface TotalSharesArguments {
+	self: TransactionArgument;
+}
+export interface TotalSharesOptions {
+	package?: string;
+	arguments: TotalSharesArguments | [self: TransactionArgument];
+}
+export function totalShares(options: TotalSharesOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_fees',
+			function: 'total_shares',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface FeesPerShareArguments {
+	self: TransactionArgument;
+}
+export interface FeesPerShareOptions {
+	package?: string;
+	arguments: FeesPerShareArguments | [self: TransactionArgument];
+}
+export function feesPerShare(options: FeesPerShareOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'protocol_fees',
+			function: 'fees_per_share',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_margin/rate_limiter.ts

@@ -0,0 +1,80 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Token Bucket rate limiter for controlling withdrawal rates. Reference:
+ * https://github.com/code-423n4/2024-11-chainlink/blob/main/contracts/src/ccip/libraries/RateLimiter.sol
+ */
+
+import { MoveStruct, normalizeMoveArguments } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+const $moduleName = '@deepbook/margin::rate_limiter';
+export const RateLimiter = new MoveStruct({
+	name: `${$moduleName}::RateLimiter`,
+	fields: {
+		available: bcs.u64(),
+		last_updated_ms: bcs.u64(),
+		capacity: bcs.u64(),
+		refill_rate_per_ms: bcs.u64(),
+		enabled: bcs.bool(),
+	},
+});
+export interface IsEnabledArguments {
+	self: TransactionArgument;
+}
+export interface IsEnabledOptions {
+	package?: string;
+	arguments: IsEnabledArguments | [self: TransactionArgument];
+}
+export function isEnabled(options: IsEnabledOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'rate_limiter',
+			function: 'is_enabled',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CapacityArguments {
+	self: TransactionArgument;
+}
+export interface CapacityOptions {
+	package?: string;
+	arguments: CapacityArguments | [self: TransactionArgument];
+}
+export function capacity(options: CapacityOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'rate_limiter',
+			function: 'capacity',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface RefillRatePerMsArguments {
+	self: TransactionArgument;
+}
+export interface RefillRatePerMsOptions {
+	package?: string;
+	arguments: RefillRatePerMsArguments | [self: TransactionArgument];
+}
+export function refillRatePerMs(options: RefillRatePerMsOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'rate_limiter',
+			function: 'refill_rate_per_ms',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}