Skip to main content

Class: OneTxPayment

OneTxPayment (One Transaction Payment)​

Ordinarily payments require more than one transaction, because the payment lifecycle requires more than one permissioned role.

In some use cases, there might be a need for one authorized individual to be able to create, funds, and finalize a payment within a single transaction.

The OneTxPayment extension adds this functionality by adding a makePayment function which requires the caller to have both Funding and administration ability within the domain of the payment.

Extension therefore requires Administration and Funding roles to function.

Note: if you deployed your Colony using the Dapp, the OneTxPayment extension is already installed for you

Properties​

address​

address: string

The extension contract's address

version​

version: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

The extension contract's version

extensionType​

static extensionType: OneTxPayment = Extension.OneTxPayment

supportedVersions​

static supportedVersions: ({ factory: typeof OneTxPayment__factory; version: number; } | { factory: typeof OneTxPayment__factory; version: number; } | { factory: typeof OneTxPayment__factory; version: number; })[]

The currently supported OneTXPayment contract version. If the extension contract is not on this version it has to be upgraded.

Methods​

pay()​

pay(recipient, amount, teamId?, tokenAddress?): ColonyTxCreator\<SupportedOneTxPaymentContract, "makePaymentFundedFromDomain", { agent: string; fundamentalId: BigNumber; nPayouts: BigNumber; }, MetadataType>

Make a payment to a single or multiple addresses using one or more tokens

Parameters​

recipient​

Wallet address of account to send the funds to (also awarded reputation when sending the native token) - can also be an array of addresses to pay

string | string[]

amount​

Amount to pay in wei - can also be an array of amounts for the different tokens

BigNumberish | BigNumberish[]

teamId?​

BigNumberish

The team to use to send the funds from. Has to have funding of at least the amount you need to send. See Colony.moveFundsToTeam. Defaults to the Colony's root team

tokenAddress?​

The address of the token to make the payment in. Default is the Colony's native token - can also be an array of token addresses (needs to be the same length as amount)

string | string[]

Returns​

ColonyTxCreator\<SupportedOneTxPaymentContract, "makePaymentFundedFromDomain", { agent: string; fundamentalId: BigNumber; nPayouts: BigNumber; }, MetadataType>

A transaction creator

Required permissions for forced transaction:​

Event data​

PropertyTypeDescription
agentstringThe address that is responsible for triggering this event
fundamentalIdBigNumberThe newly added payment id
nPayoutsBigNumberNumber of payouts in total

Remarks​

Requires the OneTxPayment extension to be installed for the Colony (this is usually the case for Colonies created via the Dapp). Note that most tokens use 18 decimals, so add a bunch of zeros or use our w or toWei functions (see example)

Example​

import { Id, Tokens, w } from '@colony/sdk';

// Immediately executing async function
(async function() {
  // Pay 10 CLNY (on ArbitrumOne chain) from the root domain to the following address
  // (forced transaction example)
  await colony.ext.oneTx.pay(
     '0xb77D57F4959eAfA0339424b83FcFaf9c15407461',
     w`10`,
     Id.RootDomain,
     Tokens.ArbitrumOne.CLNY,
  ).tx().mined();
})();

upgrade()​

upgrade(toVersion?): ColonyTxCreator\<SupportedColonyContract, "upgradeExtension", { colony: string; extensionId: string; version: BigNumber; }, MetadataType>

Upgrade this extension to the next or a custom version

This method upgrades this extension to a specified version or, if no version is provided to the next higher version.

Parameters​

toVersion?​

BigNumberish

Specify a custom version to upgrade the extension to

Returns​

ColonyTxCreator\<SupportedColonyContract, "upgradeExtension", { colony: string; extensionId: string; version: BigNumber; }, MetadataType>

A transaction creator

Event data​

PropertyTypeDescription
extensionIdstringExtension id (name of the extension) that was upgraded
oldVersionBigNumberVersion of the extension before the upgrade
newVersionBigNumberVersion of the extension after the upgrade

Remarks​

  • Only users with Root role are allowed to upgrade an extension (or another extension with appropriate permissions)
  • Downgrading of extensions is not possible

connect()​

static connect(colony): Promise\<OneTxPayment>

Create an instance of a OneTxPayment extension client and connect the Colony to it

Only supports the latest version of the OneTxPayment contract

Parameters​

colony​

Colony

The Colony instance

Returns​

Promise\<OneTxPayment>

A connected OneTxPayment instance

getLatestSupportedVersion()​

static getLatestSupportedVersion(): 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Returns​

1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9