Skip to main content

Interface: EvaluatedExpenditureClientV1

Hierarchy

  • AugmentedEvaluatedExpenditure<EvaluatedExpenditure>

    EvaluatedExpenditureClientV1

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

Inherited from

AugmentedEvaluatedExpenditure._deployedPromise


_runningEvents

_runningEvents: Object

Index signature

[eventTag: string]: RunningEvent

Inherited from

AugmentedEvaluatedExpenditure._runningEvents


_wrappedEmits

_wrappedEmits: Object

Index signature

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

Inherited from

AugmentedEvaluatedExpenditure._wrappedEmits


address

Readonly address: string

Inherited from

AugmentedEvaluatedExpenditure.address


callStatic

callStatic: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<string>
deprecate(_deprecated: PromiseOrValue<boolean>, 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>
identifier(overrides?: CallOverrides) => Promise<string>
install(_colony: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
owner(overrides?: CallOverrides) => Promise<string>
setAuthority(authority_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setExpenditurePayoutModifiers(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _id: PromiseOrValue<BigNumberish>, _slots: PromiseOrValue<BigNumberish>[], _payoutModifiers: PromiseOrValue<BigNumberish>[], overrides?: CallOverrides) => Promise<void>
setOwner(owner_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedEvaluatedExpenditure.callStatic


clientType

clientType: EvaluatedExpenditureClient

Inherited from

AugmentedEvaluatedExpenditure.clientType


clientVersion

clientVersion: 1

Overrides

AugmentedEvaluatedExpenditure.clientVersion


colonyClient

colonyClient: AugmentedIColony<ValidColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedEvaluatedExpenditure.colonyClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedEvaluatedExpenditure.deployTransaction


estimateGas

estimateGas: Object

Inherited from

AugmentedEvaluatedExpenditure.estimateGas


evaluatedExpenditureEvents

evaluatedExpenditureEvents: EvaluatedExpenditureEvents

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

Inherited from

AugmentedEvaluatedExpenditure.evaluatedExpenditureEvents


filters

filters: Object

Type declaration

NameType
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

Inherited from

AugmentedEvaluatedExpenditure.filters


functions

functions: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<[string]>
deprecate(_deprecated: PromiseOrValue<boolean>, 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]>
identifier(overrides?: CallOverrides) => Promise<[string]>
install(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setExpenditurePayoutModifiers(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _id: PromiseOrValue<BigNumberish>, _slots: PromiseOrValue<BigNumberish>[], _payoutModifiers: PromiseOrValue<BigNumberish>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setOwner(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
version(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from

AugmentedEvaluatedExpenditure.functions


interface

interface: EvaluatedExpenditureInterface

Inherited from

AugmentedEvaluatedExpenditure.interface


off

off: OnEvent<EvaluatedExpenditureClientV1>

Inherited from

AugmentedEvaluatedExpenditure.off


on

on: OnEvent<EvaluatedExpenditureClientV1>

Inherited from

AugmentedEvaluatedExpenditure.on


once

once: OnEvent<EvaluatedExpenditureClientV1>

Inherited from

AugmentedEvaluatedExpenditure.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate(_deprecated: PromiseOrValue<boolean>, 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>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
install(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setExpenditurePayoutModifiers(_permissionDomainId: PromiseOrValue<BigNumberish>, _childSkillIndex: PromiseOrValue<BigNumberish>, _id: PromiseOrValue<BigNumberish>, _slots: PromiseOrValue<BigNumberish>[], _payoutModifiers: PromiseOrValue<BigNumberish>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setOwner(owner_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedEvaluatedExpenditure.populateTransaction


provider

Readonly provider: Provider

Inherited from

AugmentedEvaluatedExpenditure.provider


removeListener

removeListener: OnEvent<EvaluatedExpenditureClientV1>

Inherited from

AugmentedEvaluatedExpenditure.removeListener


resolvedAddress

Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedEvaluatedExpenditure.resolvedAddress


signer

Readonly signer: Signer

Inherited from

AugmentedEvaluatedExpenditure.signer

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent): void

Parameters

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedEvaluatedExpenditure._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedEvaluatedExpenditure._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedEvaluatedExpenditure._wrapEvent


attach

attach(addressOrName): EvaluatedExpenditureClientV1

Parameters

NameType
addressOrNamestring

Returns

EvaluatedExpenditureClientV1

Inherited from

AugmentedEvaluatedExpenditure.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedEvaluatedExpenditure.authority


connect

connect(signerOrProvider): EvaluatedExpenditureClientV1

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

EvaluatedExpenditureClientV1

Inherited from

AugmentedEvaluatedExpenditure.connect


deployed

deployed(): Promise<EvaluatedExpenditureClientV1>

Returns

Promise<EvaluatedExpenditureClientV1>

Inherited from

AugmentedEvaluatedExpenditure.deployed


deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.deprecate


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedEvaluatedExpenditure.emit


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedEvaluatedExpenditure.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.finishUpgrade


getCapabilityRoles

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

Parameters

NameType
_sigPromiseOrValue<BytesLike>
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedEvaluatedExpenditure.getCapabilityRoles


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedEvaluatedExpenditure.getColony


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedEvaluatedExpenditure.getDeprecated


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedEvaluatedExpenditure.install


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

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

AugmentedEvaluatedExpenditure.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedEvaluatedExpenditure.listeners


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedEvaluatedExpenditure.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): EvaluatedExpenditureClientV1

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

EvaluatedExpenditureClientV1

Inherited from

AugmentedEvaluatedExpenditure.removeAllListeners

removeAllListeners(eventName?): EvaluatedExpenditureClientV1

Parameters

NameType
eventName?string

Returns

EvaluatedExpenditureClientV1

Inherited from

AugmentedEvaluatedExpenditure.removeAllListeners


setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.setAuthority


setExpenditurePayoutModifiers

setExpenditurePayoutModifiers(_permissionDomainId, _childSkillIndex, _id, _slots, _payoutModifiers, overrides?): Promise<ContractTransaction>

Sets the payout modifiers in given expenditure slots, using the arbitration permission

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
_idPromiseOrValue<BigNumberish>Expenditure identifier
_slotsPromiseOrValue<BigNumberish>[]Array of slots to set payout modifiers
_payoutModifiersPromiseOrValue<BigNumberish>[]Values (between +/- WAD) to modify the payout & reputation bonus
overrides?Overrides & { from?: PromiseOrValue<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.setExpenditurePayoutModifiers


setExpenditurePayoutModifiersWithProofs

setExpenditurePayoutModifiersWithProofs(_id, _slots, _payoutModifiers, overrides?): Promise<ContractTransaction>

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

Parameters

NameTypeDescription
_idBigNumberishExpenditure identifier
_slotsBigNumberish[]Array of slots to set payout modifiers
_payoutModifiersBigNumberish[]Values (between +/- WAD) to modify the payout & reputation bonus
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.setExpenditurePayoutModifiersWithProofs


setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.setOwner


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedEvaluatedExpenditure.uninstall


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedEvaluatedExpenditure.version