Skip to main content

Interface: WhitelistClientV2

Hierarchy

  • AugmentedWhitelst<Whitelist>

    WhitelistClientV2

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

Inherited from

AugmentedWhitelst._deployedPromise


_runningEvents

_runningEvents: Object

Index signature

[eventTag: string]: RunningEvent

Inherited from

AugmentedWhitelst._runningEvents


_wrappedEmits

_wrappedEmits: Object

Index signature

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

Inherited from

AugmentedWhitelst._wrappedEmits


address

Readonly address: string

Inherited from

AugmentedWhitelst.address


callStatic

callStatic: Object

Type declaration

NameType
approveUsers(_users: string[], _status: boolean, overrides?: CallOverrides) => Promise<void>
authority(overrides?: CallOverrides) => Promise<string>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<string>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
getAgreementHash(overrides?: CallOverrides) => Promise<string>
getApproval(_user: string, overrides?: CallOverrides) => Promise<boolean>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getChainId(overrides?: CallOverrides) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<BigNumber>
getSignature(_user: string, overrides?: CallOverrides) => Promise<boolean>
getUseApprovals(overrides?: CallOverrides) => Promise<boolean>
identifier(overrides?: CallOverrides) => Promise<string>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: CallOverrides) => Promise<void>
install(_colony: string, overrides?: CallOverrides) => Promise<void>
isApproved(_user: string, overrides?: CallOverrides) => Promise<boolean>
owner(overrides?: CallOverrides) => Promise<string>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
signAgreement(_agreementHash: string, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedWhitelst.callStatic


clientType

clientType: WhitelistClient

Inherited from

AugmentedWhitelst.clientType


clientVersion

clientVersion: 2

Overrides

AugmentedWhitelst.clientVersion


colonyClient

colonyClient: AugmentedIColony<AnyIColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedWhitelst.colonyClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedWhitelst.deployTransaction


estimateGas

estimateGas: Object

Type declaration

NameType
approveUsers(_users: string[], _status: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
authority(overrides?: CallOverrides) => Promise<BigNumber>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<BigNumber>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
getAgreementHash(overrides?: CallOverrides) => Promise<BigNumber>
getApproval(_user: string, overrides?: CallOverrides) => Promise<BigNumber>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<BigNumber>
getChainId(overrides?: CallOverrides) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated(overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<BigNumber>
getSignature(_user: string, overrides?: CallOverrides) => Promise<BigNumber>
getUseApprovals(overrides?: CallOverrides) => Promise<BigNumber>
identifier(overrides?: CallOverrides) => Promise<BigNumber>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
isApproved(_user: string, overrides?: CallOverrides) => Promise<BigNumber>
owner(overrides?: CallOverrides) => Promise<BigNumber>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
signAgreement(_agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedWhitelst.estimateGas


filters

filters: Object

Type declaration

NameType
AgreementSigned(_user?: null | string) => AgreementSignedEventFilter
AgreementSigned(address)(_user?: null | string) => AgreementSignedEventFilter
ExtensionInitialised() => ExtensionInitialisedEventFilter
ExtensionInitialised()() => ExtensionInitialisedEventFilter
LogSetAuthority(authority?: null | string) => LogSetAuthorityEventFilter
LogSetAuthority(address)(authority?: null | string) => LogSetAuthorityEventFilter
LogSetOwner(owner?: null | string) => LogSetOwnerEventFilter
LogSetOwner(address)(owner?: null | string) => LogSetOwnerEventFilter
MetaTransactionExecuted(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
MetaTransactionExecuted(address,address,bytes)(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
UserApproved(_user?: null | string, _status?: null) => UserApprovedEventFilter
UserApproved(address,bool)(_user?: null | string, _status?: null) => UserApprovedEventFilter

Inherited from

AugmentedWhitelst.filters


functions

functions: Object

Type declaration

NameType
approveUsers(_users: string[], _status: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
authority(overrides?: CallOverrides) => Promise<[string]>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
getAgreementHash(overrides?: CallOverrides) => Promise<[string]>
getApproval(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getChainId(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getSignature(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getUseApprovals(overrides?: CallOverrides) => Promise<[boolean]>
identifier(overrides?: CallOverrides) => Promise<[string]>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
isApproved(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
owner(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
signAgreement(_agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
version(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from

AugmentedWhitelst.functions


interface

interface: WhitelistInterface

Inherited from

AugmentedWhitelst.interface


off

off: OnEvent<WhitelistClientV2>

Inherited from

AugmentedWhitelst.off


on

on: OnEvent<WhitelistClientV2>

Inherited from

AugmentedWhitelst.on


once

once: OnEvent<WhitelistClientV2>

Inherited from

AugmentedWhitelst.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
approveUsers(_users: string[], _status: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
getAgreementHash(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getApproval(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSignature(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUseApprovals(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
isApproved(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
signAgreement(_agreementHash: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedWhitelst.populateTransaction


provider

Readonly provider: Provider

Inherited from

AugmentedWhitelst.provider


removeListener

removeListener: OnEvent<WhitelistClientV2>

Inherited from

AugmentedWhitelst.removeListener


resolvedAddress

Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedWhitelst.resolvedAddress


signer

Readonly signer: Signer

Inherited from

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

AugmentedWhitelst.whitelistEvents

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent): void

Parameters

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedWhitelst._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedWhitelst._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedWhitelst._wrapEvent


approveUsers

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

Sets user statuses in the whitelist

Parameters

NameTypeDescription
_usersstring[]An array of user addresses
_statusbooleanThe whitelist status to set
overrides?Overrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.approveUsers


attach

attach(addressOrName): WhitelistClientV2

Parameters

NameType
addressOrNamestring

Returns

WhitelistClientV2

Inherited from

AugmentedWhitelst.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelst.authority


connect

connect(signerOrProvider): WhitelistClientV2

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

WhitelistClientV2

Inherited from

AugmentedWhitelst.connect


deployed

deployed(): Promise<WhitelistClientV2>

Returns

Promise<WhitelistClientV2>

Inherited from

AugmentedWhitelst.deployed


deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

NameType
_deprecatedboolean
overrides?Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.deprecate


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedWhitelst.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
_userstringAddress of user trying to do meta transaction
_payloadBytesLikeFunction call to make via meta transaction
_sigRBytesLikeR part of the signature
_sigSBytesLikeS part of the signature
_sigVBigNumberishV part of the signature
overrides?PayableOverrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.executeMetaTransaction


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedWhitelst.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.finishUpgrade


getAgreementHash

getAgreementHash(overrides?): Promise<string>

Get the agreementHash

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelst.getAgreementHash


getApproval

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

Get the user's approval status

Parameters

NameTypeDescription
_userstringThe address of the user
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.getApproval


getCapabilityRoles

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

Parameters

NameType
_sigBytesLike
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelst.getCapabilityRoles


getChainId

getChainId(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelst.getChainId


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelst.getColony


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.getDeprecated


getMetatransactionNonce

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

Parameters

NameType
userAddressstring
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelst.getMetatransactionNonce


getSignature

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

Get the user's signature status

Parameters

NameTypeDescription
_userstringThe address of the user
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.getSignature


getUseApprovals

getUseApprovals(overrides?): Promise<boolean>

Get the useApprovals boolean

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.getUseApprovals


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelst.identifier


initialise

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

Initialise the extension

Parameters

NameTypeDescription
_useApprovalsbooleanWhether or not to require administrative approval
_agreementHashstringAn agreement hash (such as an IPFS URI)
overrides?Overrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.initialise


install

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

Configures the extension

Parameters

NameTypeDescription
_colonystringThe colony in which the extension holds permissions
overrides?Overrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.install


isApproved

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

Get the user's overall whitelist status

Parameters

NameTypeDescription
_userstringThe address of the user
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.isApproved


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

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

AugmentedWhitelst.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedWhitelst.listeners


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedWhitelst.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): WhitelistClientV2

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

WhitelistClientV2

Inherited from

AugmentedWhitelst.removeAllListeners

removeAllListeners(eventName?): WhitelistClientV2

Parameters

NameType
eventName?string

Returns

WhitelistClientV2

Inherited from

AugmentedWhitelst.removeAllListeners


setAuthority

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

Parameters

NameType
authority_string
overrides?Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.setAuthority


setOwner

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

Parameters

NameType
owner_string
overrides?Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.setOwner


signAgreement

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

The user's signature on the agreement

Parameters

NameTypeDescription
_agreementHashstringThe agreement hash being signed
overrides?Overrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.signAgreement


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelst.uninstall


verify

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

Parameters

NameType
_ownerstring
_nonceBigNumberish
_chainIdBigNumberish
_payloadBytesLike
_sigRBytesLike
_sigSBytesLike
_sigVBigNumberish
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelst.verify


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelst.version