Skip to main content

TxBuilderFinalConfig

export interface TxBuilderFinalConfig {
  allowDirtyChangeOutput?: boolean
  babelFeeAgent?: BabelFeeAgentOptions
  beforeValidate?: (tx: Tx) => any
  bodyEncodingConfig?: TxBodyEncodingConfig
  changeAddress: ShelleyAddressLike | Promise<ShelleyAddressLike>
  changeOutput?: TxOutput
  logOptions?: UplcLogger
  maxAssetsPerChangeOutput?: number
  modifyExBudget?: ExBudgetModifier
  networkParams?: NetworkParams | Promise<NetworkParams>
  spareUtxos?: TxInput[] | Promise<TxInput[]>
  throwBuildPhaseScriptErrors?: boolean
  witnessesEncodingConfig?: TxWitnessesEncodingConfig
}

Properties​

allowDirtyChangeOutput​

allowDirtyChangeOutput?: boolean
Defaults to false

babelFeeAgent​

babelFeeAgent?: BabelFeeAgentOptions
Optional babel fee settings, using additional UTxOs containing pure lovelace to balance a transaction and pay for fees and min-deposit. The primary tx building agent pays the difference using another asset class at a predetermined price.

beforeValidate​

beforeValidate?: (tx: Tx) => any

bodyEncodingConfig​

bodyEncodingConfig?: TxBodyEncodingConfig
Optional encoding config for TxBody

changeAddress​

changeAddress: ShelleyAddressLike | Promise<ShelleyAddressLike>

changeOutput​

changeOutput?: TxOutput
Optional changeOutput for any remaining lovelace during balancing. Specifying this avoids the creation of an additional TxOutput only for the change.

If the explicit changeOutput was already previously as a regular output, it isn't added again. If the explicit changeOutput wasn't previously added, it is added as a regular output.

logOptions​

logOptions?: UplcLogger

maxAssetsPerChangeOutput​

maxAssetsPerChangeOutput?: number
Defaults to the largest number of assets in one of the inputs

modifyExBudget​

modifyExBudget?: ExBudgetModifier
Increasing the execution budget of the redeemers to compensate for budget calculation errors made by the uplc library, or network parameter inconsistencies

networkParams​

networkParams?: NetworkParams | Promise<NetworkParams>

spareUtxos​

spareUtxos?: TxInput[] | Promise<TxInput[]>

throwBuildPhaseScriptErrors​

throwBuildPhaseScriptErrors?: boolean

witnessesEncodingConfig​

witnessesEncodingConfig?: TxWitnessesEncodingConfig
Optional encoding confg for TxWitnesses