Class CommunityBuilder

CommunityBuilder implementation

Hierarchy

ContractAbi
- CommunityBuilder

Implements

CBuilder

Constructors

constructor

new CommunityBuilder(abiPath, contractAddress, web3, wallet, gas, gasPriceGwei): CommunityBuilder
Parameters
- abiPath: string
- contractAddress: string
- web3: default
- wallet: Wallet
- gas: number
- gasPriceGwei: string
Returns CommunityBuilder
Overrides ContractAbi.constructor
- Defined in community/communitybuilder.ts:48

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 = 'CommunityBuilder.json'

Methods

aCommunity

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

Returns Promise<CBuilder>
Builder - this contract
Implementation of CBuilder.aCommunity
- Defined in community/communitybuilder.ts:74

asClosedErc20Community

asClosedErc20Community(project, tokenThreshold): Promise<CBuilder>
build Closed ERC-20 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/communitybuilder.ts:156

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
Implementation of CBuilder.asClosedErc721Community
- Defined in community/communitybuilder.ts:127

asErc20Community

asErc20Community(project): Promise<CBuilder>
build ERC-20 community
Parameters
- project: string
  
  the token contract address
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/communitybuilder.ts:141

asErc721Community

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

asOpenCommunity

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

Returns Promise<CBuilder>
Builder - this contract
Implementation of CBuilder.asOpenCommunity
- Defined in community/communitybuilder.ts:86

asPoolCommunity

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

Returns Promise<CBuilder>
Builder - this contract
Implementation of CBuilder.asPoolCommunity
- Defined in community/communitybuilder.ts:98

build

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

Returns Promise<string>
string - The address of the newly created contract
Implementation of CBuilder.build
- Defined in community/communitybuilder.ts:280

name

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

Returns Promise<string>
string - contract anme
Implementation of CBuilder.name
- Defined in community/communitybuilder.ts:56

version

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

Returns Promise<number>
number - the version
Implementation of CBuilder.version
- Defined in community/communitybuilder.ts:65

withCommunitySupervisor

withCommunitySupervisor(supervisor): Promise<CBuilder>
append a community supervisor
Parameters
- supervisor: string
  
  the wallet address
Returns Promise<CBuilder>
Builder - this contract
- Defined in community/communitybuilder.ts:184

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
Implementation of CBuilder.withMaximumVoteDelay
- Defined in community/communitybuilder.ts:240

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
Implementation of CBuilder.withMaximumVoteDuration
- Defined in community/communitybuilder.ts:268

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
Implementation of CBuilder.withMinimumVoteDelay
- Defined in community/communitybuilder.ts:226

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
Implementation of CBuilder.withMinimumVoteDuration
- Defined in community/communitybuilder.ts:254

withQuorum

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

withVoter

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

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
Implementation of CBuilder.withWeight
- Defined in community/communitybuilder.ts:198

Generated using TypeDoc