An Iterable<CellAny> that yields each output cell of the transaction.
Creates an instance of Transaction.
The version of the transaction.
The cell dependencies of the transaction.
The header dependencies of the transaction.
The inputs of the transaction.
The outputs of the transaction.
The data associated with the outputs.
The witnesses of the transaction.
The version of the transaction.
The cell dependencies of the transaction.
The header dependencies of the transaction.
The inputs of the transaction.
The outputs of the transaction.
The data associated with the outputs.
The witnesses of the transaction.
StaticdefaultCreates a default Transaction instance with empty fields.
A default Transaction instance.
Copy every properties from another transaction. This method replaces all properties of the current transaction with those from the provided transaction.
The transaction-like object to copy properties from.
Creates a deep copy of the transaction. This method creates a new Transaction instance with all nested objects cloned, ensuring that modifications to the cloned transaction do not affect the original.
A new Transaction instance that is a deep copy of the current transaction.
const originalTx = Transaction.from({
version: 0,
inputs: [{ previousOutput: { txHash: "0x...", index: 0 } }],
outputs: [{ capacity: 1000n, lock: lockScript }],
outputsData: ["0x"],
witnesses: ["0x"]
});
const clonedTx = originalTx.clone();
// Modifications to clonedTx won't affect originalTx
clonedTx.addOutput({ capacity: 2000n, lock: anotherLockScript });
console.log(originalTx.outputs.length); // Still 1
console.log(clonedTx.outputs.length); // Now 2
The clone operation performs deep copying for:
The following are shallow copied (references to immutable data):
StaticfromCreates a Transaction instance from a TransactionLike object.
A TransactionLike object or an instance of Transaction.
A Transaction instance.
StaticfromCreates a Transaction instance from a Lumos skeleton.
The Lumos transaction skeleton.
A Transaction instance.
Converts the raw transaction data to bytes.
A Uint8Array containing the raw transaction bytes.
Calculates the hash of the transaction without witnesses. This is the transaction hash in the usual sense. To calculate the hash of the whole transaction including the witnesses, use transaction.hashFull() instead.
The hash of the transaction.
StatichashComputes the signing hash information for a given script.
The script associated with the transaction, represented as a ScriptLike object.
The client for complete extra infos in the transaction.
A promise that resolves to an object containing the signing message and the witness position, or undefined if no matching input is found.
Find the first occurrence of a input with the specified lock id
The script associated with the transaction, represented as a ScriptLike object without args.
The client for complete extra infos in the transaction.
A promise that resolves to the found index
Find the first occurrence of a input with the specified lock
The script associated with the transaction, represented as a ScriptLike object.
The client for complete extra infos in the transaction.
A promise that resolves to the found index, or undefined if no matching input is found.
Find the last occurrence of a input with the specified lock
The script associated with the transaction, represented as a ScriptLike object.
The client for complete extra infos in the transaction.
A promise that resolves to the found index, or undefined if no matching input is found.
Add cell deps if they are not existed
The cell deps to add
Add cell deps at the start if they are not existed
The cell deps to add
Add cell dep from infos if they are not existed
A client for searching cell deps
The cell dep infos to add
Add cell deps from known script
The client for searching known script and cell deps
The known scripts to add
Set output data at index.
The index of the output data.
The data to set.
Adds an output to the transaction.
This method supports two overloads for adding an output:
CellAnyLike object, which encapsulates both cellOutput and outputData.CellOutputLike object and an optional outputData.The new number of outputs in the transaction.
// 1. Add an output using a CellAnyLike object
const newLength1 = tx.addOutput({
cellOutput: { lock: recipientLock }, // capacity is calculated automatically
outputData: "0x1234",
});
// 2. Add an output using CellOutputLike and data separately
const newLength2 = tx.addOutput({ lock: recipientLock }, "0xabcd");
Adds an output to the transaction.
This method supports two overloads for adding an output:
CellAnyLike object, which encapsulates both cellOutput and outputData.CellOutputLike object and an optional outputData.OptionaloutputDataLike: null | BytesLikeOptional data for the cell output. Defaults to "0x" if not provided in the first argument.
The new number of outputs in the transaction.
// 1. Add an output using a CellAnyLike object
const newLength1 = tx.addOutput({
cellOutput: { lock: recipientLock }, // capacity is calculated automatically
outputData: "0x1234",
});
// 2. Add an output using CellOutputLike and data separately
const newLength2 = tx.addOutput({ lock: recipientLock }, "0xabcd");
Get witness at index as WitnessArgs
The index of the witness.
The witness parsed as WitnessArgs.
Set witness at index by WitnessArgs
The index of the witness.
The WitnessArgs to set.
Set witness at index
The index of the witness.
The witness to set.
Prepare dummy witness for sighash all method
The script associated with the transaction, represented as a ScriptLike object.
The length of dummy lock bytes.
The client for complete extra infos in the transaction.
A promise that resolves to the prepared transaction
OptionalcapacityTweak: NumLikeOptionalfilter: ClientCollectableSearchKeyFilterLikeOptionalfilter: ClientCollectableSearchKeyFilterLikeComplete inputs by UDT balance
This method succeeds only if enough balance is collected.
It will try to collect at least two inputs, even when the first input already contains enough balance, to avoid extra occupation fees introduced by the change cell. An edge case: If the first cell has the same amount as the output, a new cell is not needed.
The signer to complete the inputs.
The type script of the UDT.
OptionalbalanceTweak: NumLikeThe tweak of the balance.
A promise that resolves to the number of inputs added.
Optionalfilter: ClientCollectableSearchKeyFilterLikeOptionalfilter: ClientCollectableSearchKeyFilterLikeCompletes the transaction fee by adding inputs and handling change outputs. This method automatically calculates the required fee based on the transaction size and fee rate, adds necessary inputs to cover the fee, and handles change outputs through the provided change function.
The signer to complete inputs from and prepare the transaction.
A function that handles change capacity. It receives the transaction and excess capacity, and should return the additional capacity needed (0 if change is handled successfully, positive number if more capacity is needed for change cell creation).
OptionalexpectedFeeRate: NumLikeThe expected fee rate in shannons per 1000 bytes. If not provided, it will be fetched from the client.
Optionalfilter: ClientCollectableSearchKeyFilterLikeOptional filter for selecting cells when adding inputs.
Optionaloptions: { feeRateBlockRange?: NumLike; maxFeeRate?: NumLike; shouldAddInputs?: boolean }Optional configuration object.
A promise that resolves to a tuple containing: - The number of inputs added during the process - A boolean indicating whether change outputs were created (true) or fee was paid without change (false)
const [addedInputs, hasChange] = await tx.completeFee(
signer,
(tx, capacity) => {
if (capacity >= 61_00000000n) { // Minimum for a change cell
tx.addOutput({ capacity, lock: changeScript });
return 0;
}
return 61_00000000n; // Need more capacity for change cell
},
1000n // 1000 shannons per 1000 bytes
);
Completes the transaction fee by adding inputs and creating a change output with the specified lock script. This is a convenience method that automatically creates a change cell with the provided lock script when there's excess capacity after paying the transaction fee.
The signer to complete inputs from and prepare the transaction.
The lock script for the change output cell.
OptionalfeeRate: NumLikeOptional fee rate in shannons per 1000 bytes. If not provided, it will be fetched from the client.
Optionalfilter: ClientCollectableSearchKeyFilterLikeOptional filter for selecting cells when adding inputs.
Optionaloptions: { feeRateBlockRange?: NumLike; maxFeeRate?: NumLike; shouldAddInputs?: boolean }Optional configuration object.
A promise that resolves to a tuple containing: - The number of inputs added during the process - A boolean indicating whether change outputs were created (true) or fee was paid without change (false)
Completes the transaction fee using the signer's recommended address for change. This is a convenience method that automatically uses the signer's recommended address as the change destination, making it easier to complete transactions without manually specifying a change address.
The signer to complete inputs from and prepare the transaction.
OptionalfeeRate: NumLikeOptional fee rate in shannons per 1000 bytes. If not provided, it will be fetched from the client.
Optionalfilter: ClientCollectableSearchKeyFilterLikeOptional filter for selecting cells when adding inputs.
Optionaloptions: { feeRateBlockRange?: NumLike; maxFeeRate?: NumLike; shouldAddInputs?: boolean }Optional configuration object.
A promise that resolves to a tuple containing: - The number of inputs added during the process - A boolean indicating whether change outputs were created (true) or fee was paid without change (false)
Completes the transaction fee by adding excess capacity to an existing output. Instead of creating a new change output, this method adds any excess capacity to the specified existing output in the transaction.
The signer to complete inputs from and prepare the transaction.
The index of the existing output to add excess capacity to.
OptionalfeeRate: NumLikeOptional fee rate in shannons per 1000 bytes. If not provided, it will be fetched from the client.
Optionalfilter: ClientCollectableSearchKeyFilterLikeOptional filter for selecting cells when adding inputs.
Optionaloptions: { feeRateBlockRange?: NumLike; maxFeeRate?: NumLike; shouldAddInputs?: boolean }Optional configuration object.
A promise that resolves to a tuple containing: - The number of inputs added during the process - A boolean indicating whether change was applied (true) or fee was paid without change (false)
Static OptionalbyteThe bytes length of the entity, if it is fixed, otherwise undefined
StaticencodeEncode the entity into bytes
The entity to encode
The encoded bytes
StaticdecodeDecode the entity from bytes
The bytes to decode
The decoded entity
StaticfromCheck if the entity is equal to another entity
The other entity to compare with
True if the entities are equal, false otherwise
Provides an iterable over the transaction's output cells.
This getter is a convenient way to iterate through all the output cells (
CellAny) of the transaction, combining theoutputsandoutputsDataarrays. It can be used withfor...ofloops or other iterable-consuming patterns.