Interface CBuilder

Community Builder interface

Hierarchy

CBuilder

Implemented by

CommunityBuilder

Index

Methods

aCommunity asClosedErc721Community asErc721Community asOpenCommunity asPoolCommunity build name version withMaximumVoteDelay withMaximumVoteDuration withMinimumVoteDelay withMinimumVoteDuration withQuorum withVoter withWeight

Methods

aCommunity

aCommunity(): Promise<CBuilder>
reset the community class builder for this address

Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:54

asClosedErc721Community

asClosedErc721Community(project, tokenThreshold): Promise<CBuilder>
build Closed ERC-721 community
Parameters
- project: string
  
  the token contract address
- tokenThreshold: number
  
  the number of tokens required to propose
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:87

asErc721Community

asErc721Community(project): Promise<CBuilder>
build ERC-721 community
Parameters
- project: string
  
  the token contract address
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:77

asOpenCommunity

asOpenCommunity(): Promise<CBuilder>
build an open community

Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:61

asPoolCommunity

asPoolCommunity(): Promise<CBuilder>
build a pool community

Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:68

build

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

Returns Promise<string>
string - The address of the newly created contract
- Defined in community/cbuilder.ts:157

name

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

Returns Promise<string>
string - contract anme
- Defined in community/cbuilder.ts:42

version

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

Returns Promise<number>
number - the version
- Defined in community/cbuilder.ts:48

withMaximumVoteDelay

withMaximumVoteDelay(delay): Promise<CBuilder>
set the maximum vote delay for the community
Parameters
- delay: number
  
  maximum vote delay in Ethereum (epoch) seconds
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:132

withMaximumVoteDuration

withMaximumVoteDuration(duration): Promise<CBuilder>
set the maximum vote duration for the community
Parameters
- duration: number
  
  maximum vote duration in Ethereum (epoch) seconds
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:150

withMinimumVoteDelay

withMinimumVoteDelay(delay): Promise<CBuilder>
set the minimum vote delay for the community
Parameters
- delay: number
  
  minimum vote delay in Ethereum (epoch) seconds
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:123

withMinimumVoteDuration

withMinimumVoteDuration(duration): Promise<CBuilder>
set the minimum vote duration for the community
Parameters
- duration: number
  
  minimum vote duration in Ethereum (epoch) seconds
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:141

withQuorum

withQuorum(quorum): Promise<CBuilder>
set the minimum quorum for this community
Parameters
- quorum: number
  
  the minimum quorum
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:114

withVoter

withVoter(voter): Promise<CBuilder>
append a voter for a pool community
Parameters
- voter: string
  
  the wallet address
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:96

withWeight

withWeight(weight): Promise<CBuilder>
set the voting weight for each authorized voter
Parameters
- weight: number
  
  the voting weight
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/cbuilder.ts:105

Generated using TypeDoc