Class GovernanceContract

GovernanceContract class for managing governance operations in DeepBook.

Index

Constructors

Methods

stake submitProposal unstake vote

Constructors

constructor

new GovernanceContract(config: DeepBookConfig): GovernanceContract
Parameters
- config: DeepBookConfig
  Configuration for GovernanceContract
Returns GovernanceContract
- Defined in deepbook-v3/src/transactions/governance.ts:18

Methods

stake

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

Description
Stake a specified amount in the pool
- Defined in deepbook-v3/src/transactions/governance.ts:30

submitProposal

submitProposal(params: ProposalParams): (tx: Transaction) => void
Parameters
- params: ProposalParams
  Parameters for the proposal
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Submit a governance proposal
- Defined in deepbook-v3/src/transactions/governance.ts:75

unstake

unstake(poolKey: string, balanceManagerKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Unstake from the pool
- Defined in deepbook-v3/src/transactions/governance.ts:56

vote

vote(
    poolKey: string,
    balanceManagerKey: string,
    proposal_id: string,
): (tx: Transaction) => void
Parameters
- poolKey: string
  The key to identify the pool
- balanceManagerKey: string
  The key to identify the BalanceManager
- proposal_id: 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 deepbook-v3/src/transactions/governance.ts:105