Interface Builder

Hierarchy

Builder

Implemented by

GovernanceBuilder

Index

Methods

aGovernance build discoverContract name version withCommunityClassAddress withDescription withName withSupervisor withUrl

Methods

aGovernance

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

Returns Promise<Builder>
Builder - this contract
- Defined in governance/builder.ts:61

build

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

Returns Promise<string>
string - The address of the newly created contract
- Defined in governance/builder.ts:109

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
- Defined in governance/builder.ts:117

name

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

Returns Promise<string>
string - contract anme
- Defined in governance/builder.ts:49

version

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

Returns Promise<number>
number - the version
- Defined in governance/builder.ts:55

withCommunityClassAddress

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

withDescription

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

withName

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

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
- Defined in governance/builder.ts:94

withUrl

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

Generated using TypeDoc