Class TransactionBuilder

packages/cashscript/src/TransactionBuilder.ts:75–633

 * transaction can be built (`build`), debugged (`debug`), or broadcast (`send`).
 */
export class TransactionBuilder {
  public provider: NetworkProvider;
  public inputs: UnlockableUtxo[] = [];
  public outputs: Output[] = [];

  public locktime: number = 0;
  public options: TransactionBuilderOptions;

  private changeLocks: Record<string, boolean> = {};

  /**
   * Create a new TransactionBuilder.
   *
   * @param options - Builder options, including the network provider and optional fee/burn limits.
   */
  constructor(
    options: TransactionBuilderOptions,
  ) {
    this.provider = options.provider;
    this.options = {
      allowImplicitFungibleTokenBurn: options.allowImplicitFungibleTokenBurn ?? false,
      ...options,
    };
  }

  /**
   * Add a single UTXO as an input to the transaction.
   *
   * @param utxo - The UTXO to spend.
   * @param unlocker - The unlocker to generate the unlocking bytecode for this input. Typically
   *   obtained from `contract.unlock.<functionName>(...args)` or `signatureTemplate.unlockP2PKH()`.
   * @param options - Optional per-input options such as a custom sequence number.
   * @returns This builder for chaining.
   * @throws If the UTXO is invalid.
   */
  addInput(utxo: Utxo, unlocker: Unlocker, options?: InputOptions): this {
    return this.addInputs([utxo], unlocker, options);
  }

  /**
   * Add multiple UTXOs to the transaction that all share the same unlocker.
   *
   * @param utxos - The UTXOs to spend.
   * @param unlocker - The shared unlocker used to unlock all provided UTXOs.
   * @param options - Optional per-input options applied to every added input.
   * @returns This builder for chaining.
   * @throws If any UTXO is invalid.
   */
  addInputs(utxos: Utxo[], unlocker: Unlocker, options?: InputOptions): this;

  /**
   * Add multiple UTXOs that each carry their own unlocker.
   *
   * @param utxos - UTXOs that have already been paired with their individual unlockers.
   * @returns This builder for chaining.
   * @throws If any UTXO is missing its unlocker.
   */
  addInputs(utxos: UnlockableUtxo[]): this;