Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OneTxPaymentClient

Hierarchy

  • OneTxPayment
    • OneTxPaymentClient

Indexable

[name: string]: ContractFunction | any

Index

Constructors

constructor

  • new OneTxPaymentClient(addressOrName: string, contractInterface: Array<string | FunctionFragment | EventFragment | ParamType> | string | Interface, signerOrProvider: Signer | Provider): OneTxPaymentClient
  • Parameters

    • addressOrName: string
    • contractInterface: Array<string | FunctionFragment | EventFragment | ParamType> | string | Interface
    • signerOrProvider: Signer | Provider

    Returns OneTxPaymentClient

Properties

address

address: string

addressPromise

addressPromise: Promise<string>

clientType

clientType: OneTxPaymentClient

deployTransaction

deployTransaction: TransactionResponse

estimate

estimate: ExtendedEstimate

filters

filters: {}

Type declaration

functions

functions: { makePayment: any; makePaymentFundedFromDomain: any }

Type declaration

  • makePayment: function
    • makePayment(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): 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 root domain, and the caller must have funding permission explicitly in the root domain Completes a colony payment in a single transaction

      Parameters

      • _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

      • _worker: string

        The address of the recipient of the payment

      • _token: string

        The address of the token the payment is being made in. 0x00 for Ether.

      • _amount: BigNumberish

        The amount of the token being paid out

      • _domainId: BigNumberish

        The Id of the domain the payment should be coming from

      • _skillId: BigNumberish

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

      • Optional overrides: TransactionOverrides

      Returns Promise<ContractTransaction>

  • makePaymentFundedFromDomain: function
    • makePaymentFundedFromDomain(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): 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

      • _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

      • _worker: string

        The address of the recipient of the payment

      • _token: string

        The address of the token the payment is being made in. 0x00 for Ether.

      • _amount: BigNumberish

        The amount of the token being paid out

      • _domainId: BigNumberish

        The Id of the domain the payment should be coming from

      • _skillId: BigNumberish

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

      • Optional overrides: TransactionOverrides

      Returns Promise<ContractTransaction>

interface

interface: OneTxPaymentInterface

provider

provider: Provider

signer

signer: Signer

Methods

_deployed

  • _deployed(blockTag?: BlockTag): Promise<Contract>
  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

addListener

  • addListener(eventName: EventFilter | string, listener: Listener): OneTxPayment

attach

  • attach(addressOrName: string): OneTxPayment

connect

  • connect(signerOrProvider: Signer | Provider | string): OneTxPayment

deployed

  • deployed(): Promise<OneTxPayment>

emit

  • emit(eventName: EventFilter | string, ...args: Array<any>): boolean
  • Parameters

    • eventName: EventFilter | string
    • Rest ...args: Array<any>

    Returns boolean

fallback

  • fallback(overrides?: TransactionRequest): Promise<TransactionResponse>
  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

listenerCount

  • listenerCount(eventName?: EventFilter | string): number
  • Parameters

    • Optional eventName: EventFilter | string

    Returns number

listeners

  • listeners(eventName: EventFilter | string): Array<Listener>
  • Parameters

    • eventName: EventFilter | string

    Returns Array<Listener>

makePayment

  • makePayment(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): 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 root domain, and the caller must have funding permission explicitly in the root domain Completes a colony payment in a single transaction

    Parameters

    • _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

    • _worker: string

      The address of the recipient of the payment

    • _token: string

      The address of the token the payment is being made in. 0x00 for Ether.

    • _amount: BigNumberish

      The amount of the token being paid out

    • _domainId: BigNumberish

      The Id of the domain the payment should be coming from

    • _skillId: BigNumberish

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

    • Optional overrides: TransactionOverrides

    Returns Promise<ContractTransaction>

makePaymentFundedFromDomain

  • makePaymentFundedFromDomain(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _callerPermissionDomainId: BigNumberish, _callerChildSkillIndex: BigNumberish, _worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): 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

    • _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

    • _worker: string

      The address of the recipient of the payment

    • _token: string

      The address of the token the payment is being made in. 0x00 for Ether.

    • _amount: BigNumberish

      The amount of the token being paid out

    • _domainId: BigNumberish

      The Id of the domain the payment should be coming from

    • _skillId: BigNumberish

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

    • Optional overrides: TransactionOverrides

    Returns Promise<ContractTransaction>

makePaymentFundedFromDomainWithProofs

  • makePaymentFundedFromDomainWithProofs(_worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

makePaymentWithProofs

  • makePaymentWithProofs(_worker: string, _token: string, _amount: BigNumberish, _domainId: BigNumberish, _skillId: BigNumberish, overrides?: TransactionOverrides): Promise<ContractTransaction>

on

  • on(event: EventFilter | string, listener: Listener): OneTxPayment

once

  • once(event: EventFilter | string, listener: Listener): OneTxPayment

removeAllListeners

  • removeAllListeners(eventName: EventFilter | string): OneTxPayment

removeListener

  • removeListener(eventName: any, listener: Listener): OneTxPayment

Static isIndexed

  • isIndexed(value: any): value is Indexed
  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc