Class GenericTxBuilder

Hierarchy

GenericTxBuilder

Implements

TxBuilder

Constructors

constructor

new GenericTxBuilder(dependencies: TxBuilderDependencies): GenericTxBuilder
Parameters
- dependencies: TxBuilderDependencies
Returns GenericTxBuilder
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:12

Properties

`Private` #private

#private: any

`Optional` partialAuxiliaryData

partialAuxiliaryData?: AuxiliaryData

`Optional` partialExtraSigners

partialExtraSigners?: TransactionSigner[]

`Optional` partialSigningOptions

partialSigningOptions?: SignTransactionOptions

partialTxBody

partialTxBody: Partial<TxBody>

Methods

addDatum

addDatum(datum: PlutusData): TxBuilder
Parameters
- datum: PlutusData
Returns TxBuilder
Implementation of TxBuilder.addDatum
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:16

addInput

addInput(input: Utxo | TxIn, scriptUnlockProps?: ScriptUnlockProps): TxBuilder
Parameters
- input: Utxo | TxIn
- Optional scriptUnlockProps: ScriptUnlockProps
Returns TxBuilder
Implementation of TxBuilder.addInput
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:15

addOutput

addOutput(txOut: OutputBuilderTxOut): TxBuilder
Parameters
- txOut: OutputBuilderTxOut
Returns TxBuilder
Implementation of TxBuilder.addOutput
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:17

addReferenceInput

addReferenceInput(input: Utxo | TxIn): TxBuilder
Parameters
- input: Utxo | TxIn
Returns TxBuilder
Implementation of TxBuilder.addReferenceInput
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:14

build

build(): UnwitnessedTx
Returns UnwitnessedTx
Implementation of TxBuilder.build
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:26

buildOutput

buildOutput(txOut?: Partial<Pick<TxOut, "address" | "datumHash" | "datum" | "scriptReference"> & {
handle?: string;
value: Partial<Value>;
}>): TxOutputBuilder
Parameters
- Optional txOut: Partial<Pick<TxOut, "address" | "datumHash" | "datum" | "scriptReference"> & {
  handle?: string;
  value: Partial<Value>;
  }>
Returns TxOutputBuilder
Implementation of TxBuilder.buildOutput
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:19

customize

customize(cb: CustomizeCb): TxBuilder
Parameters
- cb: CustomizeCb
Returns TxBuilder
Implementation of TxBuilder.customize
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:25

delegateFirstStakeCredential

delegateFirstStakeCredential(poolId: null | PoolId): TxBuilder
Parameters
- poolId: null | PoolId
Returns TxBuilder
Implementation of TxBuilder.delegateFirstStakeCredential
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:20

delegatePortfolio

delegatePortfolio(portfolio: null | Cip17DelegationPortfolio): TxBuilder
Parameters
- portfolio: null | Cip17DelegationPortfolio
Returns TxBuilder
Implementation of TxBuilder.delegatePortfolio
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:21

extraSigners

extraSigners(signers: TransactionSigner[]): TxBuilder
Parameters
- signers: TransactionSigner[]
Returns TxBuilder
Implementation of TxBuilder.extraSigners
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:23

inspect

inspect(): Promise<PartialTx>
Returns Promise<PartialTx>
Implementation of TxBuilder.inspect
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:13

metadata

metadata(metadata: TxMetadata): TxBuilder
Parameters
- metadata: TxMetadata
Returns TxBuilder
Implementation of TxBuilder.metadata
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:22

removeOutput

removeOutput(txOut: OutputBuilderTxOut): TxBuilder
Parameters
- txOut: OutputBuilderTxOut
Returns TxBuilder
Implementation of TxBuilder.removeOutput
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:18

setValidityInterval

setValidityInterval(validityInterval: ValidityInterval): TxBuilder
Parameters
- validityInterval: ValidityInterval
Returns TxBuilder
Implementation of TxBuilder.setValidityInterval
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:27

signingOptions

signingOptions(options: SignTransactionOptions): TxBuilder
Parameters
- options: SignTransactionOptions
Returns TxBuilder
Implementation of TxBuilder.signingOptions
- Defined in packages/tx-construction/dist/cjs/tx-builder/TxBuilder.d.ts:24

Class GenericTxBuilder

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dependencies: TxBuilderDependencies

Returns GenericTxBuilder

Properties

Private #private

Optional partialAuxiliaryData

Optional partialExtraSigners

Optional partialSigningOptions

partialTxBody

Methods

addDatum

Parameters

datum: PlutusData

Returns TxBuilder

addInput

Parameters

input: Utxo | TxIn

Optional scriptUnlockProps: ScriptUnlockProps

Returns TxBuilder

addOutput

Parameters

txOut: OutputBuilderTxOut

Returns TxBuilder

addReferenceInput

Parameters

input: Utxo | TxIn

Returns TxBuilder

build

Returns UnwitnessedTx

buildOutput

Parameters

Optional txOut: Partial<Pick<TxOut, "address" | "datumHash" | "datum" | "scriptReference"> & { handle?: string; value: Partial<Value>; }>

Returns TxOutputBuilder

customize

Parameters

cb: CustomizeCb

Returns TxBuilder

delegateFirstStakeCredential

Parameters

poolId: null | PoolId

Returns TxBuilder

delegatePortfolio

Parameters

portfolio: null | Cip17DelegationPortfolio

Returns TxBuilder

extraSigners

Parameters

signers: TransactionSigner[]

Returns TxBuilder

inspect

Returns Promise<PartialTx>

metadata

Parameters

metadata: TxMetadata

Returns TxBuilder

removeOutput

Parameters

txOut: OutputBuilderTxOut

Returns TxBuilder

setValidityInterval

Parameters

validityInterval: ValidityInterval

Returns TxBuilder

signingOptions

Parameters

options: SignTransactionOptions

Returns TxBuilder

Settings

Member Visibility

Theme

`Private` #private

`Optional` partialAuxiliaryData

`Optional` partialExtraSigners

`Optional` partialSigningOptions

`Optional` scriptUnlockProps: ScriptUnlockProps

`Optional` txOut: Partial<Pick<TxOut, "address" | "datumHash" | "datum" | "scriptReference"> & {
handle?: string;
value: Partial<Value>;
}>