Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransactionApi

Hierarchy

  • TransactionApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private api

api: DCoreApi

Methods

createTransaction

  • Create unsigned transaction

    Parameters

    • operations: BaseOperation[]

      operations to include in transaction

    • Default value expiration: Duration = this.api.transactionExpiration

      transaction expiration in seconds, after the expiry the transaction is removed from recent pool and will be dismissed if not included in DCore block

    Returns Promise<Transaction>

get

  • get applied transaction

    Parameters

    • blockNum: Long | number

      block number

    • trxInBlock: Long | number

      position of the transaction in block

    Returns Promise<ProcessedTransaction>

    a transaction if found, ObjectNotFoundError otherwise

getAllProposed

  • getAllProposed(accountId: ChainObject): Promise<object[]>

  • Get the set of proposed transactions relevant to the specified account id.

    Parameters

    Returns Promise<object[]>

    a set of proposed transactions

getByConfirmation

getById

  • This method will return the transaction for the given ID or it will return [ch.decent.sdk.exception.ObjectNotFoundException]. The ID can be retrieved from [Transaction] or [TransactionConfirmation] objects.

    Note: By default these objects are not tracked, the transaction_history_plugin must be loaded for these objects to be maintained. Just because it is not known does not mean it wasn't included in the DCore.

    Parameters

    • trxId: string

      transaction id

    Returns Promise<ProcessedTransaction>

    a transaction if found, ObjectNotFoundError otherwise

getHexDump

  • getHexDump(transaction: Transaction): Promise<string>

  • Get a hexdump of the serialized binary form of a transaction.

    Parameters

    Returns Promise<string>

    hexadecimal string

getRecent

  • If the transaction has not expired, this method will return the transaction for the given ID or it will return ObjectNotFoundError Just because it is not known does not mean it wasn't included in the DCore. The ID can be retrieved from [Transaction] or [TransactionConfirmation] objects.

    Parameters

    • trxId: string

      transaction id

    Returns Promise<ProcessedTransaction>

    a transaction if found, ObjectNotFoundError otherwise

Generated using TypeDoc