Class ProposalBuilder

constructor

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

• Parameters

  • abiPath: string

  • contractAddress: string

  • web3: default

  • wallet: Wallet

  • gas: number

  • gasPriceGwei: string

  Returns ProposalBuilder

Static ABI_NAME

aProposal

• aProposal(): Promise<PBuilder>

• reset the proposal builder for this address

  Returns Promise<PBuilder>

  Builder - this contract

build

• build(): Promise<number>

• Build the proposal with the configured settings.

  Returns Promise<number>

  number - The proposal id of the created proposal

name

• name(): Promise<string>

• get the contract name

  Returns Promise<string>

  string - contract anme

version

• version(): Promise<number>

• get the contract version

  Returns Promise<number>

  number - the version

withChoice

• withChoice(name, description, transactionId): Promise<PBuilder>

• Add a choice to the proposal

  Parameters

  • name: string

    choice name

  • description: string

    choice description

  • transactionId: number

    id of transaction to execute for choice

  Returns Promise<PBuilder>

  Builder - this contract

withDelay

• withDelay(delay): Promise<PBuilder>

• set the delay for this proposal

  Parameters

  • delay: number

    the delay to start voting

  Returns Promise<PBuilder>

  Builder - this contract

withDescription

• withDescription(description, url): Promise<PBuilder>

• set the proposal description

  Parameters

  • description: string

  • url: string

  Returns Promise<PBuilder>

  Builder - this contract

withDuration

• withDuration(duration): Promise<PBuilder>

• set the duration for this proposal

  Parameters

  • duration: number

    the delay to start voting

  Returns Promise<PBuilder>

  Builder - this contract

withMeta

• withMeta(name, value): Promise<PBuilder>

• attach metadata to the proposal

  Parameters

  • name: string

    the name for metadata

  • value: string

    the value for metadata

  Returns Promise<PBuilder>

  Builder - this contract

withQuorum

• withQuorum(quorum): Promise<PBuilder>

• set the quorum required for this proposal

  Parameters

  • quorum: number

    the quorum required

  Returns Promise<PBuilder>

  Builder - this contract

withTransaction

• withTransaction(target, value, signature, _calldata, scheduleTime): Promise<PBuilder>

• Add a transaction to the proposal

  Parameters

  • target: string

    the address to execute

  • value: number

    the amount to transfer

  • signature: string

    the contract function signature

  • _calldata: string

    the calldata to pass to the executing signature

  • scheduleTime: number

    the time to execute the transaction

  Returns Promise<PBuilder>

  Builder - this contract