Interface: VotingReputationClientV6
Hierarchy
AugmentedVotingReputation<IVotingReputation>AugmentsV2<IVotingReputation>↳
VotingReputationClientV6
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
| Name | Type |
|---|---|
claimMisalignedReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void> |
claimReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void> |
createClaimDelayAction | (action: PromiseOrValue<BytesLike>, value: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<string> |
createDomainMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
createMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
createRootMotion | (_altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
deprecate | (_deprecated: PromiseOrValue<boolean>, overrides?: CallOverrides) => Promise<void> |
escalateMotion | (_motionId: PromiseOrValue<BigNumberish>, _newDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
executeMetaTransaction | (userAddress: PromiseOrValue<string>, payload: PromiseOrValue<BytesLike>, sigR: PromiseOrValue<BytesLike>, sigS: PromiseOrValue<BytesLike>, sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<string> |
failingExecutionAllowed | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean> |
finalizeMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void> |
finishUpgrade | (overrides?: CallOverrides) => Promise<void> |
getCapabilityRoles | (_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<string> |
getColony | (overrides?: CallOverrides) => Promise<string> |
getDeprecated | (overrides?: CallOverrides) => Promise<boolean> |
getEscalationPeriod | (overrides?: CallOverrides) => Promise<BigNumber> |
getExpenditureMotionCount | (_structHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber> |
getExpenditurePastVote | (_actionHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber> |
getMaxVoteFraction | (overrides?: CallOverrides) => Promise<BigNumber> |
getMetatransactionNonce | (userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber> |
getMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<MotionStructOutput> |
getMotionCount | (overrides?: CallOverrides) => Promise<BigNumber> |
getMotionState | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<number> |
getRevealPeriod | (overrides?: CallOverrides) => Promise<BigNumber> |
getStake | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> |
getStakePeriod | (overrides?: CallOverrides) => Promise<BigNumber> |
getStakerReward | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]> |
getSubmitPeriod | (overrides?: CallOverrides) => Promise<BigNumber> |
getTotalStakeFraction | (overrides?: CallOverrides) => Promise<BigNumber> |
getUserMinStakeFraction | (overrides?: CallOverrides) => Promise<BigNumber> |
getVoterReward | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> |
getVoterRewardFraction | (overrides?: CallOverrides) => Promise<BigNumber> |
getVoterRewardRange | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, _voterAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]> |
identifier | (overrides?: CallOverrides) => Promise<string> |
initialise | (_totalStakeFraction: PromiseOrValue<BigNumberish>, _voterRewardFraction: PromiseOrValue<BigNumberish>, _userMinStakeFraction: PromiseOrValue<BigNumberish>, _maxVoteFraction: PromiseOrValue<BigNumberish>, _stakePeriod: PromiseOrValue<BigNumberish>, _submitPeriod: PromiseOrValue<BigNumberish>, _revealPeriod: PromiseOrValue<BigNumberish>, _escalationPeriod: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void> |
install | (_colony: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void> |
revealVote | (_motionId: PromiseOrValue<BigNumberish>, _salt: PromiseOrValue<BytesLike>, _vote: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
stakeMotion | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _vote: PromiseOrValue<BigNumberish>, _amount: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
submitVote | (_motionId: PromiseOrValue<BigNumberish>, _voteSecret: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void> |
uninstall | (overrides?: CallOverrides) => Promise<void> |
version | (overrides?: CallOverrides) => Promise<BigNumber> |
Inherited from
AugmentedVotingReputation.callStatic
clientType
• clientType: VotingReputationClient
Inherited from
AugmentedVotingReputation.clientType
clientVersion
• clientVersion: 6
Overrides
AugmentedVotingReputation.clientVersion
colonyClient
• colonyClient: AugmentedIColony<AnyIColony>
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
| Name | Type |
|---|---|
MetaTransactionExecuted | (userAddress?: null, relayerAddress?: null, payload?: null) => MetaTransactionExecutedEventFilter |
MetaTransactionExecuted(address,address,bytes) | (userAddress?: null, relayerAddress?: null, payload?: null) => MetaTransactionExecutedEventFilter |
MotionCreated | (motionId?: null | PromiseOrValue<BigNumberish>, creator?: null, domainId?: null | PromiseOrValue<BigNumberish>) => MotionCreatedEventFilter |
MotionCreated(uint256,address,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, creator?: null, domainId?: null | PromiseOrValue<BigNumberish>) => MotionCreatedEventFilter |
MotionEscalated | (motionId?: null | PromiseOrValue<BigNumberish>, escalator?: null, domainId?: null | PromiseOrValue<BigNumberish>, newDomainId?: null | PromiseOrValue<BigNumberish>) => MotionEscalatedEventFilter |
MotionEscalated(uint256,address,uint256,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, escalator?: null, domainId?: null | PromiseOrValue<BigNumberish>, newDomainId?: null | PromiseOrValue<BigNumberish>) => MotionEscalatedEventFilter |
MotionEventSet | (motionId?: null | PromiseOrValue<BigNumberish>, eventIndex?: null) => MotionEventSetEventFilter |
MotionEventSet(uint256,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, eventIndex?: null) => MotionEventSetEventFilter |
MotionFinalized | (motionId?: null | PromiseOrValue<BigNumberish>, action?: null, executed?: null) => MotionFinalizedEventFilter |
MotionFinalized(uint256,bytes,bool) | (motionId?: null | PromiseOrValue<BigNumberish>, action?: null, executed?: null) => MotionFinalizedEventFilter |
MotionRewardClaimed | (motionId?: null | PromiseOrValue<BigNumberish>, staker?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>, amount?: null) => MotionRewardClaimedEventFilter |
MotionRewardClaimed(uint256,address,uint256,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, staker?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>, amount?: null) => MotionRewardClaimedEventFilter |
MotionStaked | (motionId?: null | PromiseOrValue<BigNumberish>, staker?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>, amount?: null) => MotionStakedEventFilter |
MotionStaked(uint256,address,uint256,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, staker?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>, amount?: null) => MotionStakedEventFilter |
MotionVoteRevealed | (motionId?: null | PromiseOrValue<BigNumberish>, voter?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>) => MotionVoteRevealedEventFilter |
MotionVoteRevealed(uint256,address,uint256) | (motionId?: null | PromiseOrValue<BigNumberish>, voter?: null | PromiseOrValue<string>, vote?: null | PromiseOrValue<BigNumberish>) => MotionVoteRevealedEventFilter |
MotionVoteSubmitted | (motionId?: null | PromiseOrValue<BigNumberish>, voter?: null | PromiseOrValue<string>) => MotionVoteSubmittedEventFilter |
MotionVoteSubmitted(uint256,address) | (motionId?: null | PromiseOrValue<BigNumberish>, voter?: null | PromiseOrValue<string>) => MotionVoteSubmittedEventFilter |
Inherited from
AugmentedVotingReputation.filters
functions
• functions: Object
Type declaration
| Name | Type |
|---|---|
claimMisalignedReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
claimReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
createClaimDelayAction | (action: PromiseOrValue<BytesLike>, value: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
createDomainMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
createMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
createRootMotion | (_altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
deprecate | (_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
escalateMotion | (_motionId: PromiseOrValue<BigNumberish>, _newDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
executeMetaTransaction | (userAddress: PromiseOrValue<string>, payload: PromiseOrValue<BytesLike>, sigR: PromiseOrValue<BytesLike>, sigS: PromiseOrValue<BytesLike>, sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
failingExecutionAllowed | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[boolean]> |
finalizeMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
finishUpgrade | (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
getCapabilityRoles | (_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[string]> |
getColony | (overrides?: CallOverrides) => Promise<[string]> |
getDeprecated | (overrides?: CallOverrides) => Promise<[boolean]> |
getEscalationPeriod | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getExpenditureMotionCount | (_structHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[BigNumber]> |
getExpenditurePastVote | (_actionHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[BigNumber]> |
getMaxVoteFraction | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getMetatransactionNonce | (userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }> |
getMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[MotionStructOutput] & { motion: MotionStructOutput }> |
getMotionCount | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getMotionState | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[number]> |
getRevealPeriod | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getStake | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[BigNumber]> |
getStakePeriod | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getStakerReward | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]> |
getSubmitPeriod | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getTotalStakeFraction | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getUserMinStakeFraction | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getVoterReward | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[BigNumber]> |
getVoterRewardFraction | (overrides?: CallOverrides) => Promise<[BigNumber]> |
getVoterRewardRange | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, _voterAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber, BigNumber]> |
identifier | (overrides?: CallOverrides) => Promise<[string]> |
initialise | (_totalStakeFraction: PromiseOrValue<BigNumberish>, _voterRewardFraction: PromiseOrValue<BigNumberish>, _userMinStakeFraction: PromiseOrValue<BigNumberish>, _maxVoteFraction: PromiseOrValue<BigNumberish>, _stakePeriod: PromiseOrValue<BigNumberish>, _submitPeriod: PromiseOrValue<BigNumberish>, _revealPeriod: PromiseOrValue<BigNumberish>, _escalationPeriod: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
install | (_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
revealVote | (_motionId: PromiseOrValue<BigNumberish>, _salt: PromiseOrValue<BytesLike>, _vote: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
stakeMotion | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _vote: PromiseOrValue<BigNumberish>, _amount: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
submitVote | (_motionId: PromiseOrValue<BigNumberish>, _voteSecret: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
uninstall | (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction> |
version | (overrides?: CallOverrides) => Promise<[BigNumber]> |
Inherited from
AugmentedVotingReputation.functions
interface
• interface: IVotingReputationInterface
Inherited from
AugmentedVotingReputation.interface
off
• off: OnEvent<VotingReputationClientV6>
Inherited from
AugmentedVotingReputation.off
on
• on: OnEvent<VotingReputationClientV6>
Inherited from
AugmentedVotingReputation.on
once
• once: OnEvent<VotingReputationClientV6>
Inherited from
AugmentedVotingReputation.once
populateTransaction
• populateTransaction: Object
Type declaration
| Name | Type |
|---|---|
claimMisalignedReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
claimReward | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
createClaimDelayAction | (action: PromiseOrValue<BytesLike>, value: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
createDomainMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
createMotion | (_domainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
createRootMotion | (_altTarget: PromiseOrValue<string>, _action: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
deprecate | (_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
escalateMotion | (_motionId: PromiseOrValue<BigNumberish>, _newDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
executeMetaTransaction | (userAddress: PromiseOrValue<string>, payload: PromiseOrValue<BytesLike>, sigR: PromiseOrValue<BytesLike>, sigS: PromiseOrValue<BytesLike>, sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
failingExecutionAllowed | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
finalizeMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
finishUpgrade | (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
getCapabilityRoles | (_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getColony | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getDeprecated | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getEscalationPeriod | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getExpenditureMotionCount | (_structHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getExpenditurePastVote | (_actionHash: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getMaxVoteFraction | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getMetatransactionNonce | (userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getMotion | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getMotionCount | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getMotionState | (_motionId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getRevealPeriod | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getStake | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getStakePeriod | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getStakerReward | (_motionId: PromiseOrValue<BigNumberish>, _staker: PromiseOrValue<string>, _vote: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getSubmitPeriod | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getTotalStakeFraction | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getUserMinStakeFraction | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getVoterReward | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getVoterRewardFraction | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
getVoterRewardRange | (_motionId: PromiseOrValue<BigNumberish>, _voterRep: PromiseOrValue<BigNumberish>, _voterAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction> |
identifier | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
initialise | (_totalStakeFraction: PromiseOrValue<BigNumberish>, _voterRewardFraction: PromiseOrValue<BigNumberish>, _userMinStakeFraction: PromiseOrValue<BigNumberish>, _maxVoteFraction: PromiseOrValue<BigNumberish>, _stakePeriod: PromiseOrValue<BigNumberish>, _submitPeriod: PromiseOrValue<BigNumberish>, _revealPeriod: PromiseOrValue<BigNumberish>, _escalationPeriod: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
install | (_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
revealVote | (_motionId: PromiseOrValue<BigNumberish>, _salt: PromiseOrValue<BytesLike>, _vote: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
stakeMotion | (_motionId: PromiseOrValue<BigNumberish>, _permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _vote: PromiseOrValue<BigNumberish>, _amount: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
submitVote | (_motionId: PromiseOrValue<BigNumberish>, _voteSecret: PromiseOrValue<BytesLike>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
uninstall | (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction> |
version | (overrides?: CallOverrides) => Promise<PopulatedTransaction> |
Inherited from
AugmentedVotingReputation.populateTransaction
provider
• Readonly provider: Provider
Inherited from
AugmentedVotingReputation.provider
removeListener
• removeListener: OnEvent<VotingReputationClientV6>
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
| Name | Type |
|---|---|
runningEvent | RunningEvent |
Returns
void
Inherited from
AugmentedVotingReputation._checkRunningEvents
_deployed
▸ _deployed(blockTag?): Promise<Contract>
Parameters
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns
Promise<Contract>
Inherited from
AugmentedVotingReputation._deployed
_wrapEvent
▸ _wrapEvent(runningEvent, log, listener): Event
Parameters
| Name | Type |
|---|---|
runningEvent | RunningEvent |
log | Log |
listener | Listener |
Returns
Event
Inherited from
AugmentedVotingReputation._wrapEvent
attach
▸ attach(addressOrName): VotingReputationClientV6
Parameters
| Name | Type |
|---|---|
addressOrName | string |
Returns
Inherited from
AugmentedVotingReputation.attach
claimMisalignedReward
▸ claimMisalignedReward(_motionId, _permissionDomainId, _childSkillIndex, _staker, _vote, overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
_motionId | PromiseOrValue<BigNumberish> |
_permissionDomainId | PromiseOrValue<BigNumberish> |
_childSkillIndex | PromiseOrValue<BigNumberish> |
_staker | PromiseOrValue<string> |
_vote | PromiseOrValue<BigNumberish> |
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.claimMisalignedReward
claimReward
▸ claimReward(_motionId, _permissionDomainId, _childSkillIndex, _staker, _vote, overrides?): Promise<ContractTransaction>
Claim the staker's reward
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_permissionDomainId | PromiseOrValue<BigNumberish> | The domain where the extension has the arbitration permission |
_childSkillIndex | PromiseOrValue<BigNumberish> | For the domain in which the motion is occurring |
_staker | PromiseOrValue<string> | The staker whose reward is being claimed |
_vote | PromiseOrValue<BigNumberish> | The side being supported (0 = NAY, 1 = YAY) |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.claimReward
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
| Name | Type | Description |
|---|---|---|
_motionId | BigNumberish | The id of the motion |
_staker | string | The staker whose reward is being claimed |
_vote | BigNumberish | The side being supported (0 = NAY, 1 = YAY) |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.claimRewardWithProofs
connect
▸ connect(signerOrProvider): VotingReputationClientV6
Parameters
| Name | Type |
|---|---|
signerOrProvider | string | Provider | Signer |
Returns
Inherited from
AugmentedVotingReputation.connect
createClaimDelayAction
▸ createClaimDelayAction(action, value, overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
action | PromiseOrValue<BytesLike> |
value | PromiseOrValue<BigNumberish> |
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.createClaimDelayAction
createDomainMotion
▸ createDomainMotion(_domainId, _childSkillIndex, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>
Create a motion in any domain (DEPRECATED)
Parameters
| Name | Type | Description |
|---|---|---|
_domainId | PromiseOrValue<BigNumberish> | The domain where we vote on the motion |
_childSkillIndex | PromiseOrValue<BigNumberish> | The childSkillIndex pointing to the domain of the action |
_action | PromiseOrValue<BytesLike> | A bytes array encoding a function call |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.createDomainMotion
createDomainMotionWithProofs
▸ createDomainMotionWithProofs(_domainId, _action, overrides?): Promise<ContractTransaction>
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
| Name | Type | Description |
|---|---|---|
_domainId | BigNumberish | The domain where we vote on the motion |
_action | BytesLike | A bytes array encoding a function call |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.createDomainMotionWithProofs
createMotion
▸ createMotion(_domainId, _childSkillIndex, _altTarget, _action, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>
Create a motion
Parameters
| Name | Type | Description |
|---|---|---|
_domainId | PromiseOrValue<BigNumberish> | The domain where we vote on the motion |
_childSkillIndex | PromiseOrValue<BigNumberish> | The childSkillIndex pointing to the domain of the action |
_altTarget | PromiseOrValue<string> | The contract to which we send the action (0x0 for the colony) |
_action | PromiseOrValue<BytesLike> | A bytes array encoding a function call |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the root domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the root domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.createMotion
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
| Name | Type | Description |
|---|---|---|
_domainId | BigNumberish | The domain where we vote on the motion |
_altTarget | string | The contract to which we send the action (0x0 for the colony) |
_action | BytesLike | A 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
| Name | Type | Description |
|---|---|---|
_altTarget | PromiseOrValue<string> | The contract to which we send the action (0x0 for the colony) |
_action | PromiseOrValue<BytesLike> | A bytes array encoding a function call |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the root domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the root domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.createRootMotion
deployed
▸ deployed(): Promise<VotingReputationClientV6>
Returns
Promise<VotingReputationClientV6>
Inherited from
AugmentedVotingReputation.deployed
deprecate
▸ deprecate(_deprecated, overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
_deprecated | PromiseOrValue<boolean> |
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.deprecate
emit
▸ emit(eventName, ...args): boolean
Parameters
| Name | Type |
|---|---|
eventName | string | EventFilter |
...args | any[] |
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
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_newDomainId | PromiseOrValue<BigNumberish> | The desired domain of escalation |
_childSkillIndex | PromiseOrValue<BigNumberish> | For the current domain, relative to the escalated domain |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the new domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the new domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.escalateMotion
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
| Name | Type | Description |
|---|---|---|
_motionId | BigNumberish | The id of the motion |
_newDomainId | BigNumberish | The desired domain of escalation |
overrides? | TxOverrides | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.escalateMotionWithProofs
executeMetaTransaction
▸ executeMetaTransaction(userAddress, payload, sigR, sigS, sigV, overrides?): Promise<ContractTransaction>
Executes a metatransaction targeting this contract
Parameters
| Name | Type | Description |
|---|---|---|
userAddress | PromiseOrValue<string> | The address of the user that signed the metatransaction |
payload | PromiseOrValue<BytesLike> | The transaction data that will be executed if signature valid |
sigR | PromiseOrValue<BytesLike> | The 'r' part of the signature |
sigS | PromiseOrValue<BytesLike> | The 's' part of the signature |
sigV | PromiseOrValue<BigNumberish> | The 'v' part of the signature |
overrides? | PayableOverrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.executeMetaTransaction
failingExecutionAllowed
▸ failingExecutionAllowed(_motionId, overrides?): Promise<boolean>
We are only expecting this to be called from finalize motion in the contracts. It is marked as external only so that the frontend can use it.
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
overrides? | CallOverrides | - |
Returns
Promise<boolean>
Inherited from
AugmentedVotingReputation.failingExecutionAllowed
fallback
▸ fallback(overrides?): Promise<TransactionResponse>
Parameters
| Name | Type |
|---|---|
overrides? | TransactionRequest |
Returns
Promise<TransactionResponse>
Inherited from
AugmentedVotingReputation.fallback
finalizeMotion
▸ finalizeMotion(_motionId, overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
_motionId | PromiseOrValue<BigNumberish> |
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.finalizeMotion
finishUpgrade
▸ finishUpgrade(overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.finishUpgrade
getCapabilityRoles
▸ getCapabilityRoles(_sig, overrides?): Promise<string>
Parameters
| Name | Type |
|---|---|
_sig | PromiseOrValue<BytesLike> |
overrides? | CallOverrides |
Returns
Promise<string>
Inherited from
AugmentedVotingReputation.getCapabilityRoles
getColony
▸ getColony(overrides?): Promise<string>
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<string>
Inherited from
AugmentedVotingReputation.getColony
getDeprecated
▸ getDeprecated(overrides?): Promise<boolean>
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<boolean>
Inherited from
AugmentedVotingReputation.getDeprecated
getEscalationPeriod
▸ getEscalationPeriod(overrides?): Promise<BigNumber>
Get the escalation period
Parameters
| Name | Type |
|---|---|
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
| Name | Type | Description |
|---|---|---|
_structHash | PromiseOrValue<BytesLike> | The hash of the expenditureId or expenditureId*expenditureSlot |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getExpenditureMotionCount
getExpenditurePastVote
▸ getExpenditurePastVote(_actionHash, overrides?): Promise<BigNumber>
Get the largest past vote on a single expenditure variable
Parameters
| Name | Type | Description |
|---|---|---|
_actionHash | PromiseOrValue<BytesLike> | The hash of the particular expenditure action |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getExpenditurePastVote
getMaxVoteFraction
▸ getMaxVoteFraction(overrides?): Promise<BigNumber>
Get the max vote fraction
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getMaxVoteFraction
getMetatransactionNonce
▸ getMetatransactionNonce(userAddress, overrides?): Promise<BigNumber>
Gets the next metatransaction nonce for user that should be used targeting this contract
Parameters
| Name | Type | Description |
|---|---|---|
userAddress | PromiseOrValue<string> | The address of the user that will sign the metatransaction |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getMetatransactionNonce
getMotion
▸ getMotion(_motionId, overrides?): Promise<MotionStructOutput>
Get the data for a single motion
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
overrides? | CallOverrides | - |
Returns
Promise<MotionStructOutput>
Inherited from
AugmentedVotingReputation.getMotion
getMotionCount
▸ getMotionCount(overrides?): Promise<BigNumber>
Get the total motion count
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getMotionCount
getMotionState
▸ getMotionState(_motionId, overrides?): Promise<number>
Get the current state of the motion
Parameters
| Name | Type |
|---|---|
_motionId | PromiseOrValue<BigNumberish> |
overrides? | CallOverrides |
Returns
Promise<number>
Inherited from
AugmentedVotingReputation.getMotionState
getRevealPeriod
▸ getRevealPeriod(overrides?): Promise<BigNumber>
Get the reveal period
Parameters
| Name | Type |
|---|---|
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
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_staker | PromiseOrValue<string> | The staker address |
_vote | PromiseOrValue<BigNumberish> | The side being supported (0 = NAY, 1 = YAY) |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getStake
getStakePeriod
▸ getStakePeriod(overrides?): Promise<BigNumber>
Get the stake period
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getStakePeriod
getStakerReward
▸ getStakerReward(_motionId, _staker, _vote, overrides?): Promise<[BigNumber, BigNumber]>
Get the staker reward
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_staker | PromiseOrValue<string> | The staker's address |
_vote | PromiseOrValue<BigNumberish> | The vote (0 = NAY, 1 = YAY) |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber]>
Inherited from
AugmentedVotingReputation.getStakerReward
getSubmitPeriod
▸ getSubmitPeriod(overrides?): Promise<BigNumber>
Get the submit period
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getSubmitPeriod
getTotalStakeFraction
▸ getTotalStakeFraction(overrides?): Promise<BigNumber>
Get the total stake fraction
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getTotalStakeFraction
getUserMinStakeFraction
▸ getUserMinStakeFraction(overrides?): Promise<BigNumber>
Get the user min stake fraction
Parameters
| Name | Type |
|---|---|
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
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_voterRep | PromiseOrValue<BigNumberish> | The reputation the voter has in the domain |
overrides? | CallOverrides | - |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.getVoterReward
getVoterRewardFraction
▸ getVoterRewardFraction(overrides?): Promise<BigNumber>
Get the voter reward fraction
Parameters
| Name | Type |
|---|---|
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
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_voterRep | PromiseOrValue<BigNumberish> | The reputation the voter has in the domain |
_voterAddress | PromiseOrValue<string> | The address the user will be voting as |
overrides? | CallOverrides | - |
Returns
Promise<[BigNumber, BigNumber]>
Inherited from
AugmentedVotingReputation.getVoterRewardRange
identifier
▸ identifier(overrides?): Promise<string>
Parameters
| Name | Type |
|---|---|
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
| Name | Type | Description |
|---|---|---|
_totalStakeFraction | PromiseOrValue<BigNumberish> | The fraction of the domain's reputation we need to stake |
_voterRewardFraction | PromiseOrValue<BigNumberish> | The fraction of the total stake paid out to voters as rewards |
_userMinStakeFraction | PromiseOrValue<BigNumberish> | The minimum per-user stake as fraction of total stake |
_maxVoteFraction | PromiseOrValue<BigNumberish> | The fraction of the domain's reputation which must submit for quick-end |
_stakePeriod | PromiseOrValue<BigNumberish> | The length of the staking period in seconds |
_submitPeriod | PromiseOrValue<BigNumberish> | The length of the submit period in seconds |
_revealPeriod | PromiseOrValue<BigNumberish> | The length of the reveal period in seconds |
_escalationPeriod | PromiseOrValue<BigNumberish> | The length of the escalation period in seconds |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.initialise
install
▸ install(_colony, overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
_colony | PromiseOrValue<string> |
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.install
listenerCount
▸ listenerCount(eventName?): number
Parameters
| Name | Type |
|---|---|
eventName? | string | EventFilter |
Returns
number
Inherited from
AugmentedVotingReputation.listenerCount
listeners
▸ listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
eventFilter? | TypedEventFilter<TEvent> |
Returns
TypedListener<TEvent>[]
Inherited from
AugmentedVotingReputation.listeners
▸ listeners(eventName?): Listener[]
Parameters
| Name | Type |
|---|---|
eventName? | string |
Returns
Listener[]
Inherited from
AugmentedVotingReputation.listeners
queryFilter
▸ queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
event | TypedEventFilter<TEvent> |
fromBlockOrBlockhash? | string | number |
toBlock? | string | number |
Returns
Promise<TEvent[]>
Inherited from
AugmentedVotingReputation.queryFilter
removeAllListeners
▸ removeAllListeners<TEvent>(eventFilter): VotingReputationClientV6
Type parameters
| Name | Type |
|---|---|
TEvent | extends TypedEvent<any, any, TEvent> |
Parameters
| Name | Type |
|---|---|
eventFilter | TypedEventFilter<TEvent> |
Returns
Inherited from
AugmentedVotingReputation.removeAllListeners
▸ removeAllListeners(eventName?): VotingReputationClientV6
Parameters
| Name | Type |
|---|---|
eventName? | string |
Returns
Inherited from
AugmentedVotingReputation.removeAllListeners
revealVote
▸ revealVote(_motionId, _salt, _vote, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>
Reveal a vote secret for a motion
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_salt | PromiseOrValue<BytesLike> | The salt used to hash the vote |
_vote | PromiseOrValue<BigNumberish> | The side being supported (0 = NAY, 1 = YAY) |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the staker/domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the staker/domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.revealVote
stakeMotion
▸ stakeMotion(_motionId, _permissionDomainId, _childSkillIndex, _vote, _amount, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>
Stake on a motion
Parameters
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_permissionDomainId | PromiseOrValue<BigNumberish> | The domain where the extension has the arbitration permission |
_childSkillIndex | PromiseOrValue<BigNumberish> | For the domain in which the motion is occurring |
_vote | PromiseOrValue<BigNumberish> | The side being supported (0 = NAY, 1 = YAY) |
_amount | PromiseOrValue<BigNumberish> | The amount of tokens being staked |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the staker/domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the staker/domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.stakeMotion
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
| Name | Type | Description |
|---|---|---|
_motionId | BigNumberish | The id of the motion |
_vote | BigNumberish | The side being supported (0 = NAY, 1 = YAY) |
_amount | BigNumberish | The 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
| Name | Type | Description |
|---|---|---|
_motionId | PromiseOrValue<BigNumberish> | The id of the motion |
_voteSecret | PromiseOrValue<BytesLike> | The hashed vote secret |
_key | PromiseOrValue<BytesLike> | Reputation tree key for the staker/domain |
_value | PromiseOrValue<BytesLike> | Reputation tree value for the staker/domain |
_branchMask | PromiseOrValue<BigNumberish> | The branchmask of the proof |
_siblings | PromiseOrValue<BytesLike>[] | The siblings of the proof |
overrides? | Overrides & { from?: PromiseOrValue<string> } | - |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.submitVote
uninstall
▸ uninstall(overrides?): Promise<ContractTransaction>
Parameters
| Name | Type |
|---|---|
overrides? | Overrides & { from?: PromiseOrValue<string> } |
Returns
Promise<ContractTransaction>
Inherited from
AugmentedVotingReputation.uninstall
version
▸ version(overrides?): Promise<BigNumber>
Parameters
| Name | Type |
|---|---|
overrides? | CallOverrides |
Returns
Promise<BigNumber>
Inherited from
AugmentedVotingReputation.version