Interface: WhitelistClientV1

Hierarchy

AugmentedWhitelist<Whitelist>
↳ WhitelistClientV1

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

AugmentedWhitelist._deployedPromise

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

AugmentedWhitelist._runningEvents

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

AugmentedWhitelist._wrappedEmits

address

• Readonly address: string

Inherited from

AugmentedWhitelist.address

callStatic

• callStatic: Object

Type declaration

Name	Type
`approveUsers`	(`_users`: `PromiseOrValue`<`string`>[], `_status`: `PromiseOrValue`<`boolean`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`finishUpgrade`	(`overrides?`: `CallOverrides`) => `Promise`<`void`>
`getAgreementHash`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`getApproval`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<`string`>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`getSignature`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`getUseApprovals`	(`overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`initialise`	(`_useApprovals`: `PromiseOrValue`<`boolean`>, `_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`isApproved`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`signAgreement`	(`_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`uninstall`	(`overrides?`: `CallOverrides`) => `Promise`<`void`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>

Inherited from

AugmentedWhitelist.callStatic

clientType

• clientType: WhitelistClient

Inherited from

AugmentedWhitelist.clientType

clientVersion

• clientVersion: 1

Overrides

AugmentedWhitelist.clientVersion

colonyClient

• colonyClient: AugmentedIColony<AnyIColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedWhitelist.colonyClient

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedWhitelist.deployTransaction

estimateGas

• estimateGas: Object

Type declaration

Name	Type
`approveUsers`	(`_users`: `PromiseOrValue`<`string`>[], `_status`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`finishUpgrade`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`getAgreementHash`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getApproval`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getSignature`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getUseApprovals`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`initialise`	(`_useApprovals`: `PromiseOrValue`<`boolean`>, `_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`isApproved`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`signAgreement`	(`_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`uninstall`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`BigNumber`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>

Inherited from

AugmentedWhitelist.estimateGas

filters

• filters: Object

Type declaration

Name	Type
`AgreementSigned`	(`_user?`: `null` \| `PromiseOrValue`<`string`>) => `AgreementSignedEventFilter`
`AgreementSigned(address)`	(`_user?`: `null` \| `PromiseOrValue`<`string`>) => `AgreementSignedEventFilter`
`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`
`UserApproved`	(`_user?`: `null` \| `PromiseOrValue`<`string`>, `_status?`: `null`) => `UserApprovedEventFilter`
`UserApproved(address,bool)`	(`_user?`: `null` \| `PromiseOrValue`<`string`>, `_status?`: `null`) => `UserApprovedEventFilter`

Inherited from

AugmentedWhitelist.filters

functions

• functions: Object

Type declaration

Name	Type
`approveUsers`	(`_users`: `PromiseOrValue`<`string`>[], `_status`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`finishUpgrade`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`getAgreementHash`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`getApproval`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`getSignature`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`getUseApprovals`	(`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`initialise`	(`_useApprovals`: `PromiseOrValue`<`boolean`>, `_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`isApproved`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`signAgreement`	(`_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`uninstall`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>

Inherited from

AugmentedWhitelist.functions

interface

• interface: WhitelistInterface

Inherited from

AugmentedWhitelist.interface

off

• off: OnEvent<WhitelistClientV1>

Inherited from

AugmentedWhitelist.off

on

• on: OnEvent<WhitelistClientV1>

Inherited from

AugmentedWhitelist.on

once

• once: OnEvent<WhitelistClientV1>

Inherited from

AugmentedWhitelist.once

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
`approveUsers`	(`_users`: `PromiseOrValue`<`string`>[], `_status`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`finishUpgrade`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`getAgreementHash`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getApproval`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getSignature`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getUseApprovals`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`initialise`	(`_useApprovals`: `PromiseOrValue`<`boolean`>, `_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`isApproved`	(`_user`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`signAgreement`	(`_agreementHash`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`uninstall`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>

Inherited from

AugmentedWhitelist.populateTransaction

provider

• Readonly provider: Provider

Inherited from

AugmentedWhitelist.provider

removeListener

• removeListener: OnEvent<WhitelistClientV1>

Inherited from

AugmentedWhitelist.removeListener

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedWhitelist.resolvedAddress

signer

• Readonly signer: Signer

Inherited from

AugmentedWhitelist.signer

whitelistEvents

• whitelistEvents: WhitelistEvents

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

Inherited from

AugmentedWhitelist.whitelistEvents

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
`runningEvent`	`RunningEvent`

Returns

void

Inherited from

AugmentedWhitelist._checkRunningEvents

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
`blockTag?`	`BlockTag`

Returns

Promise<Contract>

Inherited from

AugmentedWhitelist._deployed

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
`runningEvent`	`RunningEvent`
`log`	`Log`
`listener`	`Listener`

Returns

Event

Inherited from

AugmentedWhitelist._wrapEvent

approveUsers

▸ approveUsers(_users, _status, overrides?): Promise<ContractTransaction>

Sets user statuses in the whitelist

Parameters

Name	Type	Description
`_users`	`PromiseOrValue`<`string`>[]	An array of user addresses
`_status`	`PromiseOrValue`<`boolean`>	The whitelist status to set
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.approveUsers

attach

▸ attach(addressOrName): WhitelistClientV1

Parameters

Name	Type
`addressOrName`	`string`

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.attach

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.authority

connect

▸ connect(signerOrProvider): WhitelistClientV1

Parameters

Name	Type
`signerOrProvider`	`string` \| `Provider` \| `Signer`

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.connect

deployed

▸ deployed(): Promise<WhitelistClientV1>

Returns

Promise<WhitelistClientV1>

Inherited from

AugmentedWhitelist.deployed

deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

Name	Type
`_deprecated`	`PromiseOrValue`<`boolean`>
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.deprecate

emit

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

Parameters

Name	Type
`eventName`	`string` \| `EventFilter`
`...args`	`any`[]

Returns

boolean

Inherited from

AugmentedWhitelist.emit

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
`overrides?`	`TransactionRequest`

Returns

Promise<TransactionResponse>

Inherited from

AugmentedWhitelist.fallback

finishUpgrade

▸ finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

Name	Type
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.finishUpgrade

getAgreementHash

▸ getAgreementHash(overrides?): Promise<string>

Get the agreementHash

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getAgreementHash

getApproval

▸ getApproval(_user, overrides?): Promise<boolean>

Get the user's approval status

Parameters

Name	Type	Description
`_user`	`PromiseOrValue`<`string`>	The address of the user
`overrides?`	`CallOverrides`	-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getApproval

getCapabilityRoles

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

Parameters

Name	Type
`_sig`	`PromiseOrValue`<`BytesLike`>
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getCapabilityRoles

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getColony

getDeprecated

▸ getDeprecated(overrides?): Promise<boolean>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getDeprecated

getSignature

▸ getSignature(_user, overrides?): Promise<boolean>

Get the user's signature status

Parameters

Name	Type	Description
`_user`	`PromiseOrValue`<`string`>	The address of the user
`overrides?`	`CallOverrides`	-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getSignature

getUseApprovals

▸ getUseApprovals(overrides?): Promise<boolean>

Get the useApprovals boolean

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getUseApprovals

identifier

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.identifier

initialise

▸ initialise(_useApprovals, _agreementHash, overrides?): Promise<ContractTransaction>

Initialise the extension

Parameters

Name	Type	Description
`_useApprovals`	`PromiseOrValue`<`boolean`>	Whether or not to require administrative approval
`_agreementHash`	`PromiseOrValue`<`string`>	An agreement hash (such as an IPFS URI)
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.initialise

install

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

Configures the extension

Parameters

Name	Type	Description
`_colony`	`PromiseOrValue`<`string`>	The colony in which the extension holds permissions
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.install

isApproved

▸ isApproved(_user, overrides?): Promise<boolean>

Get the user's overall whitelist status

Parameters

Name	Type	Description
`_user`	`PromiseOrValue`<`string`>	The address of the user
`overrides?`	`CallOverrides`	-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.isApproved

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
`eventName?`	`string` \| `EventFilter`

Returns

number

Inherited from

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

AugmentedWhitelist.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
`eventName?`	`string`

Returns

Listener[]

Inherited from

AugmentedWhitelist.listeners

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedWhitelist.owner

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

AugmentedWhitelist.queryFilter

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): WhitelistClientV1

Type parameters

Name	Type
`TEvent`	extends `TypedEvent`<`any`, `any`, `TEvent`>

Parameters

Name	Type
`eventFilter`	`TypedEventFilter`<`TEvent`>

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.removeAllListeners

▸ removeAllListeners(eventName?): WhitelistClientV1

Parameters

Name	Type
`eventName?`	`string`

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.removeAllListeners

setAuthority

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

Parameters

Name	Type
`authority_`	`PromiseOrValue`<`string`>
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setAuthority

setOwner

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

Parameters

Name	Type
`owner_`	`PromiseOrValue`<`string`>
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setOwner

signAgreement

▸ signAgreement(_agreementHash, overrides?): Promise<ContractTransaction>

The user's signature on the agreement

Parameters

Name	Type	Description
`_agreementHash`	`PromiseOrValue`<`string`>	The agreement hash being signed
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.signAgreement

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

Name	Type
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.uninstall

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelist.version

Interface: WhitelistClientV1

Hierarchy​

Properties​

_deployedPromise​

Inherited from​

_runningEvents​

Index signature​

Inherited from​

_wrappedEmits​

Index signature​

Inherited from​

address​

Inherited from​

callStatic​

Type declaration​

Inherited from​

clientType​

Inherited from​

clientVersion​

Overrides​

colonyClient​

Inherited from​

deployTransaction​

Inherited from​

estimateGas​

Type declaration​

Inherited from​

filters​

Type declaration​

Inherited from​

functions​

Type declaration​

Inherited from​

interface​

Inherited from​

off​

Inherited from​

on​

Inherited from​

once​

Inherited from​

populateTransaction​

Type declaration​

Inherited from​

provider​

Inherited from​

removeListener​

Inherited from​

resolvedAddress​

Inherited from​

signer​

Inherited from​

whitelistEvents​

Inherited from​

Methods​

_checkRunningEvents​

Parameters​

Returns​

Inherited from​

_deployed​

Parameters​

Returns​

Inherited from​

_wrapEvent​

Parameters​

Returns​

Inherited from​

approveUsers​

Parameters​

Returns​

Inherited from​

attach​

Parameters​

Returns​

Inherited from​

authority​

Parameters​

Returns​

Inherited from​

connect​

Hierarchy

Properties

_deployedPromise

Inherited from

_runningEvents

Index signature

Inherited from

_wrappedEmits

Index signature

Inherited from

address

Inherited from

callStatic

Type declaration

Inherited from

clientType

Inherited from

clientVersion

Overrides

colonyClient

Inherited from

deployTransaction

Inherited from

estimateGas

Type declaration

Inherited from

filters

Type declaration

Inherited from

functions

Type declaration

Inherited from

interface

Inherited from

off

Inherited from

on

Inherited from

once

Inherited from

populateTransaction

Type declaration

Inherited from

provider

Inherited from

removeListener

Inherited from

resolvedAddress

Inherited from

signer

Inherited from

whitelistEvents

Inherited from

Methods

_checkRunningEvents

Parameters

Returns

Inherited from

_deployed

Parameters

Returns

Inherited from

_wrapEvent

Parameters

Returns

Inherited from

approveUsers

Parameters

Returns

Inherited from

attach

Parameters

Returns

Inherited from

authority

Parameters

Returns

Inherited from

connect

Parameters