Skip to main content

Interface: OneTxPaymentClientV3

Hierarchy

  • AugmentedOneTxPayment<OneTxPayment>

    OneTxPaymentClientV3

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

NameType
authority(overrides?: CallOverrides) => Promise<string>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<string>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getChainId(overrides?: CallOverrides) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<BigNumber>
identifier(overrides?: CallOverrides) => Promise<string>
install(_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>
makePaymentFundedFromDomain(_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>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
version(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.callStatic


clientType

clientType: OneTxPaymentClient

Inherited from

AugmentedOneTxPayment.clientType


clientVersion

clientVersion: 3

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

NameType
ExtensionInitialised() => ExtensionInitialisedEventFilter
ExtensionInitialised()() => ExtensionInitialisedEventFilter
LogSetAuthority(authority?: null | string) => LogSetAuthorityEventFilter
LogSetAuthority(address)(authority?: null | string) => LogSetAuthorityEventFilter
LogSetOwner(owner?: null | string) => LogSetOwnerEventFilter
LogSetOwner(address)(owner?: null | string) => LogSetOwnerEventFilter
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

NameType
authority(overrides?: CallOverrides) => Promise<[string]>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getChainId(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
identifier(overrides?: CallOverrides) => Promise<[string]>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<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<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<string> }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
version(overrides?: CallOverrides) => Promise<[BigNumber]>

Inherited from

AugmentedOneTxPayment.functions


interface

interface: OneTxPaymentInterface

Inherited from

AugmentedOneTxPayment.interface


off

off: OnEvent<OneTxPaymentClientV3>

Inherited from

AugmentedOneTxPayment.off


on

on: OnEvent<OneTxPaymentClientV3>

Inherited from

AugmentedOneTxPayment.on


once

once: OnEvent<OneTxPaymentClientV3>

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

NameType
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce(userAddress: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string | Promise<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<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<string> }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: 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<OneTxPaymentClientV3>

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

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedOneTxPayment._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedOneTxPayment._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedOneTxPayment._wrapEvent


attach

attach(addressOrName): OneTxPaymentClientV3

Parameters

NameType
addressOrNamestring

Returns

OneTxPaymentClientV3

Inherited from

AugmentedOneTxPayment.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.authority


connect

connect(signerOrProvider): OneTxPaymentClientV3

Parameters

NameType
signerOrProviderstring | Provider | Signer

Returns

OneTxPaymentClientV3

Inherited from

AugmentedOneTxPayment.connect


deployed

deployed(): Promise<OneTxPaymentClientV3>

Returns

Promise<OneTxPaymentClientV3>

Inherited from

AugmentedOneTxPayment.deployed


deprecate

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

Called when deprecating (or undeprecating) the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.deprecate


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

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

NameTypeDescription
_userstringAddress of user trying to do meta transaction
_payloadBytesLikeFunction call to make via meta transaction
_sigRBytesLikeR part of the signature
_sigSBytesLikeS part of the signature
_sigVBigNumberishV part of the signature
overrides?PayableOverrides & { from?: string | Promise<string> }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.executeMetaTransaction


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedOneTxPayment.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.finishUpgrade


getCapabilityRoles

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

Return the permissions required for each function

Parameters

NameTypeDescription
_sigBytesLikeThe function signature
overrides?CallOverrides-

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.getCapabilityRoles


getChainId

getChainId(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.getChainId


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.getColony


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedOneTxPayment.getDeprecated


getMetatransactionNonce

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

Parameters

NameType
userAddressstring
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.getMetatransactionNonce


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.identifier


install

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

Configures the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.install


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

AugmentedOneTxPayment.listenerCount


listeners

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

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilter?TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Inherited from

AugmentedOneTxPayment.listeners

listeners(eventName?): Listener[]

Parameters

NameType
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

NameTypeDescription
_permissionDomainIdBigNumberishThe domainId in which the contract has permissions to add a payment and fund it
_childSkillIndexBigNumberishIndex of the _permissionDomainId skill.children array to get
_callerPermissionDomainIdBigNumberishThe domainId in which the caller has the administration permission (must have funding in root)
_callerChildSkillIndexBigNumberishIndex of the _callerPermissionDomainId skill.children array to get
_workersstring[]The addresses of the recipients of the payment
_tokensstring[]Addresses of the tokens the payments are being made in. 0x00 for Ether.
_amountsBigNumberish[]amounts of the tokens being paid out
_domainIdBigNumberishThe domainId the payment should be coming from
_skillIdBigNumberishThe skillId that the payment should be marked with, possibly awarding reputation in this skill.
overrides?Overrides & { from?: string | Promise<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

NameTypeDescription
_permissionDomainIdBigNumberishThe domainId in which the contract has permissions to add a payment and fund it
_childSkillIndexBigNumberishIndex of the _permissionDomainId skill.children array to get
_callerPermissionDomainIdBigNumberishThe domainId in which the caller has permissions to add a payment and fund it
_callerChildSkillIndexBigNumberishIndex of the _callerPermissionDomainId skill.children array to get
_workersstring[]The addresses of the recipients of the payment
_tokensstring[]The addresses of the token the payments are being made in. 0x00 for Ether.
_amountsBigNumberish[]The amounts of the tokens being paid out
_domainIdBigNumberishThe domainId the payment should be coming from
_skillIdBigNumberishThe skillId that the payment should be marked with, possibly awarding reputation in this skill.
overrides?Overrides & { from?: string | Promise<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

NameTypeDescription
_workersstring[]The addresses of the recipients of the payment
_tokensstring[]The addresses of the token the payments are being made in. 0x00 for Ether.
_amountsBigNumberish[]The amounts of the tokens being paid out
_domainIdBigNumberishThe domainId the payment should be coming from
_skillIdBigNumberishThe 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

NameTypeDescription
_workersstring[]The addresses of the recipients of the payment
_tokensstring[]Addresses of the tokens the payments are being made in. 0x00 for Ether.
_amountsBigNumberish[]amounts of the tokens being paid out
_domainIdBigNumberishThe domainId the payment should be coming from
_skillIdBigNumberishThe 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

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedOneTxPayment.owner


queryFilter

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

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

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

Returns

Promise<TEvent[]>

Inherited from

AugmentedOneTxPayment.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): OneTxPaymentClientV3

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

OneTxPaymentClientV3

Inherited from

AugmentedOneTxPayment.removeAllListeners

removeAllListeners(eventName?): OneTxPaymentClientV3

Parameters

NameType
eventName?string

Returns

OneTxPaymentClientV3

Inherited from

AugmentedOneTxPayment.removeAllListeners


setAuthority

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setAuthority


setOwner

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

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.setOwner


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

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

Returns

Promise<ContractTransaction>

Inherited from

AugmentedOneTxPayment.uninstall


verify

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

Parameters

NameType
_ownerstring
_nonceBigNumberish
_chainIdBigNumberish
_payloadBytesLike
_sigRBytesLike
_sigSBytesLike
_sigVBigNumberish
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedOneTxPayment.verify


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedOneTxPayment.version