Class MarginMaintainerContract

DeepBookMaintainerContract class for managing maintainer actions.

Index

Constructors

Methods

createMarginPool disableDeepbookPoolForLoan enableDeepbookPoolForLoan newInterestConfig newMarginPoolConfig newMarginPoolConfigWithRateLimit newProtocolConfig updateInterestParams updateMarginPoolConfig

Constructors

constructor

new MarginMaintainerContract(config: DeepBookConfig): MarginMaintainerContract
Parameters
- config: DeepBookConfig
  Configuration for MarginMaintainerContract
Returns MarginMaintainerContract
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:23

Methods

createMarginPool

createMarginPool(
coinKey: string,
poolConfig: TransactionArgument,
): (tx: Transaction) => void
Parameters
- coinKey: string
  The key to identify the coin
- poolConfig: TransactionArgument
  The configuration for the pool
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Create a new margin pool
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:45

disableDeepbookPoolForLoan

disableDeepbookPoolForLoan(
    deepbookPoolKey: string,
    coinKey: string,
    marginPoolCap: TransactionObjectArgument,
): (tx: Transaction) => void
Parameters
- deepbookPoolKey: string
  The key to identify the deepbook pool
- coinKey: string
  The key to identify the margin pool
- marginPoolCap: TransactionObjectArgument
  The margin pool cap
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Disable a deepbook pool for loan
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:206

enableDeepbookPoolForLoan

enableDeepbookPoolForLoan(
    deepbookPoolKey: string,
    coinKey: string,
    marginPoolCap: TransactionObjectArgument,
): (tx: Transaction) => void
Parameters
- deepbookPoolKey: string
  The key to identify the deepbook pool
- coinKey: string
  The key to identify the margin pool
- marginPoolCap: TransactionObjectArgument
  The margin pool cap
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Enable a deepbook pool for loan
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:181

newInterestConfig

newInterestConfig(
interestConfig: InterestConfigParams,
): (tx: Transaction) => TransactionResult
Parameters
- interestConfig: InterestConfigParams
  The configuration for the interest
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Create a new interest config
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:160

newMarginPoolConfig

newMarginPoolConfig(
coinKey: string,
marginPoolConfig: MarginPoolConfigParams,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the coin
- marginPoolConfig: MarginPoolConfigParams
  The configuration for the margin pool
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Create a new margin pool config
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:99

newMarginPoolConfigWithRateLimit

newMarginPoolConfigWithRateLimit(
    coinKey: string,
    marginPoolConfig: Required<
        Pick<
            MarginPoolConfigParams,
            "rateLimitCapacity"
            | "rateLimitRefillRatePerMs"
            | "rateLimitEnabled",
        >,
    > & MarginPoolConfigParams,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the coin
- marginPoolConfig: Required<
      Pick<
          MarginPoolConfigParams,
          "rateLimitCapacity"
          | "rateLimitRefillRatePerMs"
          | "rateLimitEnabled",
      >,
  > & MarginPoolConfigParams
  The configuration for the margin pool with rate limit
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Create a new margin pool config with rate limit
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:120

newProtocolConfig

newProtocolConfig(
    coinKey: string,
    marginPoolConfig: MarginPoolConfigParams,
    interestConfig: InterestConfigParams,
): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the coin
- marginPoolConfig: MarginPoolConfigParams
  The configuration for the margin pool (with optional rate limit)
- interestConfig: InterestConfigParams
  The configuration for the interest
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Create a new protocol config
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:67

updateInterestParams

updateInterestParams(
    coinKey: string,
    marginPoolCap: TransactionObjectArgument,
    interestConfig: InterestConfigParams,
): (tx: Transaction) => void
Parameters
- coinKey: string
  The key to identify the margin pool
- marginPoolCap: TransactionObjectArgument
  The margin pool cap
- interestConfig: InterestConfigParams
  The configuration for the interest
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Update the interest params
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:231

updateMarginPoolConfig

updateMarginPoolConfig(
    coinKey: string,
    marginPoolCap: TransactionObjectArgument,
    marginPoolConfig: MarginPoolConfigParams,
): (tx: Transaction) => void
Parameters
- coinKey: string
  The key to identify the margin pool
- marginPoolCap: TransactionObjectArgument
  The margin pool cap
- marginPoolConfig: MarginPoolConfigParams
  The configuration for the margin pool (with optional rate limit)
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Update the margin pool config
- Defined in packages/deepbook-v3/src/transactions/marginMaintainer.ts:260

Class MarginMaintainerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginMaintainerContract

Methods

createMarginPool

Parameters

Returns (tx: Transaction) => void

Description

disableDeepbookPoolForLoan

Parameters

Returns (tx: Transaction) => void

Description

enableDeepbookPoolForLoan

Parameters

Returns (tx: Transaction) => void

Description

newInterestConfig

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newMarginPoolConfig

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newMarginPoolConfigWithRateLimit

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newProtocolConfig

Parameters

Returns (tx: Transaction) => TransactionResult

Description

updateInterestParams

Parameters

Returns (tx: Transaction) => void

Description

updateMarginPoolConfig

Parameters

Returns (tx: Transaction) => void

Description

Settings

On This Page