Skip to main content

Interface: VotingReputationClientV3

Hierarchy​

  • AugmentedVotingReputation<VotingReputation>

  • AugmentsV2<VotingReputation>

  • CreateDomainMotionAugments<VotingReputation>

    ↳ VotingReputationClientV3

Properties​

_deployedPromise​

• _deployedPromise: Promise<Contract>

Inherited from​

AugmentedVotingReputation._deployedPromise


_runningEvents​

• _runningEvents: Object

Index signature​

▪ [eventTag: string]: RunningEvent

Inherited from​

AugmentedVotingReputation._runningEvents


_wrappedEmits​

• _wrappedEmits: Object

Index signature​

▪ [eventTag: string]: (...args: any[]) => void

Inherited from​

AugmentedVotingReputation._wrappedEmits


address​

• Readonly address: string

Inherited from​

AugmentedVotingReputation.address


callStatic​

• callStatic: Object

Type declaration​

NameType
authority(overrides?: CallOverrides) => Promise<string>
authority()(overrides?: CallOverrides) => Promise<string>
claimReward(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<void>
claimReward(uint256,uint256,uint256,address,uint256)(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<void>
createClaimDelayAction(action: BytesLike, value: BigNumberish, overrides?: CallOverrides) => Promise<string>
createClaimDelayAction(bytes,uint256)(action: BytesLike, value: BigNumberish, overrides?: CallOverrides) => Promise<string>
createDomainMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
createMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
createRootMotion(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
deprecate(bool)(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
escalateMotion(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
failingExecutionAllowed(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
failingExecutionAllowed(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
finalizeMotion(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<void>
finalizeMotion(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<void>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
finishUpgrade()(overrides?: CallOverrides) => Promise<void>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getColony(overrides?: CallOverrides) => Promise<string>
getColony()(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getDeprecated()(overrides?: CallOverrides) => Promise<boolean>
getEscalationPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getEscalationPeriod()(overrides?: CallOverrides) => Promise<BigNumber>
getExpenditureMotionCount(_structHash: BytesLike, overrides?: CallOverrides) => Promise<BigNumber>
getExpenditureMotionCount(bytes32)(_structHash: BytesLike, overrides?: CallOverrides) => Promise<BigNumber>
getExpenditurePastVote(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<BigNumber>
getExpenditurePastVote(bytes32)(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<BigNumber>
getMaxVoteFraction(overrides?: CallOverrides) => Promise<BigNumber>
getMaxVoteFraction()(overrides?: CallOverrides) => Promise<BigNumber>
getMotion(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<MotionStructOutput>
getMotion(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<MotionStructOutput>
getMotionCount(overrides?: CallOverrides) => Promise<BigNumber>
getMotionCount()(overrides?: CallOverrides) => Promise<BigNumber>
getMotionState(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<number>
getMotionState(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<number>
getRevealPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getRevealPeriod()(overrides?: CallOverrides) => Promise<BigNumber>
getStake(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
getStake(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
getStakePeriod(overrides?: CallOverrides) => Promise<BigNumber>
getStakePeriod()(overrides?: CallOverrides) => Promise<BigNumber>
getStakerReward(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getStakerReward(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getSubmitPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getSubmitPeriod()(overrides?: CallOverrides) => Promise<BigNumber>
getTotalStakeFraction(overrides?: CallOverrides) => Promise<BigNumber>
getTotalStakeFraction()(overrides?: CallOverrides) => Promise<BigNumber>
getUserMinStakeFraction(overrides?: CallOverrides) => Promise<BigNumber>
getUserMinStakeFraction()(overrides?: CallOverrides) => Promise<BigNumber>
getVoterReward(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
getVoterReward(uint256,uint256)(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
getVoterRewardFraction(overrides?: CallOverrides) => Promise<BigNumber>
getVoterRewardFraction()(overrides?: CallOverrides) => Promise<BigNumber>
getVoterRewardRange(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getVoterRewardRange(uint256,uint256,address)(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
identifier(overrides?: CallOverrides) => Promise<string>
identifier()(overrides?: CallOverrides) => Promise<string>
initialise(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: CallOverrides) => Promise<void>
initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: CallOverrides) => Promise<void>
install(_colony: string, overrides?: CallOverrides) => Promise<void>
install(address)(_colony: string, overrides?: CallOverrides) => Promise<void>
owner(overrides?: CallOverrides) => Promise<string>
owner()(overrides?: CallOverrides) => Promise<string>
revealVote(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setAuthority(address)(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
setOwner(address)(owner_: string, overrides?: CallOverrides) => Promise<void>
stakeMotion(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
submitVote(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
uninstall()(overrides?: CallOverrides) => Promise<void>
version(overrides?: CallOverrides) => Promise<BigNumber>
version()(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.callStatic


clientType​

• clientType: VotingReputationClient

Inherited from​

AugmentedVotingReputation.clientType


clientVersion​

• clientVersion: 3

Overrides​

AugmentedVotingReputation.clientVersion


colonyClient​

• colonyClient: AugmentedIColony

An instance of the corresponding ColonyClient

Inherited from​

AugmentedVotingReputation.colonyClient


deployTransaction​

• Readonly deployTransaction: TransactionResponse

Inherited from​

AugmentedVotingReputation.deployTransaction


estimateGas​

• estimateGas: VotingReputationEstimate

Overrides​

AugmentedVotingReputation.estimateGas


filters​

• filters: Object

Type declaration​

NameType
ExtensionInitialised() => ExtensionInitialisedEventFilter
ExtensionInitialised()() => ExtensionInitialisedEventFilter
LogSetAuthority(authority?: null | string) => LogSetAuthorityEventFilter
LogSetAuthority(address)(authority?: null | string) => LogSetAuthorityEventFilter
LogSetOwner(owner?: null | string) => LogSetOwnerEventFilter
LogSetOwner(address)(owner?: null | string) => LogSetOwnerEventFilter
MotionCreated(motionId?: null | BigNumberish, creator?: null, domainId?: null | BigNumberish) => MotionCreatedEventFilter
MotionCreated(uint256,address,uint256)(motionId?: null | BigNumberish, creator?: null, domainId?: null | BigNumberish) => MotionCreatedEventFilter
MotionEscalated(motionId?: null | BigNumberish, escalator?: null, domainId?: null | BigNumberish, newDomainId?: null | BigNumberish) => MotionEscalatedEventFilter
MotionEscalated(uint256,address,uint256,uint256)(motionId?: null | BigNumberish, escalator?: null, domainId?: null | BigNumberish, newDomainId?: null | BigNumberish) => MotionEscalatedEventFilter
MotionEventSet(motionId?: null | BigNumberish, eventIndex?: null) => MotionEventSetEventFilter
MotionEventSet(uint256,uint256)(motionId?: null | BigNumberish, eventIndex?: null) => MotionEventSetEventFilter
MotionFinalized(motionId?: null | BigNumberish, action?: null, executed?: null) => MotionFinalizedEventFilter
MotionFinalized(uint256,bytes,bool)(motionId?: null | BigNumberish, action?: null, executed?: null) => MotionFinalizedEventFilter
MotionRewardClaimed(motionId?: null | BigNumberish, staker?: null | string, vote?: null | BigNumberish, amount?: null) => MotionRewardClaimedEventFilter
MotionRewardClaimed(uint256,address,uint256,uint256)(motionId?: null | BigNumberish, staker?: null | string, vote?: null | BigNumberish, amount?: null) => MotionRewardClaimedEventFilter
MotionStaked(motionId?: null | BigNumberish, staker?: null | string, vote?: null | BigNumberish, amount?: null) => MotionStakedEventFilter
MotionStaked(uint256,address,uint256,uint256)(motionId?: null | BigNumberish, staker?: null | string, vote?: null | BigNumberish, amount?: null) => MotionStakedEventFilter
MotionVoteRevealed(motionId?: null | BigNumberish, voter?: null | string, vote?: null | BigNumberish) => MotionVoteRevealedEventFilter
MotionVoteRevealed(uint256,address,uint256)(motionId?: null | BigNumberish, voter?: null | string, vote?: null | BigNumberish) => MotionVoteRevealedEventFilter
MotionVoteSubmitted(motionId?: null | BigNumberish, voter?: null | string) => MotionVoteSubmittedEventFilter
MotionVoteSubmitted(uint256,address)(motionId?: null | BigNumberish, voter?: null | string) => MotionVoteSubmittedEventFilter

Inherited from​

AugmentedVotingReputation.filters


functions​

• functions: Object

Type declaration​

NameType
authority(overrides?: CallOverrides) => Promise<[string]>
authority()(overrides?: CallOverrides) => Promise<[string]>
claimReward(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
claimReward(uint256,uint256,uint256,address,uint256)(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createClaimDelayAction(action: BytesLike, value: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createClaimDelayAction(bytes,uint256)(action: BytesLike, value: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createDomainMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createRootMotion(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
escalateMotion(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
failingExecutionAllowed(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
failingExecutionAllowed(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
finalizeMotion(_motionId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finalizeMotion(uint256)(_motionId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getColony()(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getDeprecated()(overrides?: CallOverrides) => Promise<[boolean]>
getEscalationPeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getEscalationPeriod()(overrides?: CallOverrides) => Promise<[BigNumber]>
getExpenditureMotionCount(_structHash: BytesLike, overrides?: CallOverrides) => Promise<[BigNumber]>
getExpenditureMotionCount(bytes32)(_structHash: BytesLike, overrides?: CallOverrides) => Promise<[BigNumber]>
getExpenditurePastVote(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<[BigNumber]>
getExpenditurePastVote(bytes32)(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<[BigNumber]>
getMaxVoteFraction(overrides?: CallOverrides) => Promise<[BigNumber]>
getMaxVoteFraction()(overrides?: CallOverrides) => Promise<[BigNumber]>
getMotion(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[MotionStructOutput] & { motion: MotionStructOutput }>
getMotion(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[MotionStructOutput] & { motion: MotionStructOutput }>
getMotionCount(overrides?: CallOverrides) => Promise<[BigNumber]>
getMotionCount()(overrides?: CallOverrides) => Promise<[BigNumber]>
getMotionState(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[number]>
getMotionState(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<[number]>
getRevealPeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getRevealPeriod()(overrides?: CallOverrides) => Promise<[BigNumber]>
getStake(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
getStake(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
getStakePeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getStakePeriod()(overrides?: CallOverrides) => Promise<[BigNumber]>
getStakerReward(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getStakerReward(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getSubmitPeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getSubmitPeriod()(overrides?: CallOverrides) => Promise<[BigNumber]>
getTotalStakeFraction(overrides?: CallOverrides) => Promise<[BigNumber]>
getTotalStakeFraction()(overrides?: CallOverrides) => Promise<[BigNumber]>
getUserMinStakeFraction(overrides?: CallOverrides) => Promise<[BigNumber]>
getUserMinStakeFraction()(overrides?: CallOverrides) => Promise<[BigNumber]>
getVoterReward(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
getVoterReward(uint256,uint256)(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<[BigNumber]>
getVoterRewardFraction(overrides?: CallOverrides) => Promise<[BigNumber]>
getVoterRewardFraction()(overrides?: CallOverrides) => Promise<[BigNumber]>
getVoterRewardRange(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
getVoterRewardRange(uint256,uint256,address)(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]>
identifier(overrides?: CallOverrides) => Promise<[string]>
identifier()(overrides?: CallOverrides) => Promise<[string]>
initialise(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
owner()(overrides?: CallOverrides) => Promise<[string]>
revealVote(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
stakeMotion(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
submitVote(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
version(overrides?: CallOverrides) => Promise<[BigNumber]>
version()(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from​

AugmentedVotingReputation.functions


interface​

• interface: VotingReputationInterface

Inherited from​

AugmentedVotingReputation.interface


off​

• off: OnEvent<VotingReputationClientV3>

Inherited from​

AugmentedVotingReputation.off


on​

• on: OnEvent<VotingReputationClientV3>

Inherited from​

AugmentedVotingReputation.on


once​

• once: OnEvent<VotingReputationClientV3>

Inherited from​

AugmentedVotingReputation.once


populateTransaction​

• populateTransaction: Object

Type declaration​

NameType
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
authority()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
claimReward(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
claimReward(uint256,uint256,uint256,address,uint256)(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createClaimDelayAction(action: BytesLike, value: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createClaimDelayAction(bytes,uint256)(action: BytesLike, value: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createDomainMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createMotion(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])(_domainId: BigNumberish, _childSkillIndex: BigNumberish, _altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createRootMotion(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])(_altTarget: string, _action: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
escalateMotion(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _newDomainId: BigNumberish, _childSkillIndex: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
failingExecutionAllowed(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
failingExecutionAllowed(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
finalizeMotion(_motionId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finalizeMotion(uint256)(_motionId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getEscalationPeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getEscalationPeriod()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getExpenditureMotionCount(_structHash: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getExpenditureMotionCount(bytes32)(_structHash: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getExpenditurePastVote(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getExpenditurePastVote(bytes32)(_actionHash: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMaxVoteFraction(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMaxVoteFraction()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotion(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotion(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotionCount(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotionCount()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotionState(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMotionState(uint256)(_motionId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getRevealPeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getRevealPeriod()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStake(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStake(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStakePeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStakePeriod()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStakerReward(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStakerReward(uint256,address,uint256)(_motionId: BigNumberish, _staker: string, _vote: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSubmitPeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSubmitPeriod()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTotalStakeFraction(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTotalStakeFraction()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUserMinStakeFraction(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUserMinStakeFraction()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterReward(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterReward(uint256,uint256)(_motionId: BigNumberish, _voterRep: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterRewardFraction(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterRewardFraction()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterRewardRange(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getVoterRewardRange(uint256,uint256,address)(_motionId: BigNumberish, _voterRep: BigNumberish, _voterAddress: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)(_totalStakeFraction: BigNumberish, _voterRewardFraction: BigNumberish, _userMinStakeFraction: BigNumberish, _maxVoteFraction: BigNumberish, _stakePeriod: BigNumberish, _submitPeriod: BigNumberish, _revealPeriod: BigNumberish, _escalationPeriod: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
revealVote(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _salt: BytesLike, _vote: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
stakeMotion(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _vote: BigNumberish, _amount: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
submitVote(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])(_motionId: BigNumberish, _voteSecret: BytesLike, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>
version()(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from​

AugmentedVotingReputation.populateTransaction


provider​

• Readonly provider: Provider

Inherited from​

AugmentedVotingReputation.provider


removeListener​

• removeListener: OnEvent<VotingReputationClientV3>

Inherited from​

AugmentedVotingReputation.removeListener


resolvedAddress​

• Readonly resolvedAddress: Promise<string>

Inherited from​

AugmentedVotingReputation.resolvedAddress


signer​

• Readonly signer: Signer

Inherited from​

AugmentedVotingReputation.signer


votingReputationEvents​

• votingReputationEvents: VotingReputationEvents

The votingReputationsEvents contract supports all events across all versions. Isn't that amazing? It's an ethers contract with only events to filter

Inherited from​

AugmentedVotingReputation.votingReputationEvents

Methods​

_checkRunningEvents​

▸ _checkRunningEvents(runningEvent): void

Parameters​

NameType
runningEventRunningEvent

Returns​

void

Inherited from​

AugmentedVotingReputation._checkRunningEvents


_deployed​

▸ _deployed(blockTag?): Promise<Contract>

Parameters​

NameType
blockTag?BlockTag

Returns​

Promise<Contract>

Inherited from​

AugmentedVotingReputation._deployed


_wrapEvent​

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters​

NameType
runningEventRunningEvent
logLog
listenerListener

Returns​

Event

Inherited from​

AugmentedVotingReputation._wrapEvent


attach​

▸ attach(addressOrName): VotingReputationClientV3

Parameters​

NameType
addressOrNamestring

Returns​

VotingReputationClientV3

Inherited from​

AugmentedVotingReputation.attach


authority​

▸ authority(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.authority


authority()​

▸ authority()(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.authority()


claimReward​

▸ claimReward(_motionId, _permissionDomainId, _childSkillIndex, _staker, _vote, overrides?): Promise<ContractTransaction>

Claim the staker's reward

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_permissionDomainIdBigNumberishThe domain where the extension has the arbitration permission
_childSkillIndexBigNumberishFor the domain in which the motion is occurring
_stakerstringThe staker whose reward is being claimed
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.claimReward


claimReward(uint256,uint256,uint256,address,uint256)​

▸ claimReward(uint256,uint256,uint256,address,uint256)(_motionId, _permissionDomainId, _childSkillIndex, _staker, _vote, overrides?): Promise<ContractTransaction>

Claim the staker's reward

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_permissionDomainIdBigNumberishThe domain where the extension has the arbitration permission
_childSkillIndexBigNumberishFor the domain in which the motion is occurring
_stakerstringThe staker whose reward is being claimed
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.claimReward(uint256,uint256,uint256,address,uint256)


claimRewardWithProofs​

▸ claimRewardWithProofs(_motionId, _staker, _vote, overrides?): Promise<ContractTransaction>

Same as claimReward, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_stakerstringThe staker whose reward is being claimed
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
overrides?TxOverrides-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.claimRewardWithProofs


connect​

▸ connect(signerOrProvider): VotingReputationClientV3

Parameters​

NameType
signerOrProviderstring | Signer | Provider

Returns​

VotingReputationClientV3

Inherited from​

AugmentedVotingReputation.connect


createClaimDelayAction​

▸ createClaimDelayAction(action, value, overrides?): Promise<ContractTransaction>

Parameters​

NameType
actionBytesLike
valueBigNumberish
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createClaimDelayAction


createClaimDelayAction(bytes,uint256)​

▸ createClaimDelayAction(bytes,uint256)(action, value, overrides?): Promise<ContractTransaction>

Parameters​

NameType
actionBytesLike
valueBigNumberish
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createClaimDelayAction(bytes,uint256)


createDomainMotion​

▸ createDomainMotion(_domainId, _childSkillIndex, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion in any domain (DEPRECATED)

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_childSkillIndexBigNumberishThe childSkillIndex pointing to the domain of the action
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the domain
_valueBytesLikeReputation tree value for the domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createDomainMotion


createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])​

▸ createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])(_domainId, _childSkillIndex, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion in any domain (DEPRECATED)

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_childSkillIndexBigNumberishThe childSkillIndex pointing to the domain of the action
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the domain
_valueBytesLikeReputation tree value for the domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createDomainMotion(uint256,uint256,bytes,bytes,bytes,uint256,bytes32[])


createDomainMotionWithProofs​

▸ createDomainMotionWithProofs(_domainId, _action, overrides?): Promise<ContractTransaction>

Deprecated

Same as createDomainMotion, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_actionBytesLikeA bytes array encoding a function call
overrides?TxOverrides-

Returns​

Promise<ContractTransaction>

Inherited from​

CreateDomainMotionAugments.createDomainMotionWithProofs


createMotion​

▸ createMotion(_domainId, _childSkillIndex, _altTarget, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_childSkillIndexBigNumberishThe childSkillIndex pointing to the domain of the action
_altTargetstringThe contract to which we send the action (0x0 for the colony)
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the root domain
_valueBytesLikeReputation tree value for the root domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createMotion


createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])​

▸ createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])(_domainId, _childSkillIndex, _altTarget, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_childSkillIndexBigNumberishThe childSkillIndex pointing to the domain of the action
_altTargetstringThe contract to which we send the action (0x0 for the colony)
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the root domain
_valueBytesLikeReputation tree value for the root domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createMotion(uint256,uint256,address,bytes,bytes,bytes,uint256,bytes32[])


createMotionWithProofs​

▸ createMotionWithProofs(_domainId, _altTarget, _action, overrides?): Promise<ContractTransaction>

Same as createMotion, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters​

NameTypeDescription
_domainIdBigNumberishThe domain where we vote on the motion
_altTargetstringThe contract to which we send the action (0x0 for the colony)
_actionBytesLikeA bytes array encoding a function call
overrides?TxOverrides-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentsV2.createMotionWithProofs


createRootMotion​

▸ createRootMotion(_altTarget, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion in the root domain (DEPRECATED)

Parameters​

NameTypeDescription
_altTargetstringThe contract to which we send the action (0x0 for the colony)
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the root domain
_valueBytesLikeReputation tree value for the root domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createRootMotion


createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])​

▸ createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])(_altTarget, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Create a motion in the root domain (DEPRECATED)

Parameters​

NameTypeDescription
_altTargetstringThe contract to which we send the action (0x0 for the colony)
_actionBytesLikeA bytes array encoding a function call
_keyBytesLikeReputation tree key for the root domain
_valueBytesLikeReputation tree value for the root domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.createRootMotion(address,bytes,bytes,bytes,uint256,bytes32[])


deployed​

▸ deployed(): Promise<VotingReputationClientV3>

Returns​

Promise<VotingReputationClientV3>

Inherited from​

AugmentedVotingReputation.deployed


deprecate​

▸ deprecate(_deprecated, overrides?): Promise<ContractTransaction>

Called when deprecating (or undeprecating) the extension

Parameters​

NameType
_deprecatedboolean
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.deprecate


deprecate(bool)​

▸ deprecate(bool)(_deprecated, overrides?): Promise<ContractTransaction>

Called when deprecating (or undeprecating) the extension

Parameters​

NameType
_deprecatedboolean
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.deprecate(bool)


emit​

▸ emit(eventName, ...args): boolean

Parameters​

NameType
eventNamestring | EventFilter
...argsany[]

Returns​

boolean

Inherited from​

AugmentedVotingReputation.emit


escalateMotion​

▸ escalateMotion(_motionId, _newDomainId, _childSkillIndex, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Escalate a motion to a higher domain

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_newDomainIdBigNumberishThe desired domain of escalation
_childSkillIndexBigNumberishFor the current domain, relative to the escalated domain
_keyBytesLikeReputation tree key for the new domain
_valueBytesLikeReputation tree value for the new domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.escalateMotion


escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])​

▸ escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId, _newDomainId, _childSkillIndex, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Escalate a motion to a higher domain

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_newDomainIdBigNumberishThe desired domain of escalation
_childSkillIndexBigNumberishFor the current domain, relative to the escalated domain
_keyBytesLikeReputation tree key for the new domain
_valueBytesLikeReputation tree value for the new domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.escalateMotion(uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])


escalateMotionWithProofs​

▸ escalateMotionWithProofs(_motionId, _newDomainId, overrides?): Promise<ContractTransaction>

Same as escalateMotion, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_newDomainIdBigNumberishThe desired domain of escalation
overrides?TxOverrides-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.escalateMotionWithProofs


failingExecutionAllowed​

▸ failingExecutionAllowed(_motionId, overrides?): Promise<boolean>

We are only expecting this to be called from finalize motion in the contracts. It is marked as public only so that the frontend can use it.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
overrides?CallOverrides-

Returns​

Promise<boolean>

Inherited from​

AugmentedVotingReputation.failingExecutionAllowed


failingExecutionAllowed(uint256)​

▸ failingExecutionAllowed(uint256)(_motionId, overrides?): Promise<boolean>

We are only expecting this to be called from finalize motion in the contracts. It is marked as public only so that the frontend can use it.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
overrides?CallOverrides-

Returns​

Promise<boolean>

Inherited from​

AugmentedVotingReputation.failingExecutionAllowed(uint256)


fallback​

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters​

NameType
overrides?TransactionRequest

Returns​

Promise<TransactionResponse>

Inherited from​

AugmentedVotingReputation.fallback


finalizeMotion​

▸ finalizeMotion(_motionId, overrides?): Promise<ContractTransaction>

Parameters​

NameType
_motionIdBigNumberish
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.finalizeMotion


finalizeMotion(uint256)​

▸ finalizeMotion(uint256)(_motionId, overrides?): Promise<ContractTransaction>

Parameters​

NameType
_motionIdBigNumberish
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.finalizeMotion(uint256)


finishUpgrade​

▸ finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters​

NameType
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.finishUpgrade


finishUpgrade()​

▸ finishUpgrade()(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters​

NameType
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.finishUpgrade()


getCapabilityRoles​

▸ getCapabilityRoles(_sig, overrides?): Promise<string>

Parameters​

NameType
_sigBytesLike
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.getCapabilityRoles


getCapabilityRoles(bytes4)​

▸ getCapabilityRoles(bytes4)(_sig, overrides?): Promise<string>

Parameters​

NameType
_sigBytesLike
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.getCapabilityRoles(bytes4)


getColony​

▸ getColony(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.getColony


getColony()​

▸ getColony()(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.getColony()


getDeprecated​

▸ getDeprecated(overrides?): Promise<boolean>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<boolean>

Inherited from​

AugmentedVotingReputation.getDeprecated


getDeprecated()​

▸ getDeprecated()(overrides?): Promise<boolean>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<boolean>

Inherited from​

AugmentedVotingReputation.getDeprecated()


getEscalationPeriod​

▸ getEscalationPeriod(overrides?): Promise<BigNumber>

Get the escalation period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getEscalationPeriod


getEscalationPeriod()​

▸ getEscalationPeriod()(overrides?): Promise<BigNumber>

Get the escalation period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getEscalationPeriod()


getExpenditureMotionCount​

▸ getExpenditureMotionCount(_structHash, overrides?): Promise<BigNumber>

Get the number of ongoing motions for a single expenditure / expenditure slot

Parameters​

NameTypeDescription
_structHashBytesLikeThe hash of the expenditureId or expenditureId*expenditureSlot
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getExpenditureMotionCount


getExpenditureMotionCount(bytes32)​

▸ getExpenditureMotionCount(bytes32)(_structHash, overrides?): Promise<BigNumber>

Get the number of ongoing motions for a single expenditure / expenditure slot

Parameters​

NameTypeDescription
_structHashBytesLikeThe hash of the expenditureId or expenditureId*expenditureSlot
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getExpenditureMotionCount(bytes32)


getExpenditurePastVote​

▸ getExpenditurePastVote(_actionHash, overrides?): Promise<BigNumber>

Get the largest past vote on a single expenditure variable

Parameters​

NameTypeDescription
_actionHashBytesLikeThe hash of the particular expenditure action
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getExpenditurePastVote


getExpenditurePastVote(bytes32)​

▸ getExpenditurePastVote(bytes32)(_actionHash, overrides?): Promise<BigNumber>

Get the largest past vote on a single expenditure variable

Parameters​

NameTypeDescription
_actionHashBytesLikeThe hash of the particular expenditure action
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getExpenditurePastVote(bytes32)


getMaxVoteFraction​

▸ getMaxVoteFraction(overrides?): Promise<BigNumber>

Get the max vote fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getMaxVoteFraction


getMaxVoteFraction()​

▸ getMaxVoteFraction()(overrides?): Promise<BigNumber>

Get the max vote fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getMaxVoteFraction()


getMotion​

▸ getMotion(_motionId, overrides?): Promise<MotionStructOutput>

Get the data for a single motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
overrides?CallOverrides-

Returns​

Promise<MotionStructOutput>

Inherited from​

AugmentedVotingReputation.getMotion


getMotion(uint256)​

▸ getMotion(uint256)(_motionId, overrides?): Promise<MotionStructOutput>

Get the data for a single motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
overrides?CallOverrides-

Returns​

Promise<MotionStructOutput>

Inherited from​

AugmentedVotingReputation.getMotion(uint256)


getMotionCount​

▸ getMotionCount(overrides?): Promise<BigNumber>

Get the total motion count

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getMotionCount


getMotionCount()​

▸ getMotionCount()(overrides?): Promise<BigNumber>

Get the total motion count

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getMotionCount()


getMotionState​

▸ getMotionState(_motionId, overrides?): Promise<number>

Get the current state of the motion

Parameters​

NameType
_motionIdBigNumberish
overrides?CallOverrides

Returns​

Promise<number>

Inherited from​

AugmentedVotingReputation.getMotionState


getMotionState(uint256)​

▸ getMotionState(uint256)(_motionId, overrides?): Promise<number>

Get the current state of the motion

Parameters​

NameType
_motionIdBigNumberish
overrides?CallOverrides

Returns​

Promise<number>

Inherited from​

AugmentedVotingReputation.getMotionState(uint256)


getRevealPeriod​

▸ getRevealPeriod(overrides?): Promise<BigNumber>

Get the reveal period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getRevealPeriod


getRevealPeriod()​

▸ getRevealPeriod()(overrides?): Promise<BigNumber>

Get the reveal period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getRevealPeriod()


getStake​

▸ getStake(_motionId, _staker, _vote, overrides?): Promise<BigNumber>

Get a user's stake on a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_stakerstringThe staker address
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getStake


getStake(uint256,address,uint256)​

▸ getStake(uint256,address,uint256)(_motionId, _staker, _vote, overrides?): Promise<BigNumber>

Get a user's stake on a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_stakerstringThe staker address
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getStake(uint256,address,uint256)


getStakePeriod​

▸ getStakePeriod(overrides?): Promise<BigNumber>

Get the stake period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getStakePeriod


getStakePeriod()​

▸ getStakePeriod()(overrides?): Promise<BigNumber>

Get the stake period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getStakePeriod()


getStakerReward​

▸ getStakerReward(_motionId, _staker, _vote, overrides?): Promise<[BigNumber, BigNumber]>

Get the staker reward

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_stakerstringThe staker's address
_voteBigNumberishThe vote (0 = NAY, 1 = YAY)
overrides?CallOverrides-

Returns​

Promise<[BigNumber, BigNumber]>

Inherited from​

AugmentedVotingReputation.getStakerReward


getStakerReward(uint256,address,uint256)​

▸ getStakerReward(uint256,address,uint256)(_motionId, _staker, _vote, overrides?): Promise<[BigNumber, BigNumber]>

Get the staker reward

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_stakerstringThe staker's address
_voteBigNumberishThe vote (0 = NAY, 1 = YAY)
overrides?CallOverrides-

Returns​

Promise<[BigNumber, BigNumber]>

Inherited from​

AugmentedVotingReputation.getStakerReward(uint256,address,uint256)


getSubmitPeriod​

▸ getSubmitPeriod(overrides?): Promise<BigNumber>

Get the submit period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getSubmitPeriod


getSubmitPeriod()​

▸ getSubmitPeriod()(overrides?): Promise<BigNumber>

Get the submit period

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getSubmitPeriod()


getTotalStakeFraction​

▸ getTotalStakeFraction(overrides?): Promise<BigNumber>

Get the total stake fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getTotalStakeFraction


getTotalStakeFraction()​

▸ getTotalStakeFraction()(overrides?): Promise<BigNumber>

Get the total stake fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getTotalStakeFraction()


getUserMinStakeFraction​

▸ getUserMinStakeFraction(overrides?): Promise<BigNumber>

Get the user min stake fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getUserMinStakeFraction


getUserMinStakeFraction()​

▸ getUserMinStakeFraction()(overrides?): Promise<BigNumber>

Get the user min stake fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getUserMinStakeFraction()


getVoterReward​

▸ getVoterReward(_motionId, _voterRep, overrides?): Promise<BigNumber>

Get the voter reward NB This function will only return a meaningful value if in the reveal state. Prior to the reveal state, getVoterRewardRange should be used.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voterRepBigNumberishThe reputation the voter has in the domain
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getVoterReward


getVoterReward(uint256,uint256)​

▸ getVoterReward(uint256,uint256)(_motionId, _voterRep, overrides?): Promise<BigNumber>

Get the voter reward NB This function will only return a meaningful value if in the reveal state. Prior to the reveal state, getVoterRewardRange should be used.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voterRepBigNumberishThe reputation the voter has in the domain
overrides?CallOverrides-

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getVoterReward(uint256,uint256)


getVoterRewardFraction​

▸ getVoterRewardFraction(overrides?): Promise<BigNumber>

Get the voter reward fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getVoterRewardFraction


getVoterRewardFraction()​

▸ getVoterRewardFraction()(overrides?): Promise<BigNumber>

Get the voter reward fraction

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.getVoterRewardFraction()


getVoterRewardRange​

▸ getVoterRewardRange(_motionId, _voterRep, _voterAddress, overrides?): Promise<[BigNumber, BigNumber]>

Get the range of potential rewards for a voter on a specific motion, intended to be used when the motion is in the reveal state. Once a motion is in the reveal state the reward is known, and getVoterRewardRange should be used.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voterRepBigNumberishThe reputation the voter has in the domain
_voterAddressstringThe address the user will be voting as
overrides?CallOverrides-

Returns​

Promise<[BigNumber, BigNumber]>

Inherited from​

AugmentedVotingReputation.getVoterRewardRange


getVoterRewardRange(uint256,uint256,address)​

▸ getVoterRewardRange(uint256,uint256,address)(_motionId, _voterRep, _voterAddress, overrides?): Promise<[BigNumber, BigNumber]>

Get the range of potential rewards for a voter on a specific motion, intended to be used when the motion is in the reveal state. Once a motion is in the reveal state the reward is known, and getVoterRewardRange should be used.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voterRepBigNumberishThe reputation the voter has in the domain
_voterAddressstringThe address the user will be voting as
overrides?CallOverrides-

Returns​

Promise<[BigNumber, BigNumber]>

Inherited from​

AugmentedVotingReputation.getVoterRewardRange(uint256,uint256,address)


identifier​

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.identifier


identifier()​

▸ identifier()(overrides?): Promise<string>

Returns the identifier of the extension

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.identifier()


initialise​

▸ initialise(_totalStakeFraction, _voterRewardFraction, _userMinStakeFraction, _maxVoteFraction, _stakePeriod, _submitPeriod, _revealPeriod, _escalationPeriod, overrides?): Promise<ContractTransaction>

Initialise the extension

Parameters​

NameTypeDescription
_totalStakeFractionBigNumberishThe fraction of the domain's reputation we need to stake
_voterRewardFractionBigNumberishThe fraction of the total stake paid out to voters as rewards
_userMinStakeFractionBigNumberishThe minimum per-user stake as fraction of total stake
_maxVoteFractionBigNumberishThe fraction of the domain's reputation which must submit for quick-end
_stakePeriodBigNumberishThe length of the staking period in seconds
_submitPeriodBigNumberishThe length of the submit period in seconds
_revealPeriodBigNumberishThe length of the reveal period in seconds
_escalationPeriodBigNumberishThe length of the escalation period in seconds
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.initialise


initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)​

▸ initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)(_totalStakeFraction, _voterRewardFraction, _userMinStakeFraction, _maxVoteFraction, _stakePeriod, _submitPeriod, _revealPeriod, _escalationPeriod, overrides?): Promise<ContractTransaction>

Initialise the extension

Parameters​

NameTypeDescription
_totalStakeFractionBigNumberishThe fraction of the domain's reputation we need to stake
_voterRewardFractionBigNumberishThe fraction of the total stake paid out to voters as rewards
_userMinStakeFractionBigNumberishThe minimum per-user stake as fraction of total stake
_maxVoteFractionBigNumberishThe fraction of the domain's reputation which must submit for quick-end
_stakePeriodBigNumberishThe length of the staking period in seconds
_submitPeriodBigNumberishThe length of the submit period in seconds
_revealPeriodBigNumberishThe length of the reveal period in seconds
_escalationPeriodBigNumberishThe length of the escalation period in seconds
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.initialise(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256)


install​

▸ install(_colony, overrides?): Promise<ContractTransaction>

Install the extension

Parameters​

NameTypeDescription
_colonystringBase colony for the installation
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.install


install(address)​

▸ install(address)(_colony, overrides?): Promise<ContractTransaction>

Install the extension

Parameters​

NameTypeDescription
_colonystringBase colony for the installation
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.install(address)


listenerCount​

▸ listenerCount(eventName?): number

Parameters​

NameType
eventName?string | EventFilter

Returns​

number

Inherited from​

AugmentedVotingReputation.listenerCount


listeners​

▸ listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters​

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters​

NameType
eventFilter?TypedEventFilter<TEvent>

Returns​

TypedListener<TEvent>[]

Inherited from​

AugmentedVotingReputation.listeners

▸ listeners(eventName?): Listener[]

Parameters​

NameType
eventName?string

Returns​

Listener[]

Inherited from​

AugmentedVotingReputation.listeners


owner​

▸ owner(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.owner


owner()​

▸ owner()(overrides?): Promise<string>

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<string>

Inherited from​

AugmentedVotingReputation.owner()


queryFilter​

▸ queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters​

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters​

NameType
eventTypedEventFilter<TEvent>
fromBlockOrBlockhash?string | number
toBlock?string | number

Returns​

Promise<TEvent[]>

Inherited from​

AugmentedVotingReputation.queryFilter


removeAllListeners​

▸ removeAllListeners<TEvent>(eventFilter): VotingReputationClientV3

Type parameters​

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters​

NameType
eventFilterTypedEventFilter<TEvent>

Returns​

VotingReputationClientV3

Inherited from​

AugmentedVotingReputation.removeAllListeners

▸ removeAllListeners(eventName?): VotingReputationClientV3

Parameters​

NameType
eventName?string

Returns​

VotingReputationClientV3

Inherited from​

AugmentedVotingReputation.removeAllListeners


revealVote​

▸ revealVote(_motionId, _salt, _vote, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Reveal a vote secret for a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_saltBytesLikeThe salt used to hash the vote
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.revealVote


revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])​

▸ revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])(_motionId, _salt, _vote, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Reveal a vote secret for a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_saltBytesLikeThe salt used to hash the vote
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.revealVote(uint256,bytes32,uint256,bytes,bytes,uint256,bytes32[])


setAuthority​

▸ setAuthority(authority_, overrides?): Promise<ContractTransaction>

Parameters​

NameType
authority_string
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.setAuthority


setAuthority(address)​

▸ setAuthority(address)(authority_, overrides?): Promise<ContractTransaction>

Parameters​

NameType
authority_string
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.setAuthority(address)


setOwner​

▸ setOwner(owner_, overrides?): Promise<ContractTransaction>

Parameters​

NameType
owner_string
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.setOwner


setOwner(address)​

▸ setOwner(address)(owner_, overrides?): Promise<ContractTransaction>

Parameters​

NameType
owner_string
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.setOwner(address)


stakeMotion​

▸ stakeMotion(_motionId, _permissionDomainId, _childSkillIndex, _vote, _amount, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Stake on a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_permissionDomainIdBigNumberishThe domain where the extension has the arbitration permission
_childSkillIndexBigNumberishFor the domain in which the motion is occurring
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
_amountBigNumberishThe amount of tokens being staked
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.stakeMotion


stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])​

▸ stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])(_motionId, _permissionDomainId, _childSkillIndex, _vote, _amount, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Stake on a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_permissionDomainIdBigNumberishThe domain where the extension has the arbitration permission
_childSkillIndexBigNumberishFor the domain in which the motion is occurring
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
_amountBigNumberishThe amount of tokens being staked
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.stakeMotion(uint256,uint256,uint256,uint256,uint256,bytes,bytes,uint256,bytes32[])


stakeMotionWithProofs​

▸ stakeMotionWithProofs(_motionId, _vote, _amount, overrides?): Promise<ContractTransaction>

Same as stakeMotion, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voteBigNumberishThe side being supported (0 = NAY, 1 = YAY)
_amountBigNumberishThe amount of tokens being staked
overrides?TxOverrides-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.stakeMotionWithProofs


submitVote​

▸ submitVote(_motionId, _voteSecret, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Submit a vote secret for a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voteSecretBytesLikeThe hashed vote secret
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.submitVote


submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])​

▸ submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])(_motionId, _voteSecret, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Submit a vote secret for a motion

Parameters​

NameTypeDescription
_motionIdBigNumberishThe id of the motion
_voteSecretBytesLikeThe hashed vote secret
_keyBytesLikeReputation tree key for the staker/domain
_valueBytesLikeReputation tree value for the staker/domain
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?Overrides & { from?: string }-

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.submitVote(uint256,bytes32,bytes,bytes,uint256,bytes32[])


uninstall​

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters​

NameType
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.uninstall


uninstall()​

▸ uninstall()(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters​

NameType
overrides?Overrides & { from?: string }

Returns​

Promise<ContractTransaction>

Inherited from​

AugmentedVotingReputation.uninstall()


version​

▸ version(overrides?): Promise<BigNumber>

Return the version number

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.version


version()​

▸ version()(overrides?): Promise<BigNumber>

Return the version number

Parameters​

NameType
overrides?CallOverrides

Returns​

Promise<BigNumber>

Inherited from​

AugmentedVotingReputation.version()