Maintainer

The maintainer module provides functions for managing margin pools, configuring interest rates, and controlling which DeepBook pools can access margin lending. Only maintainers with the appropriate capabilities can call these functions.

Each margin pool holds a single asset type and lends it only to the DeepBook pools that a maintainer enables for loans. Margin managers associated with those enabled DeepBook pools can then borrow from the margin pool.

API

Following are the different maintainer functions that the MarginPool exposes.

Click to open

Create a margin pool

Creates and registers a new margin pool for a specific asset. Only one margin pool can exist per asset type.

File not found in manifest: packages/deepbook_margin/sources/margin_pool.move. You probably need to run `pnpm prebuild` and restart the site.

Click to open

Enable or disable DeepBook pools

Control which DeepBook pools can borrow from this margin pool. Only margin managers associated with enabled pools can take loans.

File not found in manifest: packages/deepbook_margin/sources/margin_pool.move. You probably need to run `pnpm prebuild` and restart the site.

Click to open

Update pool parameters

Update interest rate parameters and margin pool configuration settings.

File not found in manifest: packages/deepbook_margin/sources/margin_pool.move. You probably need to run `pnpm prebuild` and restart the site.

Click to open

Withdraw fees

Withdraw accumulated maintainer and protocol fees from the margin pool.

File not found in manifest: packages/deepbook_margin/sources/margin_pool.move. You probably need to run `pnpm prebuild` and restart the site.

Events

The margin registry emits the following events when maintainer or pause capabilities change, or when a DeepBook pool is registered or updated in the registry. Listen for them to track these changes.

Click to open

MaintainerCapUpdated

The system emits this event when you update a maintainer capability.