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

An umbrella API for all kinds of transactions

The TxCreator allows for a simple API to cover all the different cases of transactions within the Colony Network. This is the base class of the TxCreator that only supports the tx() action and no metatransactions.

Create a standard transaction ("force" in dApp)

• tx: force a Colony transaction, knowing you have the permissions to do so

Learn more about these functions in their individual documentation

Type parameters

Name	Type
C	extends BaseContract
M	extends keyof C["functions"]
E	extends EventData
MD	extends MetadataType

Hierarchy

• TxCreator

  ↳ MetaTxCreator

Constructors

constructor

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

Type parameters

Name	Type
C	extends BaseContract
M	extends string | number | symbol
E	extends EventData
MD	extends MetadataType

Parameters

Name	Type
«destructured»	Object
› args	unknown[] | () => Promise<unknown[]>
› colonyNetwork	ColonyNetwork
› contract	C
› eventData?	(receipt: ContractReceipt) => Promise<E>
› metadataType?	MD
› method	M
› txConfig?	TxConfig<MD>

Methods

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.