Class BalanceManagerContract

BalanceManagerContract class for managing BalanceManager operations.

Index

Constructors

Methods

checkManagerBalance createAndShareBalanceManager createAndShareBalanceManagerWithOwner depositIntoManager depositWithCap generateProof generateProofAsOwner generateProofAsTrader id mintDepositCap mintTradeCap mintWithdrawalCap owner withdrawAllFromManager withdrawFromManager withdrawWithCap

Constructors

constructor

new BalanceManagerContract(config: DeepBookConfig): BalanceManagerContract
Parameters
- config: DeepBookConfig
  Configuration for BalanceManagerContract
Returns BalanceManagerContract
- Defined in deepbook-v3/src/transactions/balanceManager.ts:17

Methods

checkManagerBalance

checkManagerBalance(
managerKey: string,
coinKey: string,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
- coinKey: string
  The key of the coin to check the balance of
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Check the balance of the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:128

createAndShareBalanceManager

createAndShareBalanceManager(): (tx: Transaction) => void
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Create and share a new BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:25

createAndShareBalanceManagerWithOwner

createAndShareBalanceManagerWithOwner(
ownerAddress: string,
): (tx: Transaction) => void
Parameters
- ownerAddress: string
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Create and share a new BalanceManager, manually set the owner
- Defined in deepbook-v3/src/transactions/balanceManager.ts:41

depositIntoManager

depositIntoManager(
    managerKey: string,
    coinKey: string,
    amountToDeposit: number,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
- coinKey: string
  The key of the coin to deposit
- amountToDeposit: number
  The amount to deposit
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit funds into the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:62

depositWithCap

depositWithCap(
    managerKey: string,
    coinKey: string,
    amountToDeposit: number,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The name of the BalanceManager
- coinKey: string
  The name of the coin to deposit
- amountToDeposit: number
  The amount to deposit
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Deposit using the DepositCap
- Defined in deepbook-v3/src/transactions/balanceManager.ts:227

generateProof

generateProof(managerKey: string): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The key of the BalanceManager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Generate a trade proof for the BalanceManager. Calls the appropriate function based on whether tradeCap is set.
- Defined in deepbook-v3/src/transactions/balanceManager.ts:143

generateProofAsOwner

generateProofAsOwner(managerId: string): (tx: Transaction) => TransactionResult
Parameters
- managerId: string
  The ID of the BalanceManager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Generate a trade proof as the owner
- Defined in deepbook-v3/src/transactions/balanceManager.ts:157

generateProofAsTrader

generateProofAsTrader(
managerId: string,
tradeCapId: string,
): (tx: Transaction) => TransactionResult
Parameters
- managerId: string
  The ID of the BalanceManager
- tradeCapId: string
  The ID of the tradeCap
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Generate a trade proof as a trader
- Defined in deepbook-v3/src/transactions/balanceManager.ts:170

id

id(managerKey: string): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the ID of the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:291

mintDepositCap

mintDepositCap(managerKey: string): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The name of the BalanceManager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a DepositCap
- Defined in deepbook-v3/src/transactions/balanceManager.ts:196

mintTradeCap

mintTradeCap(managerKey: string): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The name of the BalanceManager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a TradeCap
- Defined in deepbook-v3/src/transactions/balanceManager.ts:182

mintWithdrawalCap

mintWithdrawalCap(managerKey: string): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The name of the BalanceManager
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a WithdrawalCap
- Defined in deepbook-v3/src/transactions/balanceManager.ts:210

owner

owner(managerKey: string): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Get the owner of the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:278

withdrawAllFromManager

withdrawAllFromManager(
    managerKey: string,
    coinKey: string,
    recipient: string,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
- coinKey: string
  The key of the coin to withdraw
- recipient: string
  The recipient of the withdrawn funds
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw all funds from the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:110

withdrawFromManager

withdrawFromManager(
    managerKey: string,
    coinKey: string,
    amountToWithdraw: number,
    recipient: string,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The key of the BalanceManager
- coinKey: string
  The key of the coin to withdraw
- amountToWithdraw: number
  The amount to withdraw
- recipient: string
  The recipient of the withdrawn funds
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Withdraw funds from the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:88

withdrawWithCap

withdrawWithCap(
    managerKey: string,
    coinKey: string,
    amountToWithdraw: number,
): (tx: Transaction) => TransactionResult
Parameters
- managerKey: string
  The name of the BalanceManager
- coinKey: string
  The name of the coin to withdraw
- amountToWithdraw: number
  The amount to withdraw
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Withdraw using the WithdrawCap
- Defined in deepbook-v3/src/transactions/balanceManager.ts:256

Class BalanceManagerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BalanceManagerContract

Methods

checkManagerBalance

Parameters

Returns (tx: Transaction) => void

Description

createAndShareBalanceManager

Returns (tx: Transaction) => void

Description

createAndShareBalanceManagerWithOwner

Parameters

Returns (tx: Transaction) => void

Description

depositIntoManager

Parameters

Returns (tx: Transaction) => void

Description

depositWithCap

Parameters

Returns (tx: Transaction) => void

Description

generateProof

Parameters

Returns (tx: Transaction) => TransactionResult

Description

generateProofAsOwner

Parameters

Returns (tx: Transaction) => TransactionResult

Description

generateProofAsTrader

Parameters

Returns (tx: Transaction) => TransactionResult

Description

id

Parameters

Returns (tx: Transaction) => void

Description

mintDepositCap

Parameters

Returns (tx: Transaction) => TransactionResult

Description

mintTradeCap

Parameters

Returns (tx: Transaction) => TransactionResult

Description

mintWithdrawalCap

Parameters

Returns (tx: Transaction) => TransactionResult

Description

owner

Parameters

Returns (tx: Transaction) => void

Description

withdrawAllFromManager

Parameters

Returns (tx: Transaction) => void

Description

withdrawFromManager

Parameters

Returns (tx: Transaction) => void

Description

withdrawWithCap

Parameters

Returns (tx: Transaction) => TransactionResult

Description

Settings

On This Page