Class CollectiveGovernance

constructor

• new CollectiveGovernance(abiPath, contractAddress, web3, wallet, gas, gasPriceGwei): CollectiveGovernance

• Parameters

  • abiPath: string

  • contractAddress: string

  • web3: default

  • wallet: Wallet

  • gas: number

  • gasPriceGwei: string

  Returns CollectiveGovernance

Readonly contractAddress

Static ABI_NAME

Static STRAT_NAME

abstainFrom

• abstainFrom(proposalId): Promise<void>

• abstain all shares

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

abstainWithToken

• abstainWithToken(proposalId, tokenId): Promise<void>

• abstain for named token

  Parameters

  • proposalId: number

    The id of the vote

  • tokenId: number

  Returns Promise<void>

addChoice

• addChoice(proposalId, name, description, transactionId): Promise<number>

• set a choice for the choice vote

  Parameters

  • proposalId: number

    The id of the vote

  • name: string

    The name for the choice

  • description: string

    The choice description

  • transactionId: number

    The transaction id to associate with the choice. This transaction will execute if the given choice wins.

  Returns Promise<number>

attachTransaction

• attachTransaction(proposalId, target, value, signature, calldata, etaOfLock): Promise<number>

• attach a transaction to the vote

  Parameters

  • proposalId: number

    The id of the vote to attach to

  • target: string

    target address for the call

  • value: number

    value to be specified for the transaction, may be 0

  • signature: string

    function signature for the call

  • calldata: string

    abi encoded calldata for the transaction call

  • etaOfLock: number

    expected time when execution will be triggered for this transaction

  Returns Promise<number>

  number - The id of the attached transaction

cancel

• cancel(proposalId): Promise<void>

• cancel a vote before it starts

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

configure

• configure(proposalId, quorum): Promise<void>

• configure the specified vote

  Parameters

  • proposalId: number

    The id of the vote

  • quorum: number

    The minimum quorum for this vote

  Returns Promise<void>

configureWithDelay

• configureWithDelay(proposalId, quorum, requiredDelay, requiredDuration): Promise<void>

• configure a vote with delay settings

  Parameters

  • proposalId: number

    The id of the vote

  • quorum: number

    The minimum quorum for the vote

  • requiredDelay: number

    The minimum required vote delay

  • requiredDuration: number

    The minimum required vote duration

  Returns Promise<void>

endVote

• endVote(proposalId): Promise<void>

• end voting

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

isOpen

• isOpen(proposalId): Promise<boolean>

• get the status of a given vote

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<boolean>

  boolean - True if vote is open

name

• name(): Promise<string>

• get the contract name

  Returns Promise<string>

  string - contract anme

propose

• propose(): Promise<number>

• propose a new vote

  Returns Promise<number>

  number - The id of the proposal

startVote

• startVote(proposalId): Promise<void>

• start voting

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

version

• version(): Promise<number>

• get the contract version

  Returns Promise<number>

  number - the version

veto

• veto(proposalId): Promise<void>

• veto the specified proposal

  Parameters

  • proposalId: number

    The id to veto

  Returns Promise<void>

voteAgainst

• voteAgainst(proposalId): Promise<void>

• vote against for all shares

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

voteAgainstWithToken

• voteAgainstWithToken(proposalId, tokenId): Promise<void>

• vote against with named token

  Parameters

  • proposalId: number

    The id of the vote

  • tokenId: number

    the id of the token

  Returns Promise<void>

voteChoice

• voteChoice(proposalId, choiceId): Promise<void>

• vote in favor with all shares

  Parameters

  • proposalId: number

    the id of the choice vote

  • choiceId: number

    the id of the choice on the vote

  Returns Promise<void>

voteFor

• voteFor(proposalId): Promise<void>

• vote in favor

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<void>

voteForWithToken

• voteForWithToken(proposalId, tokenId): Promise<void>

• vote in favor with the named token

  Parameters

  • proposalId: number

    The id of the vote

  • tokenId: number

    the id of the token

  Returns Promise<void>

voteSucceeded

• voteSucceeded(proposalId): Promise<boolean>

• determine if the given vote succeeded

  Parameters

  • proposalId: number

    The id of the vote

  Returns Promise<boolean>

  boolean - True if the vote succeeded