Package org.symbol.sdk.symbol

Class SymbolTransactionFactory

java.lang.Object

org.symbol.sdk.symbol.SymbolTransactionFactory

---

public final class SymbolTransactionFactory extends Object

SymbolTransactionFactory

Factory for creating Symbol transactions. Wraps the catbuffer-generated TransactionFactory.createByName(String) with a RuleBasedTransactionFactory preconfigured with Symbol specific parsing rules.

• Constructor Summary

  Constructors

  Constructor

  Description

  SymbolTransactionFactory(Network network)

  Creates a factory for the specified network.

  SymbolTransactionFactory(Network network, Map<String,Function<Object,Object>> typeRuleOverrides)

  Creates a factory for the specified network with per-type rule overrides.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static String

  attachSignature(Transaction transaction, CryptoTypes.Signature signature)

  Attaches a signature to a transaction.

  Transaction

  create(Map<String,Object> transactionDescriptor)

  Creates a transaction from a transaction descriptor.

  Transaction

  create(Map<String,Object> transactionDescriptor, boolean autosort)

  Creates a transaction from a transaction descriptor.

  EmbeddedTransaction

  createEmbedded(Map<String,Object> transactionDescriptor)

  Creates an embedded transaction from a transaction descriptor.

  EmbeddedTransaction

  createEmbedded(Map<String,Object> transactionDescriptor, boolean autosort)

  Creates an embedded transaction from a transaction descriptor.

  static Transaction

  deserialize(byte[] payload)

  Deserializes a transaction from a binary payload.

  static Transaction

  deserialize(ByteBuffer buffer)

  Deserializes a transaction from a byte buffer.

  static EmbeddedTransaction

  deserializeEmbedded(byte[] payload)

  Deserializes an embedded transaction from a binary payload.

  static EmbeddedTransaction

  deserializeEmbedded(ByteBuffer buffer)

  Deserializes an embedded transaction from a byte buffer.

  Set<String>

  getRuleNames()

  Gets rule names with registered hints.

  static String

  lookupTransactionName(TransactionType transactionType, int transactionVersion)

  Looks up the friendly name for the specified transaction.

  static String

  toJson(Transaction transaction)

  Generates a JSON representation of transaction that can be sent to a node.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • SymbolTransactionFactory

    public SymbolTransactionFactory(Network network)

    Creates a factory for the specified network.

    Parameters:

    network - Symbol network.

  • SymbolTransactionFactory

    public SymbolTransactionFactory(Network network, Map<String,Function<Object,Object>> typeRuleOverrides)

    Creates a factory for the specified network with per-type rule overrides.

    Parameters:

    network - Symbol network.

    typeRuleOverrides - Per-rule parser overrides keyed by rule name. May be null.

• Method Details

  • getRuleNames

    public Set<String> getRuleNames()

    SymbolTransactionFactory.getRuleNames

    Gets rule names with registered hints.

    Returns:

    Rule names with registered hints.

  • lookupTransactionName

    public static String lookupTransactionName(TransactionType transactionType, int transactionVersion)

    SymbolTransactionFactory.lookupTransactionName

    Looks up the friendly name for the specified transaction.

    Parameters:

    transactionType - Transaction type.

    transactionVersion - Transaction version.

    Returns:

    Transaction friendly name (e.g. "transfer_transaction_v1").

  • create

    public Transaction create(Map<String,Object> transactionDescriptor)

    SymbolTransactionFactory.create

    Creates a transaction from a transaction descriptor.

    Parameters:

    transactionDescriptor - Transaction descriptor.

    Returns:

    Newly created transaction.

  • create

    public Transaction create(Map<String,Object> transactionDescriptor, boolean autosort)

    SymbolTransactionFactory.create

    Creates a transaction from a transaction descriptor.

    Parameters:

    transactionDescriptor - Transaction descriptor.

    autosort - When true, descriptor arrays requiring ordering will be automatically sorted.

    Returns:

    Newly created transaction.

  • createEmbedded

    public EmbeddedTransaction createEmbedded(Map<String,Object> transactionDescriptor)

    SymbolTransactionFactory.createEmbedded

    Creates an embedded transaction from a transaction descriptor.

    Parameters:

    transactionDescriptor - Transaction descriptor.

    Returns:

    Newly created embedded transaction.

  • createEmbedded

    public EmbeddedTransaction createEmbedded(Map<String,Object> transactionDescriptor, boolean autosort)

    SymbolTransactionFactory.createEmbedded

    Creates an embedded transaction from a transaction descriptor.

    Parameters:

    transactionDescriptor - Transaction descriptor.

    autosort - When true, descriptor arrays requiring ordering will be automatically sorted.

    Returns:

    Newly created embedded transaction.

  • deserialize

    public static Transaction deserialize(byte[] payload)

    SymbolTransactionFactory.deserialize

    Deserializes a transaction from a binary payload.

    Parameters:

    payload - Binary payload.

    Returns:

    Deserialized transaction.

  • deserialize

    public static Transaction deserialize(ByteBuffer buffer)

    SymbolTransactionFactory.deserialize

    Deserializes a transaction from a byte buffer.

    Parameters:

    buffer - Binary payload buffer.

    Returns:

    Deserialized transaction.

  • deserializeEmbedded

    public static EmbeddedTransaction deserializeEmbedded(byte[] payload)

    SymbolTransactionFactory.deserializeEmbedded

    Deserializes an embedded transaction from a binary payload.

    Parameters:

    payload - Binary payload.

    Returns:

    Deserialized embedded transaction.

  • deserializeEmbedded

    public static EmbeddedTransaction deserializeEmbedded(ByteBuffer buffer)

    SymbolTransactionFactory.deserializeEmbedded

    Deserializes an embedded transaction from a byte buffer.

    Parameters:

    buffer - Binary payload buffer.

    Returns:

    Deserialized embedded transaction.

  • attachSignature

    public static String attachSignature(Transaction transaction, CryptoTypes.Signature signature)

    SymbolTransactionFactory.attachSignature

    Attaches a signature to a transaction.

    Parameters:

    transaction - Transaction object.

    signature - Signature to attach.

    Returns:

    JSON transaction payload.

  • toJson

    public static String toJson(Transaction transaction)

    SymbolTransactionFactory.toJson

    Generates a JSON representation of transaction that can be sent to a node.

    Parameters:

    transaction - Transaction object.

    Returns:

    JSON transaction payload.