Documentation
    Preparing search index...

    Class BalanceManagerContract

    BalanceManagerContract class for managing BalanceManager operations.

    Index

    Constructors

    constructor

    Methods

    balanceManagerReferralOwner balanceManagerReferralPoolId checkManagerBalance createAndShareBalanceManager createBalanceManagerWithOwner depositIntoManager depositWithCap generateProof generateProofAsOwner generateProofAsTrader getBalanceManagerReferralId id mintDepositCap mintTradeCap mintWithdrawalCap owner registerBalanceManager revokeTradeCap setBalanceManagerReferral shareBalanceManager unsetBalanceManagerReferral withdrawAllFromManager withdrawFromManager withdrawWithCap

    Constructors

    Methods

    • Parameters

      • referralId: string

        The ID of the referral to get the owner of

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Get the owner of the referral (DeepBookPoolReferral)

    • Parameters

      • referralId: string

        The ID of the referral to get the pool ID of

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Get the pool ID associated with a referral (DeepBookPoolReferral)

    • 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

      Check the balance of the BalanceManager

    • Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Create and share a new BalanceManager

    • Parameters

      • ownerAddress: string

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Create a new BalanceManager, manually set the owner. Returns the manager.

    • 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

      Deposit funds into the BalanceManager

    • 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

      Deposit using the DepositCap

    • Parameters

      • managerKey: string

        The key of the BalanceManager

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Generate a trade proof for the BalanceManager. Calls the appropriate function based on whether tradeCap is set.

    • Parameters

      • managerId: string

        The ID of the BalanceManager

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Generate a trade proof as the owner

    • 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

      Generate a trade proof as a trader

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      • poolKey: string

        Key of the pool to get the referral for

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Get the referral ID from the balance manager for a specific pool

    • Parameters

      • managerKey: string

        The key of the BalanceManager

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Get the ID of the BalanceManager

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Mint a DepositCap

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Mint a TradeCap

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Mint a WithdrawalCap

    • Parameters

      • managerKey: string

        The key of the BalanceManager

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Get the owner of the BalanceManager

    • Parameters

      • managerKey: string

      Returns (tx: Transaction) => void

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      • tradeCapId: string

        The ID of the TradeCap to revoke

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Revoke a TradeCap. This also revokes the associated DepositCap and WithdrawCap.

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      • referral: string

        The referral (DeepBookPoolReferral) to set the BalanceManager to

      • tradeCap: TransactionArgument

        The tradeCap for permission checking

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Set the referral for the BalanceManager for a specific pool

    • Parameters

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Share the BalanceManager

    • Parameters

      • managerKey: string

        The name of the BalanceManager

      • poolKey: string

        The key of the pool to unset the referral for

      • tradeCap: TransactionArgument

        The tradeCap for permission checking

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Unset the referral for the BalanceManager for a specific pool

    • 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

      Withdraw all funds from the BalanceManager

    • 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

      Withdraw funds from the BalanceManager

    • 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

      Withdraw using the WithdrawCap

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods