Class GovernanceBuilder

API Wrapper for GovernanceBuilder contract

Hierarchy

ContractAbi
- GovernanceBuilder

Implements

Builder

Index

Constructors

Properties

contract contractAbi contractAddress gas gasPriceGwei logger web3 ABI_NAME

Methods

aGovernance build discoverContract name version withCommunityClassAddress withDescription withName withSupervisor withUrl

Constructors

constructor

new GovernanceBuilder(abiPath, contractAddress, web3, wallet, gas, gasPriceGwei): GovernanceBuilder
Parameters
- abiPath: string
- contractAddress: string
- web3: default
- wallet: Wallet
- gas: number
- gasPriceGwei: string
Returns GovernanceBuilder
Overrides ContractAbi.constructor
- Defined in governance/governancebuilder.ts:47

Properties

contract

contract: Contract

`Protected` `Readonly` contractAbi

contractAbi: any[]

`Readonly` contractAddress

contractAddress: string

`Protected` `Readonly` gas

gas: number

`Protected` `Readonly` gasPriceGwei

gasPriceGwei: string

`Protected` `Readonly` logger

logger: Logger = ...

`Protected` `Readonly` web3

web3: default

`Static` ABI_NAME

ABI_NAME: string = 'GovernanceBuilder.json'

Methods

aGovernance

aGovernance(): Promise<Builder>
reset the governance builder to default state

Returns Promise<Builder>
Builder - this contract
Implementation of Builder.aGovernance
- Defined in governance/governancebuilder.ts:73

build

build(): Promise<string>
Build the contract with the configured settings.

Returns Promise<string>
string - The address of the newly created contract
Implementation of Builder.build
- Defined in governance/governancebuilder.ts:152

discoverContract

discoverContract(txId): Promise<ContractAddress>
Helper to discover the contract suite built by a previous invocation of this contract
Parameters
- txId: string
  
  The transaction bearing the build call
Returns Promise<ContractAddress>
ContractAddress - The set of contracts constructed by the build
Implementation of Builder.discoverContract
- Defined in governance/governancebuilder.ts:171

name

name(): Promise<string>
get the contract name

Returns Promise<string>
string - contract anme
Implementation of Builder.name
- Defined in governance/governancebuilder.ts:55

version

version(): Promise<number>
get the contract version

Returns Promise<number>
number - the version
Implementation of Builder.version
- Defined in governance/governancebuilder.ts:64

withCommunityClassAddress

withCommunityClassAddress(voterClass): Promise<Builder>
set the Community Class
Parameters
- voterClass: string
  
  the address of the CommunityClass contract
Returns Promise<Builder>
Builder - this contract
Implementation of Builder.withCommunityClassAddress
- Defined in governance/governancebuilder.ts:140

withDescription

withDescription(desc): Promise<Builder>
set the description on the contract
Parameters
- desc: string
  
  the description
Returns Promise<Builder>
Builder - this contract
Implementation of Builder.withDescription
- Defined in governance/governancebuilder.ts:113

withName

withName(name): Promise<Builder>
set the name for the community contract
Parameters
- name: string
  
  the community name
Returns Promise<Builder>
Builder - this contract
Implementation of Builder.withName
- Defined in governance/governancebuilder.ts:86

withSupervisor

withSupervisor(supervisor): Promise<Builder>
Add a community supervisor address to the project. It is okay to call this method more than once. Each supervisor is added.
Parameters
- supervisor: string
  
  address for the supervisor account
Returns Promise<Builder>
Builder - this contract
Implementation of Builder.withSupervisor
- Defined in governance/governancebuilder.ts:127

withUrl

withUrl(url): Promise<Builder>
set the url on the contract
Parameters
- url: string
  
  the community url
Returns Promise<Builder>
Builder - this contract
Implementation of Builder.withUrl
- Defined in governance/governancebuilder.ts:100

Generated using TypeDoc