Interface: TokenSupplierClientV4

Hierarchy

• AugmentedTokenSupplier<TokenSupplier>

  ↳ TokenSupplierClientV4

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

AugmentedTokenSupplier._deployedPromise

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

AugmentedTokenSupplier._runningEvents

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

AugmentedTokenSupplier._wrappedEmits

---

address

• Readonly address: string

Inherited from

AugmentedTokenSupplier.address

---

callStatic

• callStatic: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<string>
deprecate	(_deprecated: PromiseOrValue<boolean>, overrides?: CallOverrides) => Promise<void>
executeMetaTransaction	(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<string>
finishUpgrade	(overrides?: CallOverrides) => Promise<void>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<string>
getChainId	(overrides?: CallOverrides) => Promise<BigNumber>
getColony	(overrides?: CallOverrides) => Promise<string>
getDeprecated	(overrides?: CallOverrides) => Promise<boolean>
getLastPinged	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<string>
initialise	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, _tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
install	(_colony: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
issueTokens	(overrides?: CallOverrides) => Promise<void>
multicall	(data: PromiseOrValue<BytesLike>[], overrides?: CallOverrides) => Promise<string[]>
owner	(overrides?: CallOverrides) => Promise<string>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setOwner	(owner_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setTokenIssuanceRate	(_tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
setTokenSupplyCeiling	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
uninstall	(overrides?: CallOverrides) => Promise<void>
verify	(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<boolean>
version	(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.callStatic

---

clientType

• clientType: TokenSupplierClient

Inherited from

AugmentedTokenSupplier.clientType

---

clientVersion

• clientVersion: 4

Overrides

AugmentedTokenSupplier.clientVersion

---

colonyClient

• colonyClient: AugmentedIColony<AnyIColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedTokenSupplier.colonyClient

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedTokenSupplier.deployTransaction

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<BigNumber>
deprecate	(_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
executeMetaTransaction	(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
finishUpgrade	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber>
getChainId	(overrides?: CallOverrides) => Promise<BigNumber>
getColony	(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated	(overrides?: CallOverrides) => Promise<BigNumber>
getLastPinged	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<BigNumber>
initialise	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, _tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
install	(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
issueTokens	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
multicall	(data: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => 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>
setTokenIssuanceRate	(_tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
setTokenSupplyCeiling	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
verify	(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<BigNumber>
version	(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.estimateGas

---

filters

• filters: Object

Type declaration

Name	Type
ExtensionInitialised	() => ExtensionInitialisedEventFilter
ExtensionInitialised()	() => ExtensionInitialisedEventFilter
LogSetAuthority	(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetAuthority(address)	(authority?: null | PromiseOrValue<string>) => LogSetAuthorityEventFilter
LogSetOwner	(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
LogSetOwner(address)	(owner?: null | PromiseOrValue<string>) => LogSetOwnerEventFilter
MetaTransactionExecuted	(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
MetaTransactionExecuted(address,address,bytes)	(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
TokenIssuanceRateSet	(tokenIssuanceRate?: null) => TokenIssuanceRateSetEventFilter
TokenIssuanceRateSet(uint256)	(tokenIssuanceRate?: null) => TokenIssuanceRateSetEventFilter
TokenSupplyCeilingSet	(tokenSupplyCeiling?: null) => TokenSupplyCeilingSetEventFilter
TokenSupplyCeilingSet(uint256)	(tokenSupplyCeiling?: null) => TokenSupplyCeilingSetEventFilter
TokensIssued	(numTokens?: null) => TokensIssuedEventFilter
TokensIssued(uint256)	(numTokens?: null) => TokensIssuedEventFilter

Inherited from

AugmentedTokenSupplier.filters

---

functions

• functions: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<[string]>
deprecate	(_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
executeMetaTransaction	(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
finishUpgrade	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[string]>
getChainId	(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony	(overrides?: CallOverrides) => Promise<[string]>
getDeprecated	(overrides?: CallOverrides) => Promise<[boolean]>
getLastPinged	(overrides?: CallOverrides) => Promise<[BigNumber] & { lastPinged: BigNumber }>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<[BigNumber] & { lastUpdate: BigNumber }>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<[BigNumber] & { issuanceRate: BigNumber }>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<[BigNumber] & { supplyCeiling: BigNumber }>
identifier	(overrides?: CallOverrides) => Promise<[string] & { _identifier: string }>
initialise	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, _tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
install	(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
issueTokens	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
multicall	(data: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
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>
setTokenIssuanceRate	(_tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
setTokenSupplyCeiling	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
verify	(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<[boolean]>
version	(overrides?: CallOverrides) => Promise<[BigNumber] & { _version: BigNumber }>

Inherited from

AugmentedTokenSupplier.functions

---

interface

• interface: TokenSupplierInterface

Inherited from

AugmentedTokenSupplier.interface

---

off

• off: OnEvent<TokenSupplierClientV4>

Inherited from

AugmentedTokenSupplier.off

---

on

• on: OnEvent<TokenSupplierClientV4>

Inherited from

AugmentedTokenSupplier.on

---

once

• once: OnEvent<TokenSupplierClientV4>

Inherited from

AugmentedTokenSupplier.once

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate	(_deprecated: PromiseOrValue<boolean>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
executeMetaTransaction	(_user: PromiseOrValue<string>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
finishUpgrade	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastPinged	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, _tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
install	(_colony: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
issueTokens	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
multicall	(data: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string> }) => 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>
setTokenIssuanceRate	(_tokenIssuanceRate: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
setTokenSupplyCeiling	(_tokenSupplyCeiling: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
verify	(_owner: PromiseOrValue<string>, _nonce: PromiseOrValue<BigNumberish>, _chainId: PromiseOrValue<BigNumberish>, _payload: PromiseOrValue<BytesLike>, _sigR: PromiseOrValue<BytesLike>, _sigS: PromiseOrValue<BytesLike>, _sigV: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
version	(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedTokenSupplier.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

AugmentedTokenSupplier.provider

---

removeListener

• removeListener: OnEvent<TokenSupplierClientV4>

Inherited from

AugmentedTokenSupplier.removeListener

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedTokenSupplier.resolvedAddress

---

signer

• Readonly signer: Signer

Inherited from

AugmentedTokenSupplier.signer

---

tokenSupplierEvents

• tokenSupplierEvents: TokenSupplierEvents

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

Inherited from

AugmentedTokenSupplier.tokenSupplierEvents

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

AugmentedTokenSupplier._checkRunningEvents

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedTokenSupplier._deployed

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

AugmentedTokenSupplier._wrapEvent

---

attach

▸ attach(addressOrName): TokenSupplierClientV4

Parameters

Name	Type
addressOrName	string

Returns

TokenSupplierClientV4

Inherited from

AugmentedTokenSupplier.attach

---

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.authority

---

connect

▸ connect(signerOrProvider): TokenSupplierClientV4

Parameters

Name	Type
signerOrProvider	string | Provider | Signer

Returns

TokenSupplierClientV4

Inherited from

AugmentedTokenSupplier.connect

---

deployed

▸ deployed(): Promise<TokenSupplierClientV4>

Returns

Promise<TokenSupplierClientV4>

Inherited from

AugmentedTokenSupplier.deployed

---

deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

Name	Type	Description
_deprecated	PromiseOrValue<boolean>	Indicates whether the extension should be deprecated or undeprecated
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.deprecate

---

emit

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

Parameters

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

Returns

boolean

Inherited from

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

Name	Type	Description
_user	PromiseOrValue<string>	Address of user trying to do meta transaction
_payload	PromiseOrValue<BytesLike>	Function call to make via meta transaction
_sigR	PromiseOrValue<BytesLike>	R part of the signature
_sigS	PromiseOrValue<BytesLike>	S part of the signature
_sigV	PromiseOrValue<BigNumberish>	V part of the signature
overrides?	PayableOverrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.executeMetaTransaction

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedTokenSupplier.fallback

---

finishUpgrade

▸ finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension (currently a no-op)

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.finishUpgrade

---

getCapabilityRoles

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

Parameters

Name	Type
_sig	PromiseOrValue<BytesLike>
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.getCapabilityRoles

---

getChainId

▸ getChainId(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getChainId

---

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.getColony

---

getDeprecated

▸ getDeprecated(overrides?): Promise<boolean>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedTokenSupplier.getDeprecated

---

getLastPinged

▸ getLastPinged(overrides?): Promise<BigNumber>

Get the time of the last token minting event

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastPinged

---

getLastRateUpdate

▸ getLastRateUpdate(overrides?): Promise<BigNumber>

Get the time of the last change in issuance rate

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastRateUpdate

---

getMetatransactionNonce

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

Gets the next nonce for a meta-transaction

Parameters

Name	Type	Description
userAddress	PromiseOrValue<string>	The user's address
overrides?	CallOverrides	-

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getMetatransactionNonce

---

getTokenIssuanceRate

▸ getTokenIssuanceRate(overrides?): Promise<BigNumber>

Get the token issuance rate

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getTokenIssuanceRate

---

getTokenSupplyCeiling

▸ getTokenSupplyCeiling(overrides?): Promise<BigNumber>

Get the token supply ceiling

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getTokenSupplyCeiling

---

identifier

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.identifier

---

initialise

▸ initialise(_tokenSupplyCeiling, _tokenIssuanceRate, overrides?): Promise<ContractTransaction>

Initialise the extension, must be called before any tokens can be issued

Parameters

Name	Type	Description
_tokenSupplyCeiling	PromiseOrValue<BigNumberish>	Total amount of tokens to issue
_tokenIssuanceRate	PromiseOrValue<BigNumberish>	Number of tokens to issue per day
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

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

AugmentedTokenSupplier.install

---

issueTokens

▸ issueTokens(overrides?): Promise<ContractTransaction>

Issue the appropriate amount of tokens

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.issueTokens

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

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

AugmentedTokenSupplier.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Inherited from

AugmentedTokenSupplier.listeners

---

multicall

▸ multicall(data, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
data	PromiseOrValue<BytesLike>[]
overrides?	Overrides & { from?: PromiseOrValue<string> }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.multicall

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedTokenSupplier.queryFilter

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): TokenSupplierClientV4

Type parameters

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

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

TokenSupplierClientV4

Inherited from

AugmentedTokenSupplier.removeAllListeners

▸ removeAllListeners(eventName?): TokenSupplierClientV4

Parameters

Name	Type
eventName?	string

Returns

TokenSupplierClientV4

Inherited from

AugmentedTokenSupplier.removeAllListeners

---

setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setAuthority

---

setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setOwner

---

setTokenIssuanceRate

▸ setTokenIssuanceRate(_tokenIssuanceRate, overrides?): Promise<ContractTransaction>

Update the tokenIssuanceRate

Parameters

Name	Type	Description
_tokenIssuanceRate	PromiseOrValue<BigNumberish>	Number of tokens to issue per day
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenIssuanceRate

---

setTokenSupplyCeiling

▸ setTokenSupplyCeiling(_tokenSupplyCeiling, overrides?): Promise<ContractTransaction>

Update the tokenSupplyCeiling, cannot set below current tokenSupply

Parameters

Name	Type	Description
_tokenSupplyCeiling	PromiseOrValue<BigNumberish>	Total amount of tokens to issue
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenSupplyCeiling

---

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.uninstall

---

verify

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

Parameters

Name	Type
_owner	PromiseOrValue<string>
_nonce	PromiseOrValue<BigNumberish>
_chainId	PromiseOrValue<BigNumberish>
_payload	PromiseOrValue<BytesLike>
_sigR	PromiseOrValue<BytesLike>
_sigS	PromiseOrValue<BytesLike>
_sigV	PromiseOrValue<BigNumberish>
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedTokenSupplier.verify

---

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.version