Class BalanceManagerContract

BalanceManagerContract class for managing BalanceManager operations.

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:148

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

createBalanceManagerWithOwner

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

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

createBalanceManagerWithOwnerAndCaps

createBalanceManagerWithOwnerAndCaps(
    ownerAddress: string,
): (
    tx: Transaction,
) => {
    depositCap: { $kind: "NestedResult"; NestedResult: [number, number] };
    manager: { $kind: "NestedResult"; NestedResult: [number, number] };
    tradeCap: { $kind: "NestedResult"; NestedResult: [number, number] };
    withdrawCap: { $kind: "NestedResult"; NestedResult: [number, number] };
}
Parameters
- ownerAddress: string
Returns (
    tx: Transaction,
) => {
    depositCap: { $kind: "NestedResult"; NestedResult: [number, number] };
    manager: { $kind: "NestedResult"; NestedResult: [number, number] };
    tradeCap: { $kind: "NestedResult"; NestedResult: [number, number] };
    withdrawCap: { $kind: "NestedResult"; NestedResult: [number, number] };
}
A function that takes a Transaction object

Description
Create a new BalanceManager, manually set the owner. Returns the manager, depositCap, withdrawCap, and tradeCap.
- Defined in deepbook-v3/src/transactions/balanceManager.ts:52

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:82

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:247

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:163

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:177

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:190

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:349

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:216

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:202

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:230

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:336

referralOwner

referralOwner(referral_id: string): (tx: Transaction) => TransactionResult
Parameters
- referral_id: string
  The ID of the referral to get the owner of
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

registerManager

registerManager(managerKey: string): (tx: Transaction) => void
Parameters
- managerKey: string
Returns (tx: Transaction) => void
- Defined in deepbook-v3/src/transactions/balanceManager.ts:323

setReferral

setReferral(
    managerKey: string,
    referral: string,
    tradeCap: TransactionArgument,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The name of the BalanceManager
- referral: string
  The referral to set the BalanceManager to
- tradeCap: TransactionArgument
  The tradeCap for permission checking
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Set the referral for the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:301

shareBalanceManager

shareBalanceManager(manager: TransactionArgument): (tx: Transaction) => void
Parameters
- manager: TransactionArgument
  The BalanceManager to share
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Share the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:66

unsetReferral

unsetReferral(
managerKey: string,
tradeCap: TransactionArgument,
): (tx: Transaction) => void
Parameters
- managerKey: string
  The name of the BalanceManager
- tradeCap: TransactionArgument
  The tradeCap for permission checking
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Unset the referral for the BalanceManager
- Defined in deepbook-v3/src/transactions/balanceManager.ts:315

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:130

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:108

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:276

Class BalanceManagerContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BalanceManagerContract

Methods

checkManagerBalance

Parameters

Returns (tx: Transaction) => void

Description

createAndShareBalanceManager

Returns (tx: Transaction) => void

Description

createBalanceManagerWithOwner

Parameters

Returns (tx: Transaction) => TransactionResult

Description

createBalanceManagerWithOwnerAndCaps

Parameters

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

referralOwner

Parameters

Returns (tx: Transaction) => TransactionResult

Description

registerManager

Parameters

Returns (tx: Transaction) => void

setReferral

Parameters

Returns (tx: Transaction) => void

Description

shareBalanceManager

Parameters

Returns (tx: Transaction) => void

Description

unsetReferral

Parameters