Interface Governance

interface to Collective Governance contract

Hierarchy

  • Governance

Implemented by

Methods

abstainFrom abstainWithToken addChoice attachTransaction cancel configure configureWithDelay endVote isOpen name propose startVote version veto voteAgainst voteAgainstWithToken voteChoice voteFor voteForWithToken voteSucceeded

Methods

abstainFrom

  • abstain all shares

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

abstainWithToken

  • abstain for named token

    Parameters

    • proposalId: number

      The id of the vote

    • tokenId: number

    Returns Promise<void>

addChoice

  • 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>

    number The id of the added choice

attachTransaction

  • 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 a vote before it starts

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

configure

  • configure the specified vote

    Parameters

    • proposalId: number

      The id of the vote

    • quorum: number

      The minimum quorum for this vote

    Returns Promise<void>

configureWithDelay

  • 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

  • end voting

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

isOpen

  • 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

propose

  • propose a new vote

    Returns Promise<number>

    number - The id of the proposal

startVote

  • start voting

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

version

  • get the contract version

    Returns Promise<number>

    number - the version

veto

  • veto the specified proposal

    Parameters

    • proposalId: number

      The id to veto

    Returns Promise<void>

voteAgainst

  • vote against for all shares

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

voteAgainstWithToken

  • vote against with named token

    Parameters

    • proposalId: number

      The id of the vote

    • tokenId: number

      the id of the token

    Returns Promise<void>

voteChoice

  • 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

  • vote in favor

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<void>

voteForWithToken

  • 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

  • determine if the given vote succeeded

    Parameters

    • proposalId: number

      The id of the vote

    Returns Promise<boolean>

    boolean - True if the vote succeeded

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc