Skip to main content

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

NameType
approveUsers(_users: string[], _status: boolean, overrides?: CallOverrides) => Promise<void>
approveUsers(address[],bool)(_users: string[], _status: boolean, overrides?: CallOverrides) => Promise<void>
authority(overrides?: CallOverrides) => Promise<string>
authority()(overrides?: CallOverrides) => Promise<string>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
deprecate(bool)(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
finishUpgrade()(overrides?: CallOverrides) => Promise<void>
getAgreementHash(overrides?: CallOverrides) => Promise<string>
getAgreementHash()(overrides?: CallOverrides) => Promise<string>
getApproval(_user: string, overrides?: CallOverrides) => Promise<boolean>
getApproval(address)(_user: string, overrides?: CallOverrides) => Promise<boolean>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getColony(overrides?: CallOverrides) => Promise<string>
getColony()(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getDeprecated()(overrides?: CallOverrides) => Promise<boolean>
getSignature(_user: string, overrides?: CallOverrides) => Promise<boolean>
getSignature(address)(_user: string, overrides?: CallOverrides) => Promise<boolean>
getUseApprovals(overrides?: CallOverrides) => Promise<boolean>
getUseApprovals()(overrides?: CallOverrides) => Promise<boolean>
identifier(overrides?: CallOverrides) => Promise<string>
identifier()(overrides?: CallOverrides) => Promise<string>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: CallOverrides) => Promise<void>
initialise(bool,string)(_useApprovals: boolean, _agreementHash: string, overrides?: CallOverrides) => Promise<void>
install(_colony: string, overrides?: CallOverrides) => Promise<void>
install(address)(_colony: string, overrides?: CallOverrides) => Promise<void>
isApproved(_user: string, overrides?: CallOverrides) => Promise<boolean>
isApproved(address)(_user: string, overrides?: CallOverrides) => Promise<boolean>
owner(overrides?: CallOverrides) => Promise<string>
owner()(overrides?: CallOverrides) => Promise<string>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setAuthority(address)(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
setOwner(address)(owner_: string, overrides?: CallOverrides) => Promise<void>
signAgreement(_agreementHash: string, overrides?: CallOverrides) => Promise<void>
signAgreement(string)(_agreementHash: string, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
uninstall()(overrides?: CallOverrides) => Promise<void>
version(overrides?: CallOverrides) => Promise<BigNumber>
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

An instance of the corresponding ColonyClient

Inherited from

AugmentedWhitelist.colonyClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedWhitelist.deployTransaction


estimateGas

estimateGas: Object

Type declaration

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

Inherited from

AugmentedWhitelist.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
UserApproved(_user?: null | string, _status?: null) => UserApprovedEventFilter
UserApproved(address,bool)(_user?: null | string, _status?: null) => UserApprovedEventFilter

Inherited from

AugmentedWhitelist.filters


functions

functions: Object

Type declaration

NameType
approveUsers(_users: string[], _status: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
approveUsers(address[],bool)(_users: string[], _status: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
authority(overrides?: CallOverrides) => Promise<[string]>
authority()(overrides?: CallOverrides) => Promise<[string]>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
getAgreementHash(overrides?: CallOverrides) => Promise<[string]>
getAgreementHash()(overrides?: CallOverrides) => Promise<[string]>
getApproval(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getApproval(address)(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getColony()(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getDeprecated()(overrides?: CallOverrides) => Promise<[boolean]>
getSignature(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getSignature(address)(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
getUseApprovals(overrides?: CallOverrides) => Promise<[boolean]>
getUseApprovals()(overrides?: CallOverrides) => Promise<[boolean]>
identifier(overrides?: CallOverrides) => Promise<[string]>
identifier()(overrides?: CallOverrides) => Promise<[string]>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
initialise(bool,string)(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
isApproved(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
isApproved(address)(_user: string, overrides?: CallOverrides) => Promise<[boolean]>
owner(overrides?: CallOverrides) => Promise<[string]>
owner()(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
signAgreement(_agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
signAgreement(string)(_agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
version(overrides?: CallOverrides) => Promise<[BigNumber]>
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

NameType
approveUsers(_users: string[], _status: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
approveUsers(address[],bool)(_users: string[], _status: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
authority()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
getAgreementHash(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getAgreementHash()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getApproval(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getApproval(address)(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSignature(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSignature(address)(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUseApprovals(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUseApprovals()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
initialise(bool,string)(_useApprovals: boolean, _agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
isApproved(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
isApproved(address)(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
signAgreement(_agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
signAgreement(string)(_agreementHash: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => 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

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedWhitelist._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedWhitelist._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.approveUsers


approveUsers(address[],bool)

approveUsers(address[],bool)(_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 }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.approveUsers(address[],bool)


attach

attach(addressOrName): WhitelistClientV1

Parameters

NameType
addressOrNamestring

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.authority


authority()

authority()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.authority()


connect

connect(signerOrProvider): WhitelistClientV1

Parameters

NameType
signerOrProviderstring | Signer | Provider

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

NameType
_deprecatedboolean
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.deprecate


deprecate(bool)

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

Called when deprecating (or undeprecating) the extension

Parameters

NameType
_deprecatedboolean
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.deprecate(bool)


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedWhitelist.emit


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedWhitelist.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.finishUpgrade


finishUpgrade()

finishUpgrade()(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.finishUpgrade()


getAgreementHash

getAgreementHash(overrides?): Promise<string>

Get the agreementHash

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getAgreementHash


getAgreementHash()

getAgreementHash()(overrides?): Promise<string>

Get the agreementHash

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedWhitelist.getApproval


getApproval(address)

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

Get the user's approval status

Parameters

NameTypeDescription
_userstringThe address of the user
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getApproval(address)


getCapabilityRoles

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

Parameters

NameType
_sigBytesLike
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getCapabilityRoles


getCapabilityRoles(bytes4)

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

Parameters

NameType
_sigBytesLike
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getCapabilityRoles(bytes4)


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getColony


getColony()

getColony()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.getColony()


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getDeprecated


getDeprecated()

getDeprecated()(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getDeprecated()


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

AugmentedWhitelist.getSignature


getSignature(address)

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

Get the user's signature status

Parameters

NameTypeDescription
_userstringThe address of the user
overrides?CallOverrides-

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getSignature(address)


getUseApprovals

getUseApprovals(overrides?): Promise<boolean>

Get the useApprovals boolean

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getUseApprovals


getUseApprovals()

getUseApprovals()(overrides?): Promise<boolean>

Get the useApprovals boolean

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedWhitelist.getUseApprovals()


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.identifier


identifier()

identifier()(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.initialise


initialise(bool,string)

initialise(bool,string)(_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 }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.initialise(bool,string)


install

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.install


install(address)

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.install(address)


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

AugmentedWhitelist.isApproved


isApproved(address)

isApproved(address)(_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

AugmentedWhitelist.isApproved(address)


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

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

AugmentedWhitelist.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedWhitelist.listeners


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedWhitelist.owner


owner()

owner()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedWhitelist.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): WhitelistClientV1

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.removeAllListeners

removeAllListeners(eventName?): WhitelistClientV1

Parameters

NameType
eventName?string

Returns

WhitelistClientV1

Inherited from

AugmentedWhitelist.removeAllListeners


setAuthority

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

Parameters

NameType
authority_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setAuthority


setAuthority(address)

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

Parameters

NameType
authority_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setAuthority(address)


setOwner

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

Parameters

NameType
owner_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setOwner


setOwner(address)

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

Parameters

NameType
owner_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.setOwner(address)


signAgreement

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

The user's signature on the agreement

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.signAgreement


signAgreement(string)

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

The user's signature on the agreement

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.signAgreement(string)


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.uninstall


uninstall()

uninstall()(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedWhitelist.uninstall()


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelist.version


version()

version()(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedWhitelist.version()