Interface TransactionFactoryInterface

Defines the interface for a transaction factory. It allows us to create, serialize and deserialize transactions and their messages.

interface TransactionFactoryInterface {
    create(input: TransactionInput): Transaction;
    deserialize(serializedTransaction: SerializedTransaction): Transaction;
    deserializeMessage(
        serializedMessage: SerializedTransactionMessage,
    ): TransactionMessage;
    getDefaultVersion(): TransactionVersion;
    serialize(transaction: Transaction): SerializedTransaction;
    serializeMessage(message: TransactionMessage): SerializedTransactionMessage;
}

Index

Methods

create deserialize deserializeMessage getDefaultVersion serialize serializeMessage

Methods

create

create(input: TransactionInput): Transaction
Creates a new transaction from a given input.
Parameters
- input: TransactionInput
Returns Transaction
- Defined in packages/umi/src/TransactionFactoryInterface.ts:19

deserialize

deserialize(serializedTransaction: SerializedTransaction): Transaction
Deserializes a transaction.
Parameters
- serializedTransaction: SerializedTransaction
Returns Transaction
- Defined in packages/umi/src/TransactionFactoryInterface.ts:23

deserializeMessage

deserializeMessage(
serializedMessage: SerializedTransactionMessage,
): TransactionMessage
Deserializes a transaction message.
Parameters
- serializedMessage: SerializedTransactionMessage
Returns TransactionMessage
- Defined in packages/umi/src/TransactionFactoryInterface.ts:27

getDefaultVersion

getDefaultVersion(): TransactionVersion
The version TransactionBuilder builds when none was set on it. create still requires the version in its input.

Returns TransactionVersion
- Defined in packages/umi/src/TransactionFactoryInterface.ts:34

serialize

serialize(transaction: Transaction): SerializedTransaction
Serializes a transaction.
Parameters
- transaction: Transaction
Returns SerializedTransaction
- Defined in packages/umi/src/TransactionFactoryInterface.ts:21

serializeMessage

serializeMessage(message: TransactionMessage): SerializedTransactionMessage
Serializes a transaction message.
Parameters
- message: TransactionMessage
Returns SerializedTransactionMessage
- Defined in packages/umi/src/TransactionFactoryInterface.ts:25