Class Reservation

Single-use handle for reserved pre-trade state.

lock() and accountAdjustments() may be read while the reservation is live. commit() and rollback() each consume the handle; calling either a second time (or after the other) throws LifecycleError.

Methods

[dispose] accountAdjustments accountBlock commit free lock rollback

Methods

[dispose]

  • [dispose](): void

  • Returns void

accountAdjustments

  • accountAdjustments(): AccountAdjustmentOutcome[]

  • Returns the account adjustments produced by this reservation.

    Errors

    Throws LifecycleError when the reservation has been finalized.

    Returns AccountAdjustmentOutcome[]

accountBlock

  • accountBlock(): undefined | AccountBlock

  • Returns the winning account block produced by this reservation's pipeline, or undefined when no account-scoped reject was produced.

    Errors

    Throws LifecycleError when the reservation has been finalized.

    Returns undefined | AccountBlock

commit

  • commit(): void

  • Commits the reserved state.

    Errors

    Throws LifecycleError when the reservation has already been finalized.

    Returns void

free

  • free(): void

  • Returns void

lock

  • lock(): Lock

  • Returns the lock payload accumulated for this reservation.

    Errors

    Throws LifecycleError when the reservation has been finalized.

    Returns Lock

rollback

  • rollback(): void

  • Rolls back the reserved state.

    Errors

    Throws LifecycleError when the reservation has already been finalized.

    Returns void

Settings

Member Visibility

On This Page

Methods