Skip to main content

Interface: CoinMachineClientV1

An instantiated ethers contract for the CoinMachine contract in version 1, with certain augmentations added. Pay attention to the existence of ...WithProofs or ...Checked functions as these provide convenient helpers to figure out permission proofs and contract checks for you.

Hierarchy

  • AugmentedCoinMachine<CoinMachine>

    CoinMachineClientV1

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

NameType
authority(overrides?: CallOverrides) => Promise<string>
buyTokens(_numTokens: BigNumberish, overrides?: CallOverrides) => Promise<void>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
getColony(overrides?: CallOverrides) => Promise<string>
getCurrentPrice(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getMaxPerPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getNumAvailable(overrides?: CallOverrides) => Promise<BigNumber>
getPeriodLength(overrides?: CallOverrides) => Promise<BigNumber>
getTargetPerPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getTokensToSell(overrides?: CallOverrides) => Promise<BigNumber>
getWindowSize(overrides?: CallOverrides) => Promise<BigNumber>
identifier(overrides?: CallOverrides) => Promise<string>
initialise(_purchaseToken: string, _periodLength: BigNumberish, _windowSize: BigNumberish, _targetPerPeriod: BigNumberish, _maxPerPeriod: BigNumberish, _tokensToSell: BigNumberish, _startingPrice: BigNumberish, overrides?: CallOverrides) => Promise<void>
install(_colony: string, overrides?: CallOverrides) => Promise<void>
owner(overrides?: CallOverrides) => Promise<string>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
updatePeriod(overrides?: CallOverrides) => Promise<void>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedCoinMachine.callStatic


clientType

clientType: CoinMachineClient

Inherited from

AugmentedCoinMachine.clientType


clientVersion

clientVersion: 1

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

NameType
authority(overrides?: CallOverrides) => Promise<BigNumber>
buyTokens(_numTokens: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<BigNumber>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<BigNumber>
getCurrentPrice(overrides?: CallOverrides) => Promise<BigNumber>
getDeprecated(overrides?: CallOverrides) => Promise<BigNumber>
getMaxPerPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getNumAvailable(overrides?: CallOverrides) => Promise<BigNumber>
getPeriodLength(overrides?: CallOverrides) => Promise<BigNumber>
getTargetPerPeriod(overrides?: CallOverrides) => Promise<BigNumber>
getTokensToSell(overrides?: CallOverrides) => Promise<BigNumber>
getWindowSize(overrides?: CallOverrides) => Promise<BigNumber>
identifier(overrides?: CallOverrides) => Promise<BigNumber>
initialise(_purchaseToken: string, _periodLength: BigNumberish, _windowSize: BigNumberish, _targetPerPeriod: BigNumberish, _maxPerPeriod: BigNumberish, _tokensToSell: BigNumberish, _startingPrice: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
owner(overrides?: CallOverrides) => Promise<BigNumber>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
updatePeriod(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedCoinMachine.estimateGas


filters

filters: Object

Type declaration

NameType
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
PeriodUpdated(activePeriod?: null, currentPeriod?: null) => PeriodUpdatedEventFilter
PeriodUpdated(uint256,uint256)(activePeriod?: null, currentPeriod?: null) => PeriodUpdatedEventFilter
TokensBought(buyer?: null, numTokens?: null, totalCost?: null) => TokensBoughtEventFilter
TokensBought(address,uint256,uint256)(buyer?: null, numTokens?: null, totalCost?: null) => TokensBoughtEventFilter

Inherited from

AugmentedCoinMachine.filters


functions

functions: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<[string]>
buyTokens(_numTokens: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
getColony(overrides?: CallOverrides) => Promise<[string]>
getCurrentPrice(overrides?: CallOverrides) => Promise<[BigNumber]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getMaxPerPeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getNumAvailable(overrides?: CallOverrides) => Promise<[BigNumber]>
getPeriodLength(overrides?: CallOverrides) => Promise<[BigNumber]>
getTargetPerPeriod(overrides?: CallOverrides) => Promise<[BigNumber]>
getTokensToSell(overrides?: CallOverrides) => Promise<[BigNumber]>
getWindowSize(overrides?: CallOverrides) => Promise<[BigNumber]>
identifier(overrides?: CallOverrides) => Promise<[string]>
initialise(_purchaseToken: string, _periodLength: BigNumberish, _windowSize: BigNumberish, _targetPerPeriod: BigNumberish, _maxPerPeriod: BigNumberish, _tokensToSell: BigNumberish, _startingPrice: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
updatePeriod(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
version(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from

AugmentedCoinMachine.functions


interface

interface: CoinMachineInterface

Inherited from

AugmentedCoinMachine.interface


off

off: OnEvent<CoinMachineClientV1>

Inherited from

AugmentedCoinMachine.off


on

on: OnEvent<CoinMachineClientV1>

Inherited from

AugmentedCoinMachine.on


once

once: OnEvent<CoinMachineClientV1>

Inherited from

AugmentedCoinMachine.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
buyTokens(_numTokens: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCurrentPrice(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMaxPerPeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getNumAvailable(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getPeriodLength(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTargetPerPeriod(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getTokensToSell(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getWindowSize(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
initialise(_purchaseToken: string, _periodLength: BigNumberish, _windowSize: BigNumberish, _targetPerPeriod: BigNumberish, _maxPerPeriod: BigNumberish, _tokensToSell: BigNumberish, _startingPrice: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
updatePeriod(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedCoinMachine.populateTransaction


provider

Readonly provider: Provider

Inherited from

AugmentedCoinMachine.provider


removeListener

removeListener: OnEvent<CoinMachineClientV1>

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

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedCoinMachine._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedCoinMachine._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedCoinMachine._wrapEvent


attach

attach(addressOrName): CoinMachineClientV1

Parameters

NameType
addressOrNamestring

Returns

CoinMachineClientV1

Inherited from

AugmentedCoinMachine.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.authority


buyTokens

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

Purchase tokens from Coin Machine.

Parameters

NameTypeDescription
_numTokensBigNumberishThe number of tokens to purchase
overrides?PayableOverrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.buyTokens


connect

connect(signerOrProvider): CoinMachineClientV1

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

CoinMachineClientV1

Inherited from

AugmentedCoinMachine.connect


deployed

deployed(): Promise<CoinMachineClientV1>

Returns

Promise<CoinMachineClientV1>

Inherited from

AugmentedCoinMachine.deployed


deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.deprecate


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedCoinMachine.emit


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedCoinMachine.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.finishUpgrade


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.getColony


getCurrentPrice

getCurrentPrice(overrides?): Promise<BigNumber>

Get the current price per token

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getCurrentPrice


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedCoinMachine.getDeprecated


getMaxPerPeriod

getMaxPerPeriod(overrides?): Promise<BigNumber>

Get the maximum number of tokens to sell per period

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getMaxPerPeriod


getNumAvailable

getNumAvailable(overrides?): Promise<BigNumber>

Get the number of remaining tokens for sale this period

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getNumAvailable


getPeriodLength

getPeriodLength(overrides?): Promise<BigNumber>

Get the length of the sale period

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getPeriodLength


getTargetPerPeriod

getTargetPerPeriod(overrides?): Promise<BigNumber>

Get the target number of tokens to sell per period

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getTargetPerPeriod


getTokensToSell

getTokensToSell(overrides?): Promise<BigNumber>

Get the total number of tokens remaining for sale

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getTokensToSell


getWindowSize

getWindowSize(overrides?): Promise<BigNumber>

Get the size of the averaging window

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.getWindowSize


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.identifier


initialise

initialise(_purchaseToken, _periodLength, _windowSize, _targetPerPeriod, _maxPerPeriod, _tokensToSell, _startingPrice, overrides?): Promise<ContractTransaction>

Must be called before any sales can be made

Parameters

NameTypeDescription
_purchaseTokenstringThe token to receive payments in. Use 0x0 for ether
_periodLengthBigNumberishHow long in seconds each period of the sale should last
_windowSizeBigNumberishCharacteristic 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
_targetPerPeriodBigNumberishThe number of tokens to aim to sell per period
_maxPerPeriodBigNumberishThe maximum number of tokens that can be sold per period
_tokensToSellBigNumberish-
_startingPriceBigNumberishThe sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
overrides?Overrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.initialise


install

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.install


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

AugmentedCoinMachine.listenerCount


listeners

listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilter?TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Inherited from

AugmentedCoinMachine.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedCoinMachine.listeners


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedCoinMachine.owner


queryFilter

queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventTypedEventFilter<TEvent>
fromBlockOrBlockhash?string | number
toBlock?string | number

Returns

Promise<TEvent[]>

Inherited from

AugmentedCoinMachine.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): CoinMachineClientV1

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

CoinMachineClientV1

Inherited from

AugmentedCoinMachine.removeAllListeners

removeAllListeners(eventName?): CoinMachineClientV1

Parameters

NameType
eventName?string

Returns

CoinMachineClientV1

Inherited from

AugmentedCoinMachine.removeAllListeners


setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.setAuthority


setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.setOwner


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.uninstall


updatePeriod

updatePeriod(overrides?): Promise<ContractTransaction>

Bring the token accounting current

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedCoinMachine.updatePeriod


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedCoinMachine.version