Interface: CoinMachineClientV5

Hierarchy

• AugmentedCoinMachine<CoinMachine>

  ↳ CoinMachineClientV5

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

AugmentedCoinMachine._deployedPromise

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

AugmentedCoinMachine._runningEvents

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

AugmentedCoinMachine._wrappedEmits

---

address

• Readonly address: string

Inherited from

AugmentedCoinMachine.address

---

callStatic

• callStatic: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<string>
buyTokens	(_numTokens: PromiseOrValue<BigNumberish>, overrides?: CallOverrides) => Promise<void>
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>
getActiveIntake	(overrides?: CallOverrides) => Promise<BigNumber>
getActivePeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getActiveSold	(overrides?: CallOverrides) => Promise<BigNumber>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<string>
getChainId	(overrides?: CallOverrides) => Promise<BigNumber>
getColony	(overrides?: CallOverrides) => Promise<string>
getCurrentPrice	(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated	(overrides?: CallOverrides) => Promise<boolean>
getEMAIntake	(overrides?: CallOverrides) => Promise<BigNumber>
getEvolvePrice	(overrides?: CallOverrides) => Promise<boolean>
getMaxPerPeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getMaxPurchase	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getPeriodLength	(overrides?: CallOverrides) => Promise<BigNumber>
getPurchaseToken	(overrides?: CallOverrides) => Promise<string>
getSellableTokens	(overrides?: CallOverrides) => Promise<BigNumber>
getTargetPerPeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getToken	(overrides?: CallOverrides) => Promise<string>
getTokenBalance	(overrides?: CallOverrides) => Promise<BigNumber>
getUserLimit	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getWhitelist	(overrides?: CallOverrides) => Promise<string>
getWindowSize	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<string>
initialise	(_token: PromiseOrValue<string>, _purchaseToken: PromiseOrValue<string>, _periodLength: PromiseOrValue<BigNumberish>, _windowSize: PromiseOrValue<BigNumberish>, _targetPerPeriod: PromiseOrValue<BigNumberish>, _maxPerPeriod: PromiseOrValue<BigNumberish>, _userLimitFraction: PromiseOrValue<BigNumberish>, _startingPrice: PromiseOrValue<BigNumberish>, _whitelist: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
install	(_colony: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
owner	(overrides?: CallOverrides) => Promise<string>
setAuthority	(authority_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setOwner	(owner_: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
setWhitelist	(_whitelist: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<void>
uninstall	(overrides?: CallOverrides) => Promise<void>
updatePeriod	(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

AugmentedCoinMachine.callStatic

---

clientType

• clientType: CoinMachineClient

Inherited from

AugmentedCoinMachine.clientType

---

clientVersion

• clientVersion: 5

Overrides

AugmentedCoinMachine.clientVersion

---

coinMachineEvents

• coinMachineEvents: CoinMachineEvents

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

Inherited from

AugmentedCoinMachine.coinMachineEvents

---

colonyClient

• colonyClient: AugmentedIColony<AnyIColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedCoinMachine.colonyClient

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedCoinMachine.deployTransaction

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<BigNumber>
buyTokens	(_numTokens: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => 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>
getActiveIntake	(overrides?: CallOverrides) => Promise<BigNumber>
getActivePeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getActiveSold	(overrides?: CallOverrides) => Promise<BigNumber>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<BigNumber>
getChainId	(overrides?: CallOverrides) => Promise<BigNumber>
getColony	(overrides?: CallOverrides) => Promise<BigNumber>
getCurrentPrice	(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated	(overrides?: CallOverrides) => Promise<BigNumber>
getEMAIntake	(overrides?: CallOverrides) => Promise<BigNumber>
getEvolvePrice	(overrides?: CallOverrides) => Promise<BigNumber>
getMaxPerPeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getMaxPurchase	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getPeriodLength	(overrides?: CallOverrides) => Promise<BigNumber>
getPurchaseToken	(overrides?: CallOverrides) => Promise<BigNumber>
getSellableTokens	(overrides?: CallOverrides) => Promise<BigNumber>
getTargetPerPeriod	(overrides?: CallOverrides) => Promise<BigNumber>
getToken	(overrides?: CallOverrides) => Promise<BigNumber>
getTokenBalance	(overrides?: CallOverrides) => Promise<BigNumber>
getUserLimit	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<BigNumber>
getWhitelist	(overrides?: CallOverrides) => Promise<BigNumber>
getWindowSize	(overrides?: CallOverrides) => Promise<BigNumber>
identifier	(overrides?: CallOverrides) => Promise<BigNumber>
initialise	(_token: PromiseOrValue<string>, _purchaseToken: PromiseOrValue<string>, _periodLength: PromiseOrValue<BigNumberish>, _windowSize: PromiseOrValue<BigNumberish>, _targetPerPeriod: PromiseOrValue<BigNumberish>, _maxPerPeriod: PromiseOrValue<BigNumberish>, _userLimitFraction: PromiseOrValue<BigNumberish>, _startingPrice: PromiseOrValue<BigNumberish>, _whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
install	(_colony: PromiseOrValue<string>, 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>
setWhitelist	(_whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<BigNumber>
updatePeriod	(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

AugmentedCoinMachine.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
PeriodUpdated	(activePeriod?: null, currentPeriod?: null) => PeriodUpdatedEventFilter
PeriodUpdated(uint256,uint256)	(activePeriod?: null, currentPeriod?: null) => PeriodUpdatedEventFilter
PriceEvolutionSet	(evolvePrice?: null) => PriceEvolutionSetEventFilter
PriceEvolutionSet(bool)	(evolvePrice?: null) => PriceEvolutionSetEventFilter
TokensBought	(buyer?: null | PromiseOrValue<string>, token?: null, numTokens?: null, totalCost?: null) => TokensBoughtEventFilter
TokensBought(address,address,uint256,uint256)	(buyer?: null | PromiseOrValue<string>, token?: null, numTokens?: null, totalCost?: null) => TokensBoughtEventFilter
WhitelistSet	(whitelist?: null) => WhitelistSetEventFilter
WhitelistSet(address)	(whitelist?: null) => WhitelistSetEventFilter

Inherited from

AugmentedCoinMachine.filters

---

functions

• functions: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<[string]>
buyTokens	(_numTokens: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
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>
getActiveIntake	(overrides?: CallOverrides) => Promise<[BigNumber]>
getActivePeriod	(overrides?: CallOverrides) => Promise<[BigNumber]>
getActiveSold	(overrides?: CallOverrides) => Promise<[BigNumber]>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<[string]>
getChainId	(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony	(overrides?: CallOverrides) => Promise<[string]>
getCurrentPrice	(overrides?: CallOverrides) => Promise<[BigNumber]>
getDeprecated	(overrides?: CallOverrides) => Promise<[boolean]>
getEMAIntake	(overrides?: CallOverrides) => Promise<[BigNumber]>
getEvolvePrice	(overrides?: CallOverrides) => Promise<[boolean]>
getMaxPerPeriod	(overrides?: CallOverrides) => Promise<[BigNumber]>
getMaxPurchase	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getPeriodLength	(overrides?: CallOverrides) => Promise<[BigNumber]>
getPurchaseToken	(overrides?: CallOverrides) => Promise<[string]>
getSellableTokens	(overrides?: CallOverrides) => Promise<[BigNumber]>
getTargetPerPeriod	(overrides?: CallOverrides) => Promise<[BigNumber]>
getToken	(overrides?: CallOverrides) => Promise<[string]>
getTokenBalance	(overrides?: CallOverrides) => Promise<[BigNumber]>
getUserLimit	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<[BigNumber]>
getWhitelist	(overrides?: CallOverrides) => Promise<[string]>
getWindowSize	(overrides?: CallOverrides) => Promise<[BigNumber]>
identifier	(overrides?: CallOverrides) => Promise<[string]>
initialise	(_token: PromiseOrValue<string>, _purchaseToken: PromiseOrValue<string>, _periodLength: PromiseOrValue<BigNumberish>, _windowSize: PromiseOrValue<BigNumberish>, _targetPerPeriod: PromiseOrValue<BigNumberish>, _maxPerPeriod: PromiseOrValue<BigNumberish>, _userLimitFraction: PromiseOrValue<BigNumberish>, _startingPrice: PromiseOrValue<BigNumberish>, _whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
install	(_colony: PromiseOrValue<string>, 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>
setWhitelist	(_whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<ContractTransaction>
updatePeriod	(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]>

Inherited from

AugmentedCoinMachine.functions

---

interface

• interface: CoinMachineInterface

Inherited from

AugmentedCoinMachine.interface

---

off

• off: OnEvent<CoinMachineClientV5>

Inherited from

AugmentedCoinMachine.off

---

on

• on: OnEvent<CoinMachineClientV5>

Inherited from

AugmentedCoinMachine.on

---

once

• once: OnEvent<CoinMachineClientV5>

Inherited from

AugmentedCoinMachine.once

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
authority	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
buyTokens	(_numTokens: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }) => 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>
getActiveIntake	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getActivePeriod	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getActiveSold	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles	(_sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCurrentPrice	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getEMAIntake	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getEvolvePrice	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMaxPerPeriod	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMaxPurchase	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce	(userAddress: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getPeriodLength	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getPurchaseToken	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getSellableTokens	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTargetPerPeriod	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getToken	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokenBalance	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getUserLimit	(_user: PromiseOrValue<string>, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getWhitelist	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getWindowSize	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise	(_token: PromiseOrValue<string>, _purchaseToken: PromiseOrValue<string>, _periodLength: PromiseOrValue<BigNumberish>, _windowSize: PromiseOrValue<BigNumberish>, _targetPerPeriod: PromiseOrValue<BigNumberish>, _maxPerPeriod: PromiseOrValue<BigNumberish>, _userLimitFraction: PromiseOrValue<BigNumberish>, _startingPrice: PromiseOrValue<BigNumberish>, _whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
install	(_colony: PromiseOrValue<string>, 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>
setWhitelist	(_whitelist: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
uninstall	(overrides?: Overrides & { from?: PromiseOrValue<string> }) => Promise<PopulatedTransaction>
updatePeriod	(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

AugmentedCoinMachine.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

AugmentedCoinMachine.provider

---

removeListener

• removeListener: OnEvent<CoinMachineClientV5>

Inherited from

AugmentedCoinMachine.removeListener

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedCoinMachine.resolvedAddress

---

signer

• Readonly signer: Signer

Inherited from

AugmentedCoinMachine.signer

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

AugmentedCoinMachine._checkRunningEvents

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedCoinMachine._deployed

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

AugmentedCoinMachine._wrapEvent

---

attach

▸ attach(addressOrName): CoinMachineClientV5

Parameters

Name	Type
addressOrName	string

Returns

CoinMachineClientV5

Inherited from

AugmentedCoinMachine.attach

---

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.authority

---

buyTokens

▸ buyTokens(_numTokens, overrides?): Promise<ContractTransaction>

Purchase tokens from Coin Machine.

Parameters

Name	Type	Description
_numTokens	PromiseOrValue<BigNumberish>	The number of tokens to purchase
overrides?	PayableOverrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.buyTokens

---

connect

▸ connect(signerOrProvider): CoinMachineClientV5

Parameters

Name	Type
signerOrProvider	string | Provider | Signer

Returns

CoinMachineClientV5

Inherited from

AugmentedCoinMachine.connect

---

deployed

▸ deployed(): Promise<CoinMachineClientV5>

Returns

Promise<CoinMachineClientV5>

Inherited from

AugmentedCoinMachine.deployed

---

deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.deprecate

---

emit

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

Parameters

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

Returns

boolean

Inherited from

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

AugmentedCoinMachine.executeMetaTransaction

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedCoinMachine.fallback

---

finishUpgrade

▸ finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.finishUpgrade

---

getActiveIntake

▸ getActiveIntake(overrides?): Promise<BigNumber>

Get the number of tokens received in the period that the price was last updated for or a purchase was made

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getActiveIntake

---

getActivePeriod

▸ getActivePeriod(overrides?): Promise<BigNumber>

Get the period that the price was last updated for or a purchase was made

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getActivePeriod

---

getActiveSold

▸ getActiveSold(overrides?): Promise<BigNumber>

Get the number of tokens sold in the period that the price was last updated for or a purchase was made

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getActiveSold

---

getCapabilityRoles

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

Parameters

Name	Type
_sig	PromiseOrValue<BytesLike>
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getCapabilityRoles

---

getChainId

▸ getChainId(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getChainId

---

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getColony

---

getCurrentPrice

▸ getCurrentPrice(overrides?): Promise<BigNumber>

Get the current price per token

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getCurrentPrice

---

getDeprecated

▸ getDeprecated(overrides?): Promise<boolean>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedCoinMachine.getDeprecated

---

getEMAIntake

▸ getEMAIntake(overrides?): Promise<BigNumber>

Get the EMA of the number of tokens received each period

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getEMAIntake

---

getEvolvePrice

▸ getEvolvePrice(overrides?): Promise<boolean>

Get the evolvePrice boolean

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedCoinMachine.getEvolvePrice

---

getMaxPerPeriod

▸ getMaxPerPeriod(overrides?): Promise<BigNumber>

Get the maximum number of tokens to sell per period

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getMaxPerPeriod

---

getMaxPurchase

▸ getMaxPurchase(_user, overrides?): Promise<BigNumber>

Get the maximum amount of tokens a user can purchase in a period

Parameters

Name	Type
_user	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getMaxPurchase

---

getMetatransactionNonce

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

Parameters

Name	Type
userAddress	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getMetatransactionNonce

---

getPeriodLength

▸ getPeriodLength(overrides?): Promise<BigNumber>

Get the length of the sale period

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getPeriodLength

---

getPurchaseToken

▸ getPurchaseToken(overrides?): Promise<string>

Get the address of the token being used to make purchases

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getPurchaseToken

---

getSellableTokens

▸ getSellableTokens(overrides?): Promise<BigNumber>

Get the number of remaining tokens for sale this period

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getSellableTokens

---

getTargetPerPeriod

▸ getTargetPerPeriod(overrides?): Promise<BigNumber>

Get the target number of tokens to sell per period

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getTargetPerPeriod

---

getToken

▸ getToken(overrides?): Promise<string>

Get the address of the token being sold

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getToken

---

getTokenBalance

▸ getTokenBalance(overrides?): Promise<BigNumber>

Get the remaining balance of tokens

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getTokenBalance

---

getUserLimit

▸ getUserLimit(_user, overrides?): Promise<BigNumber>

Get the maximum amount of tokens a user can purchase in total

Parameters

Name	Type
_user	PromiseOrValue<string>
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getUserLimit

---

getWhitelist

▸ getWhitelist(overrides?): Promise<string>

Get the address of the whitelist (if exists)

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getWhitelist

---

getWindowSize

▸ getWindowSize(overrides?): Promise<BigNumber>

Get the size of the averaging window

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getWindowSize

---

identifier

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.identifier

---

initialise

▸ initialise(_token, _purchaseToken, _periodLength, _windowSize, _targetPerPeriod, _maxPerPeriod, _userLimitFraction, _startingPrice, _whitelist, overrides?): Promise<ContractTransaction>

Must be called before any sales can be made

Parameters

Name	Type	Description
_token	PromiseOrValue<string>	The token we are selling. Cannot be ether
_purchaseToken	PromiseOrValue<string>	The token to receive payments in. Use 0x0 for ether
_periodLength	PromiseOrValue<BigNumberish>	How long in seconds each period of the sale should last
_windowSize	PromiseOrValue<BigNumberish>	Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
_targetPerPeriod	PromiseOrValue<BigNumberish>	The number of tokens to aim to sell per period
_maxPerPeriod	PromiseOrValue<BigNumberish>	The maximum number of tokens that can be sold per period
_userLimitFraction	PromiseOrValue<BigNumberish>	-
_startingPrice	PromiseOrValue<BigNumberish>	The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
_whitelist	PromiseOrValue<string>	Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

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

AugmentedCoinMachine.install

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

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

AugmentedCoinMachine.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Inherited from

AugmentedCoinMachine.listeners

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

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

AugmentedCoinMachine.queryFilter

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): CoinMachineClientV5

Type parameters

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

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

CoinMachineClientV5

Inherited from

AugmentedCoinMachine.removeAllListeners

▸ removeAllListeners(eventName?): CoinMachineClientV5

Parameters

Name	Type
eventName?	string

Returns

CoinMachineClientV5

Inherited from

AugmentedCoinMachine.removeAllListeners

---

setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.setAuthority

---

setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.setOwner

---

setWhitelist

▸ setWhitelist(_whitelist, overrides?): Promise<ContractTransaction>

Set the address for an (optional) whitelist

Parameters

Name	Type	Description
_whitelist	PromiseOrValue<string>	The address of the whitelist
overrides?	Overrides & { from?: PromiseOrValue<string> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.setWhitelist

---

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.uninstall

---

updatePeriod

▸ updatePeriod(overrides?): Promise<ContractTransaction>

Bring the token accounting current

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.updatePeriod

---

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

AugmentedCoinMachine.verify

---

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.version