@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

    Class Session

    Manages the unrolling process of a virtual output back to the Bitcoin blockchain.

    The Session class implements an async iterator that processes the unrolling steps:

    1. WAIT: Waits for a transaction to be confirmed onchain (if it's in mempool)
    2. UNROLL: Broadcasts the next transaction in the chain to the blockchain
    3. DONE: Indicates the unrolling process is complete

    The unrolling process works by traversing the transaction chain from the root (most recent) to the leaf (oldest), broadcasting each transaction that isn't already onchain.

    const session = await Unroll.Session.create(vtxoOutpoint, bumper, explorer, indexer);

    // iterate over the steps
    for await (const doneStep of session) {
      switch (doneStep.type) {
        case Unroll.StepType.WAIT:
          console.log(`Transaction ${doneStep.txid} confirmed`);
          break;
        case Unroll.StepType.UNROLL:
          console.log(`Broadcasting transaction ${doneStep.tx.id}`);
          break;
        case Unroll.StepType.DONE:
          console.log(`Unrolling complete for virtual output ${doneStep.vtxoTxid}`);
          break;
      }
    }

    Implements

    Index

    Constructors

    constructor

    Properties

    bumper explorer indexer onExitObserved? toUnroll virtualTxRepository?

    Methods

    [asyncIterator] next create

    Constructors

    Properties

    bumper: AnchorBumper
    explorer: OnchainProvider
    indexer: IndexerProvider
    onExitObserved?: OnExitObserved

    Fired once the chain is fully onchain (StepType.DONE), so a wallet repository can be prompted to re-read the outpoint — delta sync never would, filtering as it does on creation time. Fired ONCE, so an observer that reads a lagging indexer gets no second chance; see exitObserverFor. Best-effort — a rejection never reaches the exit. Prefer sessionFor, which wires it from the wallet.

    toUnroll: Outpoint & { chain: ChainTx[] }
    virtualTxRepository?: VirtualTxRepository

    Optional virtual-tx repository. When provided, each step's raw tx is read from the repo first and fetched from the indexer on a miss, then cached best-effort for later exits. Omitted ⇒ exact previous behaviour (indexer only).

    Methods

    • Iterate over the steps to be executed and execute them

      Returns AsyncIterator<Step>

      An async iterator over the executed steps

    • Get the next step to be executed

      Returns Promise<Step & { do: () => Promise<void> }>

      The next step to be executed + the function to execute it

      do() is the step, not a formality: every effect lives there, and at StepType.DONE that includes firing onExitObserved. A caller driving next() by hand must always await it — the async iterator below does. Reading type and skipping do() leaves the exit unobserved, and on the other step kinds unbroadcast.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods