Skip to main content

Interface: StakedExpenditureClientV1

Hierarchy

  • AugmentedStakedExpenditure<StakedExpenditure>

    StakedExpenditureClientV1

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

Inherited from

AugmentedStakedExpenditure._deployedPromise


_runningEvents

_runningEvents: Object

Index signature

[eventTag: string]: RunningEvent

Inherited from

AugmentedStakedExpenditure._runningEvents


_wrappedEmits

_wrappedEmits: Object

Index signature

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

Inherited from

AugmentedStakedExpenditure._wrappedEmits


address

Readonly address: string

Inherited from

AugmentedStakedExpenditure.address


callStatic

callStatic: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<string>
cancelAndPunish(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _callerPermissionDomainId: PromiseOrValue<BigNumberish>, _callerChildSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, _punish: PromiseOrValue<boolean>, overrides?: CallOverrides) => Promise<void>
cancelAndReclaimStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
deprecate(_deprecated: PromiseOrValue<boolean>, overrides?: CallOverrides) => Promise<void>
executeMetaTransaction(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<string>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
getCapabilityRoles(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<string>
getChainId(overrides?: CallOverrides) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getMetatransactionNonce(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<StakeStructOutput>
getStakeFraction(overrides?: CallOverrides) => Promise<BigNumber>
identifier(overrides?: CallOverrides) => Promise<string>
install(_colony: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
makeExpenditureWithStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _domainId: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<void>
owner(overrides?: CallOverrides) => Promise<string>
reclaimStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
setAuthority(authority_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setStakeFraction(_stakeFraction: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
verify(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedStakedExpenditure.callStatic


clientType

clientType: StakedExpenditureClient

Inherited from

AugmentedStakedExpenditure.clientType


clientVersion

clientVersion: 1

Overrides

AugmentedStakedExpenditure.clientVersion


colonyClient

colonyClient: AugmentedIColony<ValidColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedStakedExpenditure.colonyClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedStakedExpenditure.deployTransaction


estimateGas

estimateGas: { authority: (overrides?: CallOverrides) => Promise<BigNumber> ; cancelAndPunish: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _callerPermissionDomainId: PromiseOrValue<BigNumberish>, _callerChildSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, _punish: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; cancelAndReclaimStake: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; deprecate: (_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; executeMetaTransaction: (_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; finishUpgrade: (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; getCapabilityRoles: (_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber> ; getChainId: (overrides?: CallOverrides) => Promise<BigNumber> ; getColony: (overrides?: CallOverrides) => Promise<BigNumber> ; getDeprecated: (overrides?: CallOverrides) => Promise<BigNumber> ; getMetatransactionNonce: (_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber> ; getStake: (_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> ; getStakeFraction: (overrides?: CallOverrides) => Promise<BigNumber> ; identifier: (overrides?: CallOverrides) => Promise<BigNumber> ; install: (_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; makeExpenditureWithStake: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _domainId: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; owner: (overrides?: CallOverrides) => Promise<BigNumber> ; reclaimStake: (_expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setAuthority: (authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setOwner: (owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setStakeFraction: (_stakeFraction: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; uninstall: (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; verify: (_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> ; version: (overrides?: CallOverrides) => Promise<BigNumber> } & { authority: (overrides?: CallOverrides) => Promise<BigNumber> ; cancelAndPunish: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _callerPermissionDomainId: PromiseOrValue<BigNumberish>, _callerChildSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, _punish: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; cancelAndReclaimStake: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; deprecate: (_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; executeMetaTransaction: (_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; finishUpgrade: (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; getCapabilityRoles: (_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber> ; getChainId: (overrides?: CallOverrides) => Promise<BigNumber> ; getColony: (overrides?: CallOverrides) => Promise<BigNumber> ; getDeprecated: (overrides?: CallOverrides) => Promise<BigNumber> ; getMetatransactionNonce: (_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber> ; getStake: (_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> ; getStakeFraction: (overrides?: CallOverrides) => Promise<BigNumber> ; identifier: (overrides?: CallOverrides) => Promise<BigNumber> ; install: (_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; makeExpenditureWithStake: (_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _domainId: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; owner: (overrides?: CallOverrides) => Promise<BigNumber> ; reclaimStake: (_expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setAuthority: (authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setOwner: (owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; setStakeFraction: (_stakeFraction: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; uninstall: (overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber> ; verify: (_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber> ; version: (overrides?: CallOverrides) => Promise<BigNumber> } & { cancelAndPunishWithProofs: (_expenditureId: BigNumberish, _punish: boolean, overrides?: TxOverrides) => Promise<BigNumber> ; cancelAndReclaimStakeWithProofs: (_expenditureId: BigNumberish, overrides?: TxOverrides) => Promise<BigNumber> ; makeExpenditureWithStakeWithProofs: (_domainId: BigNumberish, _key: BytesLike, _value: BytesLike, _branchMask: BigNumberish, _siblings: BytesLike[], overrides?: TxOverrides) => Promise<BigNumber> }

Inherited from

AugmentedStakedExpenditure.estimateGas


filters

filters: Object

Type declaration

NameType
ExpenditureCancelled(expenditureId?: null) => ExpenditureCancelledEventFilter
ExpenditureCancelled(uint256)(expenditureId?: null) => ExpenditureCancelledEventFilter
ExpenditureMadeViaStake(creator?: null | PromiseOrValue<string>, expenditureId?: null, stake?: null) => ExpenditureMadeViaStakeEventFilter
ExpenditureMadeViaStake(address,uint256,uint256)(creator?: null | PromiseOrValue<string>, expenditureId?: null, stake?: null) => ExpenditureMadeViaStakeEventFilter
ExtensionInitialised() => ExtensionInitialisedEventFilter
ExtensionInitialised()() => ExtensionInitialisedEventFilter
LogSetAuthority(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetAuthority(address)(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetOwner(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
LogSetOwner(address)(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
MetaTransactionExecuted(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
MetaTransactionExecuted(address,address,bytes)(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
StakeFractionSet(stakeFraction?: null) => StakeFractionSetEventFilter
StakeFractionSet(uint256)(stakeFraction?: null) => StakeFractionSetEventFilter
StakeReclaimed(expenditureId?: null) => StakeReclaimedEventFilter
StakeReclaimed(uint256)(expenditureId?: null) => StakeReclaimedEventFilter

Inherited from

AugmentedStakedExpenditure.filters


functions

functions: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<[string]>
cancelAndPunish(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _callerPermissionDomainId: PromiseOrValue<BigNumberish>, _callerChildSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, _punish: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
cancelAndReclaimStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
deprecate(_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
executeMetaTransaction(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
getCapabilityRoles(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[string]>
getChainId(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getMetatransactionNonce(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[StakeStructOutput] & { stake: StakeStructOutput }>
getStakeFraction(overrides?: CallOverrides) => Promise<[BigNumber] & { _stakeFraction: BigNumber }>
identifier(overrides?: CallOverrides) => Promise<[string] & { _identifier: string }>
install(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
makeExpenditureWithStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _domainId: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
reclaimStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setAuthority(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setOwner(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setStakeFraction(_stakeFraction: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
verify(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[boolean]>
version(overrides?: CallOverrides) => Promise<[BigNumber] & { _version: BigNumber }>

Inherited from

AugmentedStakedExpenditure.functions


interface

interface: StakedExpenditureInterface

Inherited from

AugmentedStakedExpenditure.interface


off

off: OnEvent<StakedExpenditureClientV1>

Inherited from

AugmentedStakedExpenditure.off


on

on: OnEvent<StakedExpenditureClientV1>

Inherited from

AugmentedStakedExpenditure.on


once

once: OnEvent<StakedExpenditureClientV1>

Inherited from

AugmentedStakedExpenditure.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
cancelAndPunish(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _callerPermissionDomainId: PromiseOrValue<BigNumberish>, _callerChildSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, _punish: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
cancelAndReclaimStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
deprecate(_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
executeMetaTransaction(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStakeFraction(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
install(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
makeExpenditureWithStake(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _domainId: PromiseOrValue<BigNumberish>, _key: PromiseOrValue<BytesLike>, _value: PromiseOrValue<BytesLike>, _branchMask: PromiseOrValue<BigNumberish>, _siblings: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
reclaimStake(_expenditureId: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setAuthority(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setOwner(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setStakeFraction(_stakeFraction: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
verify(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedStakedExpenditure.populateTransaction


provider

Readonly provider: Provider

Inherited from

AugmentedStakedExpenditure.provider


removeListener

removeListener: OnEvent<StakedExpenditureClientV1>

Inherited from

AugmentedStakedExpenditure.removeListener


resolvedAddress

Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedStakedExpenditure.resolvedAddress


signer

Readonly signer: Signer

Inherited from

AugmentedStakedExpenditure.signer


stakedExpenditureEvents

stakedExpenditureEvents: StakedExpenditureEvents

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

Inherited from

AugmentedStakedExpenditure.stakedExpenditureEvents

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent): void

Parameters

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedStakedExpenditure._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedStakedExpenditure._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedStakedExpenditure._wrapEvent


attach

attach(addressOrName): StakedExpenditureClientV1

Parameters

NameType
addressOrNamestring

Returns

StakedExpenditureClientV1

Inherited from

AugmentedStakedExpenditure.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStakedExpenditure.authority


cancelAndPunish

cancelAndPunish(_permissionDomainId, _childSkillIndex, _callerPermissionDomainId, _callerChildSkillIndex, _expenditureId, _punish, overrides?): Promise<ContractTransaction>

Cancel the expenditure and punish the stakerCan only be called by an arbitration user

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which the extension has the arbitration permission
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_callerPermissionDomainIdPromiseOrValue<BigNumberish>The domainId in which the caller has the arbitration permission
_callerChildSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _callerPermissionDomainId
_expenditureIdPromiseOrValue<BigNumberish>The id of the expenditure
_punishPromiseOrValue<boolean>Whether the staker should be punished by losing an amount of reputation equal to the stake
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.cancelAndPunish


cancelAndPunishWithProofs

cancelAndPunishWithProofs(_expenditureId, _punish, overrides?): Promise<ContractTransaction>

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

Parameters

NameTypeDescription
_expenditureIdBigNumberishThe id of the expenditure
_punishbooleanWhether the staker should be punished by losing an amount of reputation equal to the stake
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.cancelAndPunishWithProofs


cancelAndReclaimStake

cancelAndReclaimStake(_permissionDomainId, _childSkillIndex, _expenditureId, overrides?): Promise<ContractTransaction>

Cancel the expenditure and reclaim the stake in one transactionCan only be called by expenditure owner while expenditure is in draft state

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which the extension has the arbitration permission
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId
_expenditureIdPromiseOrValue<BigNumberish>The id of the expenditure
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.cancelAndReclaimStake


cancelAndReclaimStakeWithProofs

cancelAndReclaimStakeWithProofs(_expenditureId, overrides?): Promise<ContractTransaction>

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

Parameters

NameTypeDescription
_expenditureIdBigNumberishThe id of the expenditure
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.cancelAndReclaimStakeWithProofs


connect

connect(signerOrProvider): StakedExpenditureClientV1

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

StakedExpenditureClientV1

Inherited from

AugmentedStakedExpenditure.connect


deployed

deployed(): Promise<StakedExpenditureClientV1>

Returns

Promise<StakedExpenditureClientV1>

Inherited from

AugmentedStakedExpenditure.deployed


deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

NameTypeDescription
_deprecatedPromiseOrValue<boolean>Indicates whether the extension should be deprecated or undeprecated
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.deprecate


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedStakedExpenditure.emit


executeMetaTransaction

executeMetaTransaction(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise<ContractTransaction>

Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method.

Parameters

NameTypeDescription
_userPromiseOrValue<string>Address of user trying to do meta transaction
_payloadPromiseOrValue<BytesLike>Function call to make via meta transaction
_sigRPromiseOrValue<BytesLike>R part of the signature
_sigSPromiseOrValue<BytesLike>S part of the signature
_sigVPromiseOrValue<BigNumberish>V part of the signature
overrides?PayableOverrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.executeMetaTransaction


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedStakedExpenditure.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.finishUpgrade


getCapabilityRoles

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

Parameters

NameType
_sigPromiseOrValue<BytesLike>
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStakedExpenditure.getCapabilityRoles


getChainId

getChainId(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStakedExpenditure.getChainId


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStakedExpenditure.getColony


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStakedExpenditure.getDeprecated


getMetatransactionNonce

getMetatransactionNonce(_user, overrides?): Promise<BigNumber>

Parameters

NameType
_userPromiseOrValue<string>
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStakedExpenditure.getMetatransactionNonce


getStake

getStake(_expenditureId, overrides?): Promise<StakeStructOutput>

Get the stake for an expenditure

Parameters

NameTypeDescription
_expenditureIdPromiseOrValue<BigNumberish>The id of the expenditure to get the stake for
overrides?CallOverrides-

Returns

Promise<StakeStructOutput>

Inherited from

AugmentedStakedExpenditure.getStake


getStakeFraction

getStakeFraction(overrides?): Promise<BigNumber>

Get the stake fraction

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStakedExpenditure.getStakeFraction


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStakedExpenditure.identifier


install

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

Configures the extension

Parameters

NameTypeDescription
_colonyPromiseOrValue<string>The colony in which the extension holds permissions
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.install


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

AugmentedStakedExpenditure.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

AugmentedStakedExpenditure.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedStakedExpenditure.listeners


makeExpenditureWithStake

makeExpenditureWithStake(_permissionDomainId, _childSkillIndex, _domainId, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Make an expenditure by putting up a stake

Parameters

NameTypeDescription
_permissionDomainIdPromiseOrValue<BigNumberish>The domainId in which the extension has the administration permission
_childSkillIndexPromiseOrValue<BigNumberish>The index that the _domainId is relative to _permissionDomainId,
_domainIdPromiseOrValue<BigNumberish>The domain where the expenditure belongs
_keyPromiseOrValue<BytesLike>A reputation hash tree key, of the total reputation in _domainId
_valuePromiseOrValue<BytesLike>Reputation value indicating the total reputation in _domainId
_branchMaskPromiseOrValue<BigNumberish>The branchmask of the proof
_siblingsPromiseOrValue<BytesLike>[]The siblings of the proof
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.makeExpenditureWithStake


makeExpenditureWithStakeWithProofs

makeExpenditureWithStakeWithProofs(_domainId, _key, _value, _branchMask, _siblings, overrides?): Promise<ContractTransaction>

Same as makeExpenditureWithStake, 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 the expenditure belongs
_keyBytesLikeA reputation hash tree key, of the total reputation in _domainId
_valueBytesLikeReputation value indicating the total reputation in _domainId
_branchMaskBigNumberishThe branchmask of the proof
_siblingsBytesLike[]The siblings of the proof
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.makeExpenditureWithStakeWithProofs


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStakedExpenditure.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

AugmentedStakedExpenditure.queryFilter


reclaimStake

reclaimStake(_expenditureId, overrides?): Promise<ContractTransaction>

Reclaims the stake if the expenditure is finalized or cancelled

Parameters

NameTypeDescription
_expenditureIdPromiseOrValue<BigNumberish>The id of the expenditure
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.reclaimStake


removeAllListeners

removeAllListeners<TEvent>(eventFilter): StakedExpenditureClientV1

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

StakedExpenditureClientV1

Inherited from

AugmentedStakedExpenditure.removeAllListeners

removeAllListeners(eventName?): StakedExpenditureClientV1

Parameters

NameType
eventName?string

Returns

StakedExpenditureClientV1

Inherited from

AugmentedStakedExpenditure.removeAllListeners


setAuthority

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

Parameters

NameType
authority_PromiseOrValue<string>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.setAuthority


setOwner

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

Parameters

NameType
owner_PromiseOrValue<string>
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.setOwner


setStakeFraction

setStakeFraction(_stakeFraction, overrides?): Promise<ContractTransaction>

Sets the stake fraction

Parameters

NameTypeDescription
_stakeFractionPromiseOrValue<BigNumberish>WAD-denominated fraction, used to determine stake as fraction of rep in domain
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.setStakeFraction


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

NameType
overrides?Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStakedExpenditure.uninstall


verify

verify(_owner, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise<boolean>

Parameters

NameType
_ownerPromiseOrValue<string>
_noncePromiseOrValue<BigNumberish>
_chainIdPromiseOrValue<BigNumberish>
_payloadPromiseOrValue<BytesLike>
_sigRPromiseOrValue<BytesLike>
_sigSPromiseOrValue<BytesLike>
_sigVPromiseOrValue<BigNumberish>
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStakedExpenditure.verify


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStakedExpenditure.version