Interface: TokenSupplierClientV1

Hierarchy

• AugmentedTokenSupplier<TokenSupplier>

  ↳ TokenSupplierClientV1

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>
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>
getColony	(overrides?: CallOverrides) => Promise<string>
getColony()	(overrides?: CallOverrides) => Promise<string>
getDeprecated	(overrides?: CallOverrides) => Promise<boolean>
getDeprecated()	(overrides?: CallOverrides) => Promise<boolean>
getLastPinged	(overrides?: CallOverrides) => Promise<BigNumber>
getLastPinged()	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate()	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate()	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling()	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<string>
identifier()	(overrides?: CallOverrides) => Promise<string>
initialise	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, overrides?: CallOverrides) => Promise<void>
initialise(uint256,uint256)	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, overrides?: CallOverrides) => Promise<void>
install	(_colony: string, overrides?: CallOverrides) => Promise<void>
install(address)	(_colony: string, overrides?: CallOverrides) => Promise<void>
issueTokens	(overrides?: CallOverrides) => Promise<void>
issueTokens()	(overrides?: CallOverrides) => Promise<void>
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>
setTokenIssuanceRate	(_tokenIssuanceRate: BigNumberish, overrides?: CallOverrides) => Promise<void>
setTokenIssuanceRate(uint256)	(_tokenIssuanceRate: BigNumberish, overrides?: CallOverrides) => Promise<void>
setTokenSupplyCeiling	(_tokenSupplyCeiling: BigNumberish, overrides?: CallOverrides) => Promise<void>
setTokenSupplyCeiling(uint256)	(_tokenSupplyCeiling: BigNumberish, 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

AugmentedTokenSupplier.callStatic

---

clientType

• clientType: TokenSupplierClient

Inherited from

AugmentedTokenSupplier.clientType

---

clientVersion

• clientVersion: 1

Overrides

AugmentedTokenSupplier.clientVersion

---

colonyClient

• colonyClient: AugmentedIColony

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>
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>
getColony	(overrides?: CallOverrides) => Promise<BigNumber>
getColony()	(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated	(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated()	(overrides?: CallOverrides) => Promise<BigNumber>
getLastPinged	(overrides?: CallOverrides) => Promise<BigNumber>
getLastPinged()	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<BigNumber>
getLastRateUpdate()	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenIssuanceRate()	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenSupplyCeiling()	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<BigNumber>
identifier()	(overrides?: CallOverrides) => Promise<BigNumber>
initialise	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<BigNumber>
initialise(uint256,uint256)	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, 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>
issueTokens	(overrides?: Overrides & { from?: string }) => Promise<BigNumber>
issueTokens()	(overrides?: Overrides & { from?: string }) => 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>
setTokenIssuanceRate	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<BigNumber>
setTokenIssuanceRate(uint256)	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<BigNumber>
setTokenSupplyCeiling	(_tokenSupplyCeiling: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<BigNumber>
setTokenSupplyCeiling(uint256)	(_tokenSupplyCeiling: BigNumberish, 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

AugmentedTokenSupplier.estimateGas

---

filters

• filters: Object

Type declaration

Name	Type
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
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]>
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>
getColony	(overrides?: CallOverrides) => Promise<[string]>
getColony()	(overrides?: CallOverrides) => Promise<[string]>
getDeprecated	(overrides?: CallOverrides) => Promise<[boolean]>
getDeprecated()	(overrides?: CallOverrides) => Promise<[boolean]>
getLastPinged	(overrides?: CallOverrides) => Promise<[BigNumber]>
getLastPinged()	(overrides?: CallOverrides) => Promise<[BigNumber]>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<[BigNumber]>
getLastRateUpdate()	(overrides?: CallOverrides) => Promise<[BigNumber]>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<[BigNumber]>
getTokenIssuanceRate()	(overrides?: CallOverrides) => Promise<[BigNumber]>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<[BigNumber]>
getTokenSupplyCeiling()	(overrides?: CallOverrides) => Promise<[BigNumber]>
identifier	(overrides?: CallOverrides) => Promise<[string]>
identifier()	(overrides?: CallOverrides) => Promise<[string]>
initialise	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
initialise(uint256,uint256)	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, 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>
issueTokens	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
issueTokens()	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
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>
setTokenIssuanceRate	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setTokenIssuanceRate(uint256)	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setTokenSupplyCeiling	(_tokenSupplyCeiling: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setTokenSupplyCeiling(uint256)	(_tokenSupplyCeiling: BigNumberish, 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

AugmentedTokenSupplier.functions

---

interface

• interface: TokenSupplierInterface

Inherited from

AugmentedTokenSupplier.interface

---

off

• off: OnEvent<TokenSupplierClientV1>

Inherited from

AugmentedTokenSupplier.off

---

on

• on: OnEvent<TokenSupplierClientV1>

Inherited from

AugmentedTokenSupplier.on

---

once

• once: OnEvent<TokenSupplierClientV1>

Inherited from

AugmentedTokenSupplier.once

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
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>
getColony	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastPinged	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastPinged()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastRateUpdate	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getLastRateUpdate()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenIssuanceRate	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenIssuanceRate()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenSupplyCeiling	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenSupplyCeiling()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
initialise(uint256,uint256)	(_tokenSupplyCeiling: BigNumberish, _tokenIssuanceRate: BigNumberish, 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>
issueTokens	(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
issueTokens()	(overrides?: Overrides & { from?: string }) => 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>
setTokenIssuanceRate	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setTokenIssuanceRate(uint256)	(_tokenIssuanceRate: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setTokenSupplyCeiling	(_tokenSupplyCeiling: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setTokenSupplyCeiling(uint256)	(_tokenSupplyCeiling: BigNumberish, 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

AugmentedTokenSupplier.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

AugmentedTokenSupplier.provider

---

removeListener

• removeListener: OnEvent<TokenSupplierClientV1>

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): TokenSupplierClientV1

Parameters

Name	Type
addressOrName	string

Returns

TokenSupplierClientV1

Inherited from

AugmentedTokenSupplier.attach

---

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.authority

---

authority()

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

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.authority()

---

connect

▸ connect(signerOrProvider): TokenSupplierClientV1

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

TokenSupplierClientV1

Inherited from

AugmentedTokenSupplier.connect

---

deployed

▸ deployed(): Promise<TokenSupplierClientV1>

Returns

Promise<TokenSupplierClientV1>

Inherited from

AugmentedTokenSupplier.deployed

---

deprecate

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

Called when deprecating (or undeprecating) the extension (currently a no-op)

Parameters

Name	Type
_deprecated	boolean
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.deprecate

---

deprecate(bool)

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

Called when deprecating (or undeprecating) the extension (currently a no-op)

Parameters

Name	Type
_deprecated	boolean
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.deprecate(bool)

---

emit

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

Parameters

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

Returns

boolean

Inherited from

AugmentedTokenSupplier.emit

---

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?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.finishUpgrade

---

finishUpgrade()

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

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

Parameters

Name	Type
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.finishUpgrade()

---

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.getColony

---

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

---

getDeprecated()

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

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedTokenSupplier.getDeprecated()

---

getLastPinged

▸ getLastPinged(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastPinged

---

getLastPinged()

▸ getLastPinged()(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastPinged()

---

getLastRateUpdate

▸ getLastRateUpdate(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastRateUpdate

---

getLastRateUpdate()

▸ getLastRateUpdate()(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getLastRateUpdate()

---

getTokenIssuanceRate

▸ getTokenIssuanceRate(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getTokenIssuanceRate

---

getTokenIssuanceRate()

▸ getTokenIssuanceRate()(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getTokenIssuanceRate()

---

getTokenSupplyCeiling

▸ getTokenSupplyCeiling(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.getTokenSupplyCeiling

---

getTokenSupplyCeiling()

▸ getTokenSupplyCeiling()(overrides?): Promise<BigNumber>

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

---

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	BigNumberish	Total amount of tokens to issue
_tokenIssuanceRate	BigNumberish	Number of tokens to issue per day
overrides?	Overrides & { from?: string }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.initialise

---

initialise(uint256,uint256)

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

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.initialise(uint256,uint256)

---

install

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.install

---

install(address)

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.install(address)

---

issueTokens

▸ issueTokens(overrides?): Promise<ContractTransaction>

Issue the appropriate amount of tokens

Parameters

Name	Type
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.issueTokens

---

issueTokens()

▸ issueTokens()(overrides?): Promise<ContractTransaction>

Issue the appropriate amount of tokens

Parameters

Name	Type
overrides?	Overrides & { from?: 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

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedTokenSupplier.owner

---

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): TokenSupplierClientV1

Type parameters

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

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

TokenSupplierClientV1

Inherited from

AugmentedTokenSupplier.removeAllListeners

▸ removeAllListeners(eventName?): TokenSupplierClientV1

Parameters

Name	Type
eventName?	string

Returns

TokenSupplierClientV1

Inherited from

AugmentedTokenSupplier.removeAllListeners

---

setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setAuthority

---

setAuthority(address)

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setAuthority(address)

---

setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setOwner

---

setOwner(address)

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setOwner(address)

---

setTokenIssuanceRate

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

Update the tokenIssuanceRate

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenIssuanceRate

---

setTokenIssuanceRate(uint256)

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

Update the tokenIssuanceRate

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenIssuanceRate(uint256)

---

setTokenSupplyCeiling

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

Update the tokenSupplyCeiling, cannot set below current tokenSupply

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenSupplyCeiling

---

setTokenSupplyCeiling(uint256)

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

Update the tokenSupplyCeiling, cannot set below current tokenSupply

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.setTokenSupplyCeiling(uint256)

---

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

Name	Type
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.uninstall

---

uninstall()

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

Called when uninstalling the extension

Parameters

Name	Type
overrides?	Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedTokenSupplier.uninstall()

---

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.version

---

version()

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

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedTokenSupplier.version()