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 (MetaTxCreator.tx) as well as metatransactions (MetaTxCreator.metaTx).

Create a standard transaction ("force" in dApp)​

Learn more about these functions in their individual documentation

Extends​

Extended by​

Type Parameters​

• C extends MetaTxBaseContract

• M extends keyof C["functions"]

• E extends EventData

• MD extends MetadataType = DEFAULT

Constructors​

new MetaTxCreator()​

new MetaTxCreator\<C, M, E, MD>(__namedParameters): MetaTxCreator\<C, M, E, MD>

Parameters​

__namedParameters​
args​

unknown[] | () => Promise\<unknown[]>

config​

ContractConfig

contract​

C

eventData​

(receipt) => Promise\<E>

metadataType​

MD

method​

M

txConfig​

TxConfig\<MD>

Returns​

MetaTxCreator\<C, M, E, 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 TxCreator.tx and https://docs.colony.io/colonysdk/guides/transactions for more information

Returns​

ColonyMetaTransaction\<TransactionResponse, E, ParsedLogTransactionReceipt, MD>

A transaction that can be send or mined.

Remarks​

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


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

Returns​

ColonyTransaction\<ContractTransaction, E, ContractReceipt, MD>

A transaction that can be send, mined or encoded.

Remarks​

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

Inherited from​

TxCreator.tx