Interface: OneTxPaymentClientV4

Hierarchy

AugmentedOneTxPayment<OneTxPayment>
↳ OneTxPaymentClientV4

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: any[]) => void

Inherited from

AugmentedOneTxPayment._wrappedEmits

address

• Readonly address: string

Inherited from

AugmentedOneTxPayment.address

callStatic

• callStatic: Object

Type declaration

Name	Type
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`executeMetaTransaction`	(`_user`: `PromiseOrValue`<`string`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<`string`>
`finishUpgrade`	(`overrides?`: `CallOverrides`) => `Promise`<`void`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<`string`>
`getChainId`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`getMetatransactionNonce`	(`userAddress`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`makePayment`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`makePaymentFundedFromDomain`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`multicall`	(`data`: `PromiseOrValue`<`BytesLike`>[], `overrides?`: `CallOverrides`) => `Promise`<`string`[]>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<`string`>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`void`>
`uninstall`	(`overrides?`: `CallOverrides`) => `Promise`<`void`>
`verify`	(`_owner`: `PromiseOrValue`<`string`>, `_nonce`: `PromiseOrValue`<`BigNumberish`>, `_chainId`: `PromiseOrValue`<`BigNumberish`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<`boolean`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<`BigNumber`>

Inherited from

AugmentedOneTxPayment.callStatic

clientType

• clientType: OneTxPaymentClient

Inherited from

AugmentedOneTxPayment.clientType

clientVersion

• clientVersion: 4

Overrides

AugmentedOneTxPayment.clientVersion

colonyClient

• colonyClient: AugmentedIColony<AnyIColony>

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

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`
`OneTxPaymentMade`	(`agent?`: `null`, `fundamentalId?`: `null`, `nPayouts?`: `null`) => `OneTxPaymentMadeEventFilter`
`OneTxPaymentMade(address,uint256,uint256)`	(`agent?`: `null`, `fundamentalId?`: `null`, `nPayouts?`: `null`) => `OneTxPaymentMadeEventFilter`

Inherited from

AugmentedOneTxPayment.filters

functions

• functions: Object

Type declaration

Name	Type
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`executeMetaTransaction`	(`_user`: `PromiseOrValue`<`string`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `PayableOverrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`finishUpgrade`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_roles`: `string` }>
`getChainId`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`]>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`getMetatransactionNonce`	(`userAddress`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `nonce`: `BigNumber` }>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`] & { `_identifier`: `string` }>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`makePayment`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`makePaymentFundedFromDomain`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`multicall`	(`data`: `PromiseOrValue`<`BytesLike`>[], `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<[`string`]>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`uninstall`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`ContractTransaction`>
`verify`	(`_owner`: `PromiseOrValue`<`string`>, `_nonce`: `PromiseOrValue`<`BigNumberish`>, `_chainId`: `PromiseOrValue`<`BigNumberish`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<[`boolean`]>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<[`BigNumber`] & { `_version`: `BigNumber` }>

Inherited from

AugmentedOneTxPayment.functions

interface

• interface: OneTxPaymentInterface

Inherited from

AugmentedOneTxPayment.interface

off

• off: OnEvent<OneTxPaymentClientV4>

Inherited from

AugmentedOneTxPayment.off

on

• on: OnEvent<OneTxPaymentClientV4>

Inherited from

AugmentedOneTxPayment.on

once

• once: OnEvent<OneTxPaymentClientV4>

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

Type declaration

Name	Type
`authority`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`deprecate`	(`_deprecated`: `PromiseOrValue`<`boolean`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`executeMetaTransaction`	(`_user`: `PromiseOrValue`<`string`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `PayableOverrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`finishUpgrade`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`getCapabilityRoles`	(`_sig`: `PromiseOrValue`<`BytesLike`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getChainId`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getColony`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getDeprecated`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`getMetatransactionNonce`	(`userAddress`: `PromiseOrValue`<`string`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`identifier`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`install`	(`_colony`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`makePayment`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`makePaymentFundedFromDomain`	(`_permissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_childSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_callerPermissionDomainId`: `PromiseOrValue`<`BigNumberish`>, `_callerChildSkillIndex`: `PromiseOrValue`<`BigNumberish`>, `_workers`: `PromiseOrValue`<`string`>[], `_tokens`: `PromiseOrValue`<`string`>[], `_amounts`: `PromiseOrValue`<`BigNumberish`>[], `_domainId`: `PromiseOrValue`<`BigNumberish`>, `_skillId`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`multicall`	(`data`: `PromiseOrValue`<`BytesLike`>[], `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`owner`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`setAuthority`	(`authority_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`setOwner`	(`owner_`: `PromiseOrValue`<`string`>, `overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`uninstall`	(`overrides?`: `Overrides` & { `from?`: `PromiseOrValue`<`string`> }) => `Promise`<`PopulatedTransaction`>
`verify`	(`_owner`: `PromiseOrValue`<`string`>, `_nonce`: `PromiseOrValue`<`BigNumberish`>, `_chainId`: `PromiseOrValue`<`BigNumberish`>, `_payload`: `PromiseOrValue`<`BytesLike`>, `_sigR`: `PromiseOrValue`<`BytesLike`>, `_sigS`: `PromiseOrValue`<`BytesLike`>, `_sigV`: `PromiseOrValue`<`BigNumberish`>, `overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>
`version`	(`overrides?`: `CallOverrides`) => `Promise`<`PopulatedTransaction`>

Inherited from

AugmentedOneTxPayment.populateTransaction

provider

• Readonly provider: Provider

Inherited from

AugmentedOneTxPayment.provider

removeListener

• removeListener: OnEvent<OneTxPaymentClientV4>

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

Name	Type
`runningEvent`	`RunningEvent`

Returns

void

Inherited from

AugmentedOneTxPayment._checkRunningEvents

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
`blockTag?`	`BlockTag`

Returns

Promise<Contract>

Inherited from

AugmentedOneTxPayment._deployed

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
`runningEvent`	`RunningEvent`
`log`	`Log`
`listener`	`Listener`

Returns

Event

Inherited from

AugmentedOneTxPayment._wrapEvent

attach

▸ attach(addressOrName): OneTxPaymentClientV4

Parameters

Name	Type
`addressOrName`	`string`

Returns

OneTxPaymentClientV4

Inherited from

AugmentedOneTxPayment.attach

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.authority

connect

▸ connect(signerOrProvider): OneTxPaymentClientV4

Parameters

Name	Type
`signerOrProvider`	`string` \| `Provider` \| `Signer`

Returns

OneTxPaymentClientV4

Inherited from

AugmentedOneTxPayment.connect

deployed

▸ deployed(): Promise<OneTxPaymentClientV4>

Returns

Promise<OneTxPaymentClientV4>

Inherited from

AugmentedOneTxPayment.deployed

deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate

emit

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

Parameters

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

Returns

boolean

Inherited from

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

AugmentedOneTxPayment.executeMetaTransaction

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
`overrides?`	`TransactionRequest`

Returns

Promise<TransactionResponse>

Inherited from

AugmentedOneTxPayment.fallback

finishUpgrade

▸ finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade

getCapabilityRoles

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

Return the permissions required for each function

Parameters

Name	Type	Description
`_sig`	`PromiseOrValue`<`BytesLike`>	The function signature
`overrides?`	`CallOverrides`	-

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.getCapabilityRoles

getChainId

▸ getChainId(overrides?): Promise<BigNumber>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.getChainId

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.getColony

getDeprecated

▸ getDeprecated(overrides?): Promise<boolean>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<boolean>

Inherited from

AugmentedOneTxPayment.getDeprecated

getMetatransactionNonce

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

Gets the next nonce for a meta-transaction

Parameters

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

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.getMetatransactionNonce

identifier

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.identifier

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

AugmentedOneTxPayment.install

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
`eventName?`	`string` \| `EventFilter`

Returns

number

Inherited from

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

AugmentedOneTxPayment.listeners

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
`eventName?`	`string`

Returns

Listener[]

Inherited from

AugmentedOneTxPayment.listeners

makePayment

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

Assumes that each entity holds administration and funding roles in the root domain Completes a colony payment in a single transaction

Parameters

Name	Type	Description
`_permissionDomainId`	`PromiseOrValue`<`BigNumberish`>	The domainId in which the contract has permissions to add a payment and fund it
`_childSkillIndex`	`PromiseOrValue`<`BigNumberish`>	Index of the _permissionDomainId skill.children array to get
`_callerPermissionDomainId`	`PromiseOrValue`<`BigNumberish`>	The domainId in which the caller has the administration permission (must have funding in root)
`_callerChildSkillIndex`	`PromiseOrValue`<`BigNumberish`>	Index of the _callerPermissionDomainId skill.children array to get
`_workers`	`PromiseOrValue`<`string`>[]	The addresses of the recipients of the payment
`_tokens`	`PromiseOrValue`<`string`>[]	Addresses of the tokens the payments are being made in. 0x00 for Ether.
`_amounts`	`PromiseOrValue`<`BigNumberish`>[]	amounts of the tokens being paid out
`_domainId`	`PromiseOrValue`<`BigNumberish`>	The domainId the payment should be coming from
`_skillId`	`PromiseOrValue`<`BigNumberish`>	The skillId that the payment should be marked with, possibly awarding reputation in this skill.
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePayment

makePaymentFundedFromDomain

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

Assumes that each entity holds administration and funding roles in the same domain, although contract and caller can have the permissions in different domains. Payment is taken from domain funds - if the domain does not have sufficient funds, call will fail. Completes a colony payment in a single transaction

Parameters

Name	Type	Description
`_permissionDomainId`	`PromiseOrValue`<`BigNumberish`>	The domainId in which the contract has permissions to add a payment and fund it
`_childSkillIndex`	`PromiseOrValue`<`BigNumberish`>	Index of the _permissionDomainId skill.children array to get
`_callerPermissionDomainId`	`PromiseOrValue`<`BigNumberish`>	The domainId in which the caller has permissions to add a payment and fund it
`_callerChildSkillIndex`	`PromiseOrValue`<`BigNumberish`>	Index of the _callerPermissionDomainId skill.children array to get
`_workers`	`PromiseOrValue`<`string`>[]	The addresses of the recipients of the payment
`_tokens`	`PromiseOrValue`<`string`>[]	The addresses of the token the payments are being made in. 0x00 for Ether.
`_amounts`	`PromiseOrValue`<`BigNumberish`>[]	The amounts of the tokens being paid out
`_domainId`	`PromiseOrValue`<`BigNumberish`>	The domainId the payment should be coming from
`_skillId`	`PromiseOrValue`<`BigNumberish`>	The skillId that the payment should be marked with, possibly awarding reputation in this skill.
`overrides?`	`Overrides` & { `from?`: `PromiseOrValue`<`string`> }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.makePaymentFundedFromDomain

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

Name	Type	Description
`_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

Name	Type	Description
`_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

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.multicall

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<string>

Inherited from

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

AugmentedOneTxPayment.queryFilter

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): OneTxPaymentClientV4

Type parameters

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

Parameters

Name	Type
`eventFilter`	`TypedEventFilter`<`TEvent`>

Returns

OneTxPaymentClientV4

Inherited from

AugmentedOneTxPayment.removeAllListeners

▸ removeAllListeners(eventName?): OneTxPaymentClientV4

Parameters

Name	Type
`eventName?`	`string`

Returns

OneTxPaymentClientV4

Inherited from

AugmentedOneTxPayment.removeAllListeners

setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority

setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall

verify

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

Parameters

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

Returns

Promise<boolean>

Inherited from

AugmentedOneTxPayment.verify

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
`overrides?`	`CallOverrides`

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.version

Interface: OneTxPaymentClientV4

Hierarchy​

Properties​

_deployedPromise​

Inherited from​

_runningEvents​

Index signature​

Inherited from​

_wrappedEmits​

Index signature​

Inherited from​

address​

Inherited from​

callStatic​

Type declaration​

Inherited from​

clientType​

Inherited from​

clientVersion​

Overrides​

colonyClient​

Inherited from​

deployTransaction​

Inherited from​

estimateGas​

Overrides​

filters​

Type declaration​

Inherited from​

functions​

Type declaration​

Inherited from​

interface​

Inherited from​

off​

Inherited from​

on​

Inherited from​

once​

Inherited from​

oneTxPaymentEvents​

Inherited from​

populateTransaction​

Type declaration​

Inherited from​

provider​

Inherited from​

removeListener​

Inherited from​

resolvedAddress​

Inherited from​

signer​

Inherited from​

Methods​

_checkRunningEvents​

Parameters​

Returns​

Inherited from​

_deployed​

Parameters​

Returns​

Inherited from​

_wrapEvent​

Parameters​

Returns​

Inherited from​

attach​

Parameters​

Returns​

Inherited from​

authority​

Parameters​

Returns​

Inherited from​

connect​

Parameters​

Returns​

Inherited from​

deployed​

Returns​

Hierarchy

Properties

_deployedPromise

Inherited from

_runningEvents

Index signature

Inherited from

_wrappedEmits

Index signature

Inherited from

address

Inherited from

callStatic

Type declaration

Inherited from

clientType

Inherited from

clientVersion

Overrides

colonyClient

Inherited from

deployTransaction

Inherited from

estimateGas

Overrides

filters

Type declaration

Inherited from

functions

Type declaration

Inherited from

interface

Inherited from

off

Inherited from

on

Inherited from

once

Inherited from

oneTxPaymentEvents

Inherited from

populateTransaction

Type declaration

Inherited from

provider

Inherited from

removeListener

Inherited from

resolvedAddress

Inherited from

signer

Inherited from

Methods

_checkRunningEvents

Parameters

Returns

Inherited from

_deployed

Parameters

Returns

Inherited from

_wrapEvent

Parameters

Returns

Inherited from

attach

Parameters

Returns

Inherited from

authority

Parameters

Returns

Inherited from

connect

Parameters

Returns

Inherited from

deployed

Returns

Inherited from