SendAll overview

SendAll operation - sends all wallet assets to a recipient address.

This operation marks the transaction as a "send all" transaction, which triggers special handling in the build phases:

1. All wallet UTxOs are collected as inputs
2. A single output is created with all assets minus fee to the recipient

Note: Internally the output is stored in changeOutputs (the standard mechanism for phase-created outputs), but semantically it represents the full transfer to the recipient - not traditional "change" that returns to the sender.

Added in v2.0.0

Table of contents

• programs
  • createSendAllProgram
• types
  • SendAllTarget (type alias)

programs

createSendAllProgram

Creates a ProgramStep for sendAll operation.

This sets up the sendAll mode in the builder state, which is processed during the build phases. The actual UTxO collection and output creation happens during the build process when wallet UTxOs are available.

Signature

export declare const createSendAllProgram: (params: SendAllParams) => Effect.Effect<void, never, TxContext>

Added in v2.0.0

types

SendAllTarget (type alias)

Type representing the sendAll target address in builder state.

Signature

export type SendAllTarget = CoreAddress.Address

Added in v2.0.0