Packages

object transactions extends Helpful

Annotations
@Summary(s = "Read from transaction stream", flag = FeatureFlag.Testing) @Group(name = "Transactions")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. transactions
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def by_id(parties: Set[PartyId], id: String): Option[TransactionTree]
    Annotations
    @Summary(s = "Get a (tree) transaction by its ID", flag = FeatureFlag.Testing) @Description(s = """Get a transaction tree from the transaction stream by its ID. Returns None if the transaction is not (yet)
    |known at the participant or if the transaction has been pruned via `pruning.prune`."""    )
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def domain_of(transactionId: String): DomainId
    Annotations
    @Summary(s = "Get the domain that a transaction was committed over.", flag = FeatureFlag.Testing) @Description(s = """Get the domain that a transaction was committed over. Throws an error if the transaction is not (yet) known
    |to the participant or if the transaction has been pruned via `pruning.prune`."""    )
  8. def end(): LedgerOffset
    Annotations
    @Summary(s = "Get ledger end", flag = FeatureFlag.Testing)
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def flat(partyIds: Set[PartyId], completeAfter: Int, beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), endOffset: Option[LedgerOffset] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand): Seq[Transaction]
    Annotations
    @Summary(s = "Get flat transactions", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat transaction stream for the given parties and collects transactions
    |until either `completeAfter` transaction trees have been received or `timeout` has elapsed.
    |The returned transactions can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error. If you need to specify filtering conditions for template IDs and
    |including create event blobs for explicit disclosure, consider using `ledger_api.transactions.flat_with_tx_filter`."""    )
  12. def flat_with_tx_filter(filter: TransactionFilter, completeAfter: Int, beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), endOffset: Option[LedgerOffset] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand): Seq[Transaction]
    Annotations
    @Summary(s = "Get flat transactions", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat transaction stream for the given transaction filter and collects transactions
    |until either `completeAfter` transactions have been received or `timeout` has elapsed.
    |The returned transactions can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error. If you only need to filter by a set of parties, consider using
    |`ledger_api.transactions.flat` instead."""    )
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  16. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def start_measuring(parties: Set[PartyId], metricSuffix: String, onTransaction: (TransactionTree) => Unit = _ => ())(implicit consoleEnvironment: ConsoleEnvironment): AutoCloseable
    Annotations
    @Summary(s = "Starts measuring throughput at the transaction service", flag = FeatureFlag.Testing) @Description(s = """This function will subscribe on behalf of `parties` to the transaction tree stream and
    |notify various metrics:
    |The metric `<name>.<metricSuffix>` counts the number of transaction trees emitted.
    |The metric `<name>.<metricSuffix>-tx-node-count` tracks the number of root events emitted as part of transaction trees.
    |The metric `<name>.<metricSuffix>-tx-size` tracks the number of bytes emitted as part of transaction trees.
    |
    |To stop measuring, you need to close the returned `AutoCloseable`.
    |Use the `onTransaction` parameter to register a callback that is called on every transaction tree."""    )
  22. def subscribe_flat(observer: StreamObserver[Transaction], filter: TransactionFilter, beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), endOffset: Option[LedgerOffset] = None, verbose: Boolean = true): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the flat transaction stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the flat transaction stream and passes transactions to `observer` until
    |the stream is completed.
    |Only transactions for parties in `filter.filterByParty.keys` will be returned.
    |Use `filter = TransactionFilter(Map(myParty.toLf -> Filters()))` to return all transactions for `myParty: PartyId`.
    |The returned transactions can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error."""    )
  23. def subscribe_trees(observer: StreamObserver[TransactionTree], filter: TransactionFilter, beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), endOffset: Option[LedgerOffset] = None, verbose: Boolean = true): AutoCloseable
    Annotations
    @Summary(s = "Subscribe to the transaction tree stream", flag = FeatureFlag.Testing) @Description(s = """This function connects to the transaction tree stream and passes transaction trees to `observer` until
    |the stream is completed.
    |Only transaction trees for parties in `filter.filterByParty.keys` will be returned.
    |Use `filter = TransactionFilter(Map(myParty.toLf -> Filters()))` to return all trees for `myParty: PartyId`.
    |The returned transactions can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error."""    )
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def trees(partyIds: Set[PartyId], completeAfter: Int, beginOffset: LedgerOffset = new LedgerOffset().withBoundary(LedgerOffset.LedgerBoundary.LEDGER_BEGIN), endOffset: Option[LedgerOffset] = None, verbose: Boolean = true, timeout: NonNegativeDuration = timeouts.ledgerCommand): Seq[TransactionTree]
    Annotations
    @Summary(s = "Get transaction trees", flag = FeatureFlag.Testing) @Description(s = """This function connects to the transaction tree stream for the given parties and collects transaction trees
    |until either `completeAfter` transaction trees have been received or `timeout` has elapsed.
    |The returned transaction trees can be filtered to be between the given offsets (default: no filtering).
    |If the participant has been pruned via `pruning.prune` and if `beginOffset` is lower than the pruning offset,
    |this command fails with a `NOT_FOUND` error."""    )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped