Class PoolProxyContract

PoolProxyContract class for managing PoolProxy operations.

Index

Constructors

Methods

cancelAllOrders cancelOrder cancelOrders claimRebate modifyOrder placeLimitOrder placeMarketOrder placeReduceOnlyLimitOrder placeReduceOnlyMarketOrder stake submitProposal unstake vote withdrawMarginSettledAmounts withdrawSettledAmounts

Constructors

constructor

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

Methods

cancelAllOrders

cancelAllOrders(marginManagerKey: string): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel all existing orders
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:281

cancelOrder

cancelOrder(
marginManagerKey: string,
orderId: string,
): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- orderId: string
  Order ID to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel an existing order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:234

cancelOrders

cancelOrders(
marginManagerKey: string,
orderIds: string[],
): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- orderIds: string[]
  Order IDs to cancel
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Cancel multiple existing orders
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:258

claimRebate

claimRebate(marginManagerKey: string): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Claim a rebate from a pool
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:423

modifyOrder

modifyOrder(
    marginManagerKey: string,
    orderId: string,
    newQuantity: number,
): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- orderId: string
  Order ID to modify
- newQuantity: number
  New quantity for the order
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Modify an existing order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:207

placeLimitOrder

placeLimitOrder(
params: PlaceMarginLimitOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: PlaceMarginLimitOrderParams
  Parameters for placing a limit order
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Place a limit order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:32

placeMarketOrder

placeMarketOrder(
params: PlaceMarginMarketOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: PlaceMarginMarketOrderParams
  Parameters for placing a market order
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Place a market order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:76

placeReduceOnlyLimitOrder

placeReduceOnlyLimitOrder(
params: PlaceMarginLimitOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: PlaceMarginLimitOrderParams
  Parameters for placing a reduce only limit order
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Place a reduce only limit order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:113

placeReduceOnlyMarketOrder

placeReduceOnlyMarketOrder(
params: PlaceMarginMarketOrderParams,
): (tx: Transaction) => TransactionResult
Parameters
- params: PlaceMarginMarketOrderParams
  Parameters for placing a reduce only market order
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Place a reduce only market order
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:162

stake

stake(marginManagerKey: string, stakeAmount: number): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- stakeAmount: number
  The amount to stake
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Stake in the pool
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:325

submitProposal

submitProposal(
marginManagerKey: string,
params: MarginProposalParams,
): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- params: MarginProposalParams
  Parameters for the proposal
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Submit a proposal
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:372

unstake

unstake(marginManagerKey: string): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Unstake from the pool
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:349

vote

vote(marginManagerKey: string, proposalId: string): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
- proposalId: string
  The ID of the proposal to vote on
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Vote on a proposal
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:401

withdrawMarginSettledAmounts

withdrawMarginSettledAmounts(
poolKey: string,
marginManagerId: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- marginManagerId: string
  The object ID of the MarginManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw settled amounts permissionlessly for a margin manager by ID
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:446

withdrawSettledAmounts

withdrawSettledAmounts(marginManagerKey: string): (tx: Transaction) => void
Parameters
- marginManagerKey: string
  The key to identify the MarginManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw settled amounts
- Defined in packages/deepbook-v3/src/transactions/poolProxy.ts:303

Class PoolProxyContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PoolProxyContract

Methods

cancelAllOrders

Parameters

Returns (tx: Transaction) => void

Description

cancelOrder

Parameters

Returns (tx: Transaction) => void

Description

cancelOrders

Parameters

Returns (tx: Transaction) => void

Description

claimRebate

Parameters

Returns (tx: Transaction) => void

Description

modifyOrder

Parameters

Returns (tx: Transaction) => void

Description

placeLimitOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

placeMarketOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

placeReduceOnlyLimitOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

placeReduceOnlyMarketOrder

Parameters

Returns (tx: Transaction) => TransactionResult

Description

stake

Parameters

Returns (tx: Transaction) => void

Description

submitProposal

Parameters

Returns (tx: Transaction) => void

Description

unstake

Parameters

Returns (tx: Transaction) => void

Description

vote

Parameters

Returns (tx: Transaction) => void

Description

withdrawMarginSettledAmounts

Parameters

Returns (tx: Transaction) => void

Description

withdrawSettledAmounts

Parameters

Returns (tx: Transaction) => void

Description

Settings

On This Page