Interface: OneTxPaymentClientV9

Extends

• AugmentedOneTxPayment\<OneTxPayment>

Properties

_deployedPromise

_deployedPromise: Promise\<Contract>

Inherited from

AugmentedOneTxPayment._deployedPromise

---

_runningEvents

_runningEvents: object

Index Signature

[eventTag: string]: RunningEvent

Inherited from

AugmentedOneTxPayment._runningEvents

---

_wrappedEmits

_wrappedEmits: object

Index Signature

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

Inherited from

AugmentedOneTxPayment._wrappedEmits

---

address

readonly address: string

Inherited from

AugmentedOneTxPayment.address

---

callStatic

callStatic: object

authority()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

authority()()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

deprecate()

Parameters

_deprecated

boolean

overrides?

CallOverrides

Returns

Promise\<void>

deprecate(bool)()

Parameters

_deprecated

boolean

overrides?

CallOverrides

Returns

Promise\<void>

executeMetaTransaction()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<string>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<string>

finishUpgrade()

Parameters

overrides?

CallOverrides

Returns

Promise\<void>

finishUpgrade()()

Parameters

overrides?

CallOverrides

Returns

Promise\<void>

getCapabilityRoles()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<string>

getCapabilityRoles(bytes4)()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<string>

getColony()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

getColony()()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

getDeprecated()

Parameters

overrides?

CallOverrides

Returns

Promise\<boolean>

getDeprecated()()

Parameters

overrides?

CallOverrides

Returns

Promise\<boolean>

getMetatransactionNonce()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<BigNumber>

getMetatransactionNonce(address)()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<BigNumber>

identifier()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

identifier()()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

install()

Parameters

_colony

string

overrides?

CallOverrides

Returns

Promise\<void>

install(address)()

Parameters

_colony

string

overrides?

CallOverrides

Returns

Promise\<void>

makePayment()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

CallOverrides

Returns

Promise\<void>

makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

CallOverrides

Returns

Promise\<void>

makePaymentFundedFromDomain()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

CallOverrides

Returns

Promise\<void>

makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

CallOverrides

Returns

Promise\<void>

multicall()

Parameters

data

BytesLike[]

overrides?

CallOverrides

Returns

Promise\<string[]>

multicall(bytes[])()

Parameters

data

BytesLike[]

overrides?

CallOverrides

Returns

Promise\<string[]>

owner()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

owner()()

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

setAuthority()

Parameters

authority_

string

overrides?

CallOverrides

Returns

Promise\<void>

setAuthority(address)()

Parameters

authority_

string

overrides?

CallOverrides

Returns

Promise\<void>

setOwner()

Parameters

owner_

string

overrides?

CallOverrides

Returns

Promise\<void>

setOwner(address)()

Parameters

owner_

string

overrides?

CallOverrides

Returns

Promise\<void>

uninstall()

Parameters

overrides?

CallOverrides

Returns

Promise\<void>

uninstall()()

Parameters

overrides?

CallOverrides

Returns

Promise\<void>

verify()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<boolean>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<boolean>

version()

Parameters

overrides?

CallOverrides

Returns

Promise\<BigNumber>

version()()

Parameters

overrides?

CallOverrides

Returns

Promise\<BigNumber>

Inherited from

AugmentedOneTxPayment.callStatic

---

clientType

clientType: OneTxPaymentClient

Inherited from

AugmentedOneTxPayment.clientType

---

clientVersion

clientVersion: 9

Overrides

AugmentedOneTxPayment.clientVersion

---

colonyClient

colonyClient: AugmentedIColony

An instance of the corresponding ColonyClient

Inherited from

AugmentedOneTxPayment.colonyClient

---

deployTransaction

readonly deployTransaction: TransactionResponse

Inherited from

AugmentedOneTxPayment.deployTransaction

---

estimateGas

estimateGas: OneTxPaymentEstimate

Overrides

AugmentedOneTxPayment.estimateGas

---

filters

filters: object

ExtensionInitialised()

Returns

ExtensionInitialisedEventFilter

ExtensionInitialised()()

Returns

ExtensionInitialisedEventFilter

LogSetAuthority()

Parameters

authority?

null | string

Returns

LogSetAuthorityEventFilter

LogSetAuthority(address)()

Parameters

authority?

null | string

Returns

LogSetAuthorityEventFilter

LogSetOwner()

Parameters

owner?

null | string

Returns

LogSetOwnerEventFilter

LogSetOwner(address)()

Parameters

owner?

null | string

Returns

LogSetOwnerEventFilter

MetaTransactionExecuted()

Parameters

userAddress?

null

relayerAddress?

null

payload?

null

Returns

MetaTransactionExecutedEventFilter

MetaTransactionExecuted(address,address,bytes)()

Parameters

userAddress?

null

relayerAddress?

null

payload?

null

Returns

MetaTransactionExecutedEventFilter

OneTxPaymentMade()

Parameters

agent?

null

fundamentalId?

null

nPayouts?

null

Returns

OneTxPaymentMadeEventFilter

OneTxPaymentMade(address,uint256,uint256)()

Parameters

agent?

null

fundamentalId?

null

nPayouts?

null

Returns

OneTxPaymentMadeEventFilter

Inherited from

AugmentedOneTxPayment.filters

---

functions

functions: object

authority()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

authority()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

deprecate()

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

deprecate(bool)()

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

executeMetaTransaction()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<ContractTransaction>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<ContractTransaction>

finishUpgrade()

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

finishUpgrade()()

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

getCapabilityRoles()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<[string] & object>

getCapabilityRoles(bytes4)()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<[string] & object>

getColony()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

getColony()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

getDeprecated()

Parameters

overrides?

CallOverrides

Returns

Promise\<[boolean]>

getDeprecated()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[boolean]>

getMetatransactionNonce()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<[BigNumber] & object>

getMetatransactionNonce(address)()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<[BigNumber] & object>

identifier()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string] & object>

identifier()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string] & object>

install()

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

install(address)()

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

makePayment()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

makePaymentFundedFromDomain()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

multicall()

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

multicall(bytes[])()

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

owner()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

owner()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[string]>

setAuthority()

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

setAuthority(address)()

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

setOwner()

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

setOwner(address)()

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

uninstall()

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

uninstall()()

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

verify()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<[boolean]>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<[boolean]>

version()

Parameters

overrides?

CallOverrides

Returns

Promise\<[BigNumber] & object>

version()()

Parameters

overrides?

CallOverrides

Returns

Promise\<[BigNumber] & object>

Inherited from

AugmentedOneTxPayment.functions

---

interface

interface: OneTxPaymentInterface

Inherited from

AugmentedOneTxPayment.interface

---

off

off: OnEvent\<OneTxPaymentClientV9>

Inherited from

AugmentedOneTxPayment.off

---

on

on: OnEvent\<OneTxPaymentClientV9>

Inherited from

AugmentedOneTxPayment.on

---

once

once: OnEvent\<OneTxPaymentClientV9>

Inherited from

AugmentedOneTxPayment.once

---

oneTxPaymentEvents

oneTxPaymentEvents: OneTxPaymentEvents

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

Inherited from

AugmentedOneTxPayment.oneTxPaymentEvents

---

populateTransaction

populateTransaction: object

authority()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

authority()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

deprecate()

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

deprecate(bool)()

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

executeMetaTransaction()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<PopulatedTransaction>

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<PopulatedTransaction>

finishUpgrade()

Parameters

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

finishUpgrade()()

Parameters

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

getCapabilityRoles()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getCapabilityRoles(bytes4)()

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getColony()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getColony()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getDeprecated()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getDeprecated()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getMetatransactionNonce()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

getMetatransactionNonce(address)()

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

identifier()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

identifier()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

install()

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

install(address)()

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

makePayment()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

makePaymentFundedFromDomain()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

multicall()

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

multicall(bytes[])()

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

owner()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

owner()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

setAuthority()

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

setAuthority(address)()

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

setOwner()

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

setOwner(address)()

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

uninstall()

Parameters

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

uninstall()()

Parameters

overrides?

Overrides & object

Returns

Promise\<PopulatedTransaction>

verify()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

version()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

version()()

Parameters

overrides?

CallOverrides

Returns

Promise\<PopulatedTransaction>

Inherited from

AugmentedOneTxPayment.populateTransaction

---

provider

readonly provider: Provider

Inherited from

AugmentedOneTxPayment.provider

---

removeListener

removeListener: OnEvent\<OneTxPaymentClientV9>

Inherited from

AugmentedOneTxPayment.removeListener

---

resolvedAddress

readonly resolvedAddress: Promise\<string>

Inherited from

AugmentedOneTxPayment.resolvedAddress

---

signer

readonly signer: Signer

Inherited from

AugmentedOneTxPayment.signer

Methods

_checkRunningEvents()

_checkRunningEvents(runningEvent): void

Parameters

runningEvent

RunningEvent

Returns

void

Inherited from

AugmentedOneTxPayment._checkRunningEvents

---

_deployed()

_deployed(blockTag?): Promise\<Contract>

Parameters

blockTag?

BlockTag

Returns

Promise\<Contract>

Inherited from

AugmentedOneTxPayment._deployed

---

_wrapEvent()

_wrapEvent(runningEvent, log, listener): Event

Parameters

runningEvent

RunningEvent

log

Log

listener

Listener

Returns

Event

Inherited from

AugmentedOneTxPayment._wrapEvent

---

attach()

attach(addressOrName): this

Parameters

addressOrName

string

Returns

this

Inherited from

AugmentedOneTxPayment.attach

---

authority()

authority(overrides?): Promise\<string>

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.authority

---

authority()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.authority()

---

connect()

connect(signerOrProvider): this

Parameters

signerOrProvider

string | Signer | Provider

Returns

this

Inherited from

AugmentedOneTxPayment.connect

---

deployed()

deployed(): Promise\<OneTxPaymentClientV9>

Returns

Promise\<OneTxPaymentClientV9>

Inherited from

AugmentedOneTxPayment.deployed

---

deprecate()

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

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate

---

deprecate(bool)()

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

Parameters

_deprecated

boolean

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate(bool)

---

emit()

emit(eventName, ...args): boolean

Parameters

eventName

string | EventFilter

args

...any[]

Returns

boolean

Inherited from

AugmentedOneTxPayment.emit

---

executeMetaTransaction()

executeMetaTransaction(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<ContractTransaction>

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.executeMetaTransaction

---

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)()

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<ContractTransaction>

Parameters

_user

string

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

PayableOverrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)

---

fallback()

fallback(overrides?): Promise\<TransactionResponse>

Parameters

overrides?

TransactionRequest

Returns

Promise\<TransactionResponse>

Inherited from

AugmentedOneTxPayment.fallback

---

finishUpgrade()

finishUpgrade(overrides?): Promise\<ContractTransaction>

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade

---

finishUpgrade()()

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

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade()

---

getCapabilityRoles()

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

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.getCapabilityRoles

---

getCapabilityRoles(bytes4)()

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

Parameters

_sig

BytesLike

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.getCapabilityRoles(bytes4)

---

getColony()

getColony(overrides?): Promise\<string>

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.getColony

---

getColony()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.getColony()

---

getDeprecated()

getDeprecated(overrides?): Promise\<boolean>

Parameters

overrides?

CallOverrides

Returns

Promise\<boolean>

Inherited from

AugmentedOneTxPayment.getDeprecated

---

getDeprecated()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<boolean>

Inherited from

AugmentedOneTxPayment.getDeprecated()

---

getMetatransactionNonce()

getMetatransactionNonce(_user, overrides?): Promise\<BigNumber>

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<BigNumber>

Inherited from

AugmentedOneTxPayment.getMetatransactionNonce

---

getMetatransactionNonce(address)()

getMetatransactionNonce(address)(_user, overrides?): Promise\<BigNumber>

Parameters

_user

string

overrides?

CallOverrides

Returns

Promise\<BigNumber>

Inherited from

AugmentedOneTxPayment.getMetatransactionNonce(address)

---

identifier()

identifier(overrides?): Promise\<string>

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.identifier

---

identifier()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.identifier()

---

install()

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

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.install

---

install(address)()

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

Parameters

_colony

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.install(address)

---

listenerCount()

listenerCount(eventName?): number

Parameters

eventName?

string | EventFilter

Returns

number

Inherited from

AugmentedOneTxPayment.listenerCount

---

listeners()

Call Signature

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

Type Parameters

• TEvent extends TypedEvent

Parameters

eventFilter?

TypedEventFilter\<TEvent>

Returns

TypedListener\<TEvent>[]

Inherited from

AugmentedOneTxPayment.listeners

Call Signature

listeners(eventName?): Listener[]

Parameters

eventName?

string

Returns

Listener[]

Inherited from

AugmentedOneTxPayment.listeners

---

makePayment()

makePayment(_permissionDomainId, _childSkillIndex, _callerPermissionDomainId, _callerChildSkillIndex, _workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePayment

---

makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)(_permissionDomainId, _childSkillIndex, _callerPermissionDomainId, _callerChildSkillIndex, _workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)

---

makePaymentFundedFromDomain()

makePaymentFundedFromDomain(_permissionDomainId, _childSkillIndex, _callerPermissionDomainId, _callerChildSkillIndex, _workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePaymentFundedFromDomain

---

makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)()

makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)(_permissionDomainId, _childSkillIndex, _callerPermissionDomainId, _callerChildSkillIndex, _workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Parameters

_permissionDomainId

BigNumberish

_childSkillIndex

BigNumberish

_callerPermissionDomainId

BigNumberish

_callerChildSkillIndex

BigNumberish

_workers

string[]

_tokens

string[]

_amounts

BigNumberish[]

_domainId

BigNumberish

_skillId

BigNumberish

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)

---

makePaymentFundedFromDomainWithProofs()

makePaymentFundedFromDomainWithProofs(_workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Same as makePaymentFundedFromDomain, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

_workers

string[]

The addresses of the recipients of the payment

_tokens

string[]

The addresses of the token the payments are being made in. 0x00 for Ether.

_amounts

BigNumberish[]

The amounts of the tokens being paid out

_domainId

BigNumberish

The domainId the payment should be coming from

_skillId

BigNumberish

The skillId that the payment should be marked with, possibly awarding reputation in this skill.

overrides?

TxOverrides

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePaymentFundedFromDomainWithProofs

---

makePaymentWithProofs()

makePaymentWithProofs(_workers, _tokens, _amounts, _domainId, _skillId, overrides?): Promise\<ContractTransaction>

Same as makePayment, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

_workers

string[]

The addresses of the recipients of the payment

_tokens

string[]

Addresses of the tokens the payments are being made in. 0x00 for Ether.

_amounts

BigNumberish[]

amounts of the tokens being paid out

_domainId

BigNumberish

The domainId the payment should be coming from

_skillId

BigNumberish

The skillId that the payment should be marked with, possibly awarding reputation in this skill.

overrides?

TxOverrides

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePaymentWithProofs

---

multicall()

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

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.multicall

---

multicall(bytes[])()

multicall(bytes[])(data, overrides?): Promise\<ContractTransaction>

Parameters

data

BytesLike[]

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.multicall(bytes[])

---

owner()

owner(overrides?): Promise\<string>

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.owner

---

owner()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<string>

Inherited from

AugmentedOneTxPayment.owner()

---

queryFilter()

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

Type Parameters

• TEvent extends TypedEvent

Parameters

event

TypedEventFilter\<TEvent>

fromBlockOrBlockhash?

string | number

toBlock?

string | number

Returns

Promise\<TEvent[]>

Inherited from

AugmentedOneTxPayment.queryFilter

---

removeAllListeners()

Call Signature

removeAllListeners\<TEvent>(eventFilter): this

Type Parameters

• TEvent extends TypedEvent

Parameters

eventFilter

TypedEventFilter\<TEvent>

Returns

this

Inherited from

AugmentedOneTxPayment.removeAllListeners

Call Signature

removeAllListeners(eventName?): this

Parameters

eventName?

string

Returns

this

Inherited from

AugmentedOneTxPayment.removeAllListeners

---

setAuthority()

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

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority

---

setAuthority(address)()

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

Parameters

authority_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority(address)

---

setOwner()

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

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner

---

setOwner(address)()

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

Parameters

owner_

string

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner(address)

---

uninstall()

uninstall(overrides?): Promise\<ContractTransaction>

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall

---

uninstall()()

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

Parameters

overrides?

Overrides & object

Returns

Promise\<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall()

---

verify()

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

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<boolean>

Inherited from

AugmentedOneTxPayment.verify

---

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)()

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_user, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise\<boolean>

Parameters

_user

string

_nonce

BigNumberish

_chainId

BigNumberish

_payload

BytesLike

_sigR

BytesLike

_sigS

BytesLike

_sigV

BigNumberish

overrides?

CallOverrides

Returns

Promise\<boolean>

Inherited from

AugmentedOneTxPayment.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)

---

version()

version(overrides?): Promise\<BigNumber>

Parameters

overrides?

CallOverrides

Returns

Promise\<BigNumber>

Inherited from

AugmentedOneTxPayment.version

---

version()()

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

Parameters

overrides?

CallOverrides

Returns

Promise\<BigNumber>

Inherited from

AugmentedOneTxPayment.version()