Skip to main content

Class: MetaTxCreator<C, M, E, MD>

An umbrella API for all kinds of transactions

The MetaTxCreator allows for a simple API to cover all the different cases of transactions within the Colony Network. The MetaTxCreator supports sending a standard transaction (tx) as well as metatransactions (metaTx).

Create a standard transaction ("force" in dApp)

  • tx: force a Colony transaction, knowing you have the permissions to do so
  • metaTx: same as tx(), but send as a gasless metatransaction

Learn more about these functions in their individual documentation

Type parameters

NameType
Cextends MetaTxBaseContract
Mextends keyof C["functions"]
Eextends EventData
MDextends MetadataType

Hierarchy

Constructors

constructor

new MetaTxCreator<C, M, E, MD>(«destructured»)

Type parameters

NameType
Cextends MetaTxBaseContract
Mextends string | number | symbol
Eextends EventData
MDextends MetadataType

Parameters

NameType
«destructured»Object
› argsunknown[] | () => Promise<unknown[]>
› colonyNetworkColonyNetwork
› contractC
› eventData?(receipt: ContractReceipt) => Promise<E>
› metadataType?MD
› methodM
› txConfig?TxConfig<MD>

Inherited from

TxCreator.constructor

Methods

metaTx

metaTx(): ColonyMetaTransaction<TransactionResponse, E, ParsedLogTransactionReceipt, MD>

Create a gasless MetaTransaction ("force" in dApp)

After creation, you can then send the transaction or wait for it to be mined. See also tx and https://docs.colony.io/colonysdk/guides/transactions for more information

Remarks

The user sending this transaction has to have the appropriate permissions to do so. Learn more about permissions in Colony here.

Returns

ColonyMetaTransaction<TransactionResponse, E, ParsedLogTransactionReceipt, MD>

A transaction that can be send or mined.


tx

tx(): ColonyTransaction<ContractTransaction, E, ContractReceipt, MD>

Create a standard transaction ("force" in dApp)

See also ColonyTransaction or https://docs.colony.io/colonysdk/guides/transactions for more information

Remarks

The user sending this transaction has to have the appropriate permissions to do so. Learn more about permissions in Colony here.

Returns

ColonyTransaction<ContractTransaction, E, ContractReceipt, MD>

A transaction that can be send, mined or encoded.

Inherited from

TxCreator.tx