Interface: OneTxPaymentClientV1

Hierarchy

• AugmentedOneTxPayment<OneTxPayment>

  ↳ OneTxPaymentClientV1

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>
authority()	(overrides?: CallOverrides) => Promise<string>
deprecate	(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
deprecate(bool)	(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
finishUpgrade	(overrides?: CallOverrides) => Promise<void>
finishUpgrade()	(overrides?: CallOverrides) => Promise<void>
getColony	(overrides?: CallOverrides) => Promise<string>
getColony()	(overrides?: CallOverrides) => Promise<string>
getDeprecated	(overrides?: CallOverrides) => Promise<boolean>
getDeprecated()	(overrides?: CallOverrides) => Promise<boolean>
identifier	(overrides?: CallOverrides) => Promise<string>
identifier()	(overrides?: CallOverrides) => Promise<string>
install	(_colony: string, overrides?: CallOverrides) => Promise<void>
install(address)	(_colony: string, overrides?: CallOverrides) => Promise<void>
makePayment	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: CallOverrides) => Promise<void>
makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: CallOverrides) => Promise<void>
makePaymentFundedFromDomain	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: CallOverrides) => Promise<void>
makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: CallOverrides) => Promise<void>
owner	(overrides?: CallOverrides) => Promise<string>
owner()	(overrides?: CallOverrides) => Promise<string>
setAuthority	(authority_: string, overrides?: CallOverrides) => Promise<void>
setAuthority(address)	(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner	(owner_: string, overrides?: CallOverrides) => Promise<void>
setOwner(address)	(owner_: string, overrides?: CallOverrides) => Promise<void>
uninstall	(overrides?: CallOverrides) => Promise<void>
uninstall()	(overrides?: CallOverrides) => Promise<void>
version	(overrides?: CallOverrides) => Promise<BigNumber>
version()	(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.callStatic

---

clientType

• clientType: OneTxPaymentClient

Inherited from

AugmentedOneTxPayment.clientType

---

clientVersion

• clientVersion: 1

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

Type declaration

Name	Type
ExtensionInitialised	() => ExtensionInitialisedEventFilter
ExtensionInitialised()	() => ExtensionInitialisedEventFilter
LogSetAuthority	(authority?: null | string) => LogSetAuthorityEventFilter
LogSetAuthority(address)	(authority?: null | string) => LogSetAuthorityEventFilter
LogSetOwner	(owner?: null | string) => LogSetOwnerEventFilter
LogSetOwner(address)	(owner?: null | string) => LogSetOwnerEventFilter
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]>
authority()	(overrides?: CallOverrides) => Promise<[string]>
deprecate	(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(bool)	(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade()	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
getColony	(overrides?: CallOverrides) => Promise<[string]>
getColony()	(overrides?: CallOverrides) => Promise<[string]>
getDeprecated	(overrides?: CallOverrides) => Promise<[boolean]>
getDeprecated()	(overrides?: CallOverrides) => Promise<[boolean]>
identifier	(overrides?: CallOverrides) => Promise<[string]>
identifier()	(overrides?: CallOverrides) => Promise<[string]>
install	(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(address)	(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
makePayment	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
makePaymentFundedFromDomain	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
owner	(overrides?: CallOverrides) => Promise<[string]>
owner()	(overrides?: CallOverrides) => Promise<[string]>
setAuthority	(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setAuthority(address)	(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner	(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(address)	(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall()	(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
version	(overrides?: CallOverrides) => Promise<[BigNumber]>
version()	(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from

AugmentedOneTxPayment.functions

---

interface

• interface: OneTxPaymentInterface

Inherited from

AugmentedOneTxPayment.interface

---

off

• off: OnEvent<OneTxPaymentClientV1>

Inherited from

AugmentedOneTxPayment.off

---

on

• on: OnEvent<OneTxPaymentClientV1>

Inherited from

AugmentedOneTxPayment.on

---

once

• once: OnEvent<OneTxPaymentClientV1>

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>
authority()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate	(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(bool)	(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade	(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade()	(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
getColony	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
install	(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(address)	(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
makePayment	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
makePayment(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
makePaymentFundedFromDomain	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
makePaymentFundedFromDomain(uint256,uint256,uint256,uint256,address[],address[],uint256[],uint256,uint256)	(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _workers: string[], _tokens: string[], _amounts: BigNumberish[], _domainId: BigNumberish, _skillId: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
owner	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority	(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setAuthority(address)	(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner	(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(address)	(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall	(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall()	(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
version	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
version()	(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedOneTxPayment.populateTransaction

---

provider

• Readonly provider: Provider

Inherited from

AugmentedOneTxPayment.provider

---

removeListener

• removeListener: OnEvent<OneTxPaymentClientV1>

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

Parameters

Name	Type
addressOrName	string

Returns

OneTxPaymentClientV1

Inherited from

AugmentedOneTxPayment.attach

---

authority

▸ authority(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.authority

---

authority()

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

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.authority()

---

connect

▸ connect(signerOrProvider): OneTxPaymentClientV1

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

OneTxPaymentClientV1

Inherited from

AugmentedOneTxPayment.connect

---

deployed

▸ deployed(): Promise<OneTxPaymentClientV1>

Returns

Promise<OneTxPaymentClientV1>

Inherited from

AugmentedOneTxPayment.deployed

---

deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate

---

deprecate(bool)

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate(bool)

---

emit

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

Parameters

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

Returns

boolean

Inherited from

AugmentedOneTxPayment.emit

---

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade

---

finishUpgrade()

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

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade()

---

getColony

▸ getColony(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.getColony

---

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

---

getDeprecated()

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

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedOneTxPayment.getDeprecated()

---

identifier

▸ identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.identifier

---

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	string	The colony in which the extension holds permissions
overrides?	Overrides & { from?: string }	-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.install

---

install(address)

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.install(address)

---

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	BigNumberish	The domainId in which the contract has permissions to add a payment and fund it
_childSkillIndex	BigNumberish	Index of the _permissionDomainId skill.children array to get
_callerPermissionDomainId	BigNumberish	The domainId in which the caller has the administration permission (must have funding in root)
_callerChildSkillIndex	BigNumberish	Index of the _callerPermissionDomainId skill.children array to get
_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?	Overrides & { from?: string }	-

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>

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	BigNumberish	The domainId in which the contract has permissions to add a payment and fund it
_childSkillIndex	BigNumberish	Index of the _permissionDomainId skill.children array to get
_callerPermissionDomainId	BigNumberish	The domainId in which the caller has the administration permission (must have funding in root)
_callerChildSkillIndex	BigNumberish	Index of the _callerPermissionDomainId skill.children array to get
_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?	Overrides & { from?: string }	-

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>

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	BigNumberish	The domainId in which the contract has permissions to add a payment and fund it
_childSkillIndex	BigNumberish	Index of the _permissionDomainId skill.children array to get
_callerPermissionDomainId	BigNumberish	The domainId in which the caller has permissions to add a payment and fund it
_callerChildSkillIndex	BigNumberish	Index of the _callerPermissionDomainId skill.children array to get
_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?	Overrides & { from?: string }	-

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>

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	BigNumberish	The domainId in which the contract has permissions to add a payment and fund it
_childSkillIndex	BigNumberish	Index of the _permissionDomainId skill.children array to get
_callerPermissionDomainId	BigNumberish	The domainId in which the caller has permissions to add a payment and fund it
_callerChildSkillIndex	BigNumberish	Index of the _callerPermissionDomainId skill.children array to get
_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?	Overrides & { from?: string }	-

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

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

---

owner

▸ owner(overrides?): Promise<string>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.owner

---

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

Type parameters

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

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

OneTxPaymentClientV1

Inherited from

AugmentedOneTxPayment.removeAllListeners

▸ removeAllListeners(eventName?): OneTxPaymentClientV1

Parameters

Name	Type
eventName?	string

Returns

OneTxPaymentClientV1

Inherited from

AugmentedOneTxPayment.removeAllListeners

---

setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority

---

setAuthority(address)

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority(address)

---

setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner

---

setOwner(address)

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner(address)

---

uninstall

▸ uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall

---

uninstall()

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

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall()

---

version

▸ version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.version

---

version()

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

Returns the version of the extension

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.version()