Margin Pool

The MarginPool is a shared object that manages liquidity for a specific asset, enabling lenders to supply assets and margin traders to borrow them. Each margin pool tracks supply and borrow positions, accrues interest over time, and enforces risk parameters to maintain system health.

Margin pools use a shares-based accounting system where suppliers receive shares representing their proportion of the total supply. Interest accrues continuously, increasing the value of these shares over time. Borrowers can only borrow from pools that have enabled their specific DeepBook trading pool.

API

Following are the different public functions that the MarginPool exposes.

Click to open

Mint a SupplierCap

Create a new SupplierCap that can be used to supply and withdraw from margin pools. One SupplierCap can be used across multiple margin pools.

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

Supply liquidity

Supply assets to the margin pool to earn interest. Returns the total supply shares owned by the supplier after this operation.

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 liquidity

Withdraw supplied assets from the margin pool. You can specify an exact amount or withdraw all available shares.

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

Read endpoints

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

Events

Click to open

MarginPoolCreated

The system emits this event when you create a new 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.

Click to open

DeepbookPoolUpdated

The system emits this event when you enable or disable a DeepBook pool for lending.

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

InterestParamsUpdated

The system emits this event when you update interest rate parameters.

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

MarginPoolConfigUpdated

The system emits this event when you update the margin pool configuration.

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

SupplierCapMinted

The system emits this event when you mint a new supplier cap.

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

AssetSupplied

The system emits this event when you supply assets to a 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.

Click to open

AssetWithdrawn

The system emits this event when you withdraw assets from a 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.

Click to open

MaintainerFeesWithdrawn

The system emits this event when you withdraw maintainer fees.

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

ProtocolFeesWithdrawn

The system emits this event when you withdraw protocol fees.

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

ProtocolFeesIncreased

The system emits this event when it accrues protocol fees from interest payments.

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