Class Transaction

Hierarchy

Impl<TransactionLike, Transaction, this>
- Transaction

Constructors

constructor

new Transaction(version, cellDeps, headerDeps, inputs, outputs, outputsData, witnesses): Transaction
Creates an instance of Transaction.
Parameters
- version: bigint
  The version of the transaction.
- cellDeps: CellDep[]
  The cell dependencies of the transaction.
- headerDeps: `0x${string}`[]
  The header dependencies of the transaction.
- inputs: CellInput[]
  The inputs of the transaction.
- outputs: CellOutput[]
  The outputs of the transaction.
- outputsData: `0x${string}`[]
  The data associated with the outputs.
- witnesses: `0x${string}`[]
  The witnesses of the transaction.
Returns Transaction
Overrides mol.Entity.Base< TransactionLike, Transaction >().constructor
- Defined in ckb/transaction.ts:752

Properties

version

version: bigint

The version of the transaction.

cellDeps

cellDeps: CellDep[]

The cell dependencies of the transaction.

headerDeps

headerDeps: `0x${string}`[]

The header dependencies of the transaction.

inputs

inputs: CellInput[]

The inputs of the transaction.

outputs

outputs: CellOutput[]

The outputs of the transaction.

outputsData

outputsData: `0x${string}`[]

The data associated with the outputs.

witnesses

witnesses: `0x${string}`[]

The witnesses of the transaction.

`Static` `Optional`byteLength

byteLength?: number

The bytes length of the entity, if it is fixed, otherwise undefined

Static

Methods

`Static`default

default(): Transaction
Creates a default Transaction instance with empty fields.

Returns Transaction
A default Transaction instance.
Example
```
const defaultTx = Transaction.default();
```
- Defined in ckb/transaction.ts:774

copy

copy(txLike): void
Copy every properties from another transaction.
Parameters
- txLike: TransactionLike
Returns void
Example
```
this.copy(Transaction.default());
```
- Defined in ckb/transaction.ts:786

`Static`from

from(tx): Transaction
Creates a Transaction instance from a TransactionLike object.
Parameters
- tx: TransactionLike
  A TransactionLike object or an instance of Transaction.
Returns Transaction
A Transaction instance.
Example
```
const transaction = Transaction.from({
  version: 0,
  cellDeps: [],
  headerDeps: [],
  inputs: [],
  outputs: [],
  outputsData: [],
  witnesses: []
});
```
Overrides mol.Entity.Base< TransactionLike, Transaction >().from
- Defined in ckb/transaction.ts:817

`Static`fromLumosSkeleton

fromLumosSkeleton(skeleton): Transaction
Creates a Transaction instance from a Lumos skeleton.
Parameters
- skeleton: LumosTransactionSkeletonType
  The Lumos transaction skeleton.
Returns Transaction
A Transaction instance.
Throws
Will throw an error if an input's outPoint is missing.

Example
```
const transaction = Transaction.fromLumosSkeleton(skeleton);
```
- Defined in ckb/transaction.ts:869

stringify

stringify(): string
Returns string
- Defined in ckb/transaction.ts:894

rawToBytes

rawToBytes(): Uint8Array
Converts the raw transaction data to bytes.

Returns Uint8Array
A Uint8Array containing the raw transaction bytes.
Example
```
const rawTxBytes = transaction.rawToBytes();
```
- Defined in ckb/transaction.ts:914

hash

hash(): `0x${string}`
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.

Returns `0x${string}`
The hash of the transaction.
Example
```
const txHash = transaction.hash();
```
Overrides mol.Entity.Base< TransactionLike, Transaction >().hash
- Defined in ckb/transaction.ts:929

hashFull

hashFull(): `0x${string}`
Calculates the hash of the transaction with witnesses.

Returns `0x${string}`
The hash of the transaction with witnesses.
Example
```
const txFullHash = transaction.hashFull();
```
- Defined in ckb/transaction.ts:943

`Static`hashWitnessToHasher

hashWitnessToHasher(witness, hasher): void
Hashes a witness and updates the hasher.
Parameters
- witness: BytesLike
  The witness to hash.
- hasher: Hasher
  The hasher instance to update.
Returns void
Example
```
Transaction.hashWitnessToHasher("0x...", hasher);
```
- Defined in ckb/transaction.ts:959

getSignHashInfo

getSignHashInfo(scriptLike, client, hasher?): Promise<undefined | {
message: `0x${string}`;
position: number;
}>
Computes the signing hash information for a given script.
Parameters
- scriptLike: ScriptLike
  The script associated with the transaction, represented as a ScriptLike object.
- client: Client
  The client for complete extra infos in the transaction.
- hasher: Hasher = ...
Returns Promise<undefined | {
message: `0x${string}`;
position: number;
}>
A promise that resolves to an object containing the signing message and the witness position, or undefined if no matching input is found.
Example
```
const signHashInfo = await tx.getSignHashInfo(scriptLike, client);
if (signHashInfo) {
  console.log(signHashInfo.message); // Outputs the signing message
  console.log(signHashInfo.position); // Outputs the witness position
}
```
- Defined in ckb/transaction.ts:982

findInputIndexByLockId

findInputIndexByLockId(scriptIdLike, client): Promise<undefined | number>
Find the first occurrence of a input with the specified lock id
Parameters
- scriptIdLike: Pick<ScriptLike, "codeHash" | "hashType">
  The script associated with the transaction, represented as a ScriptLike object without args.
- client: Client
  The client for complete extra infos in the transaction.
Returns Promise<undefined | number>
A promise that resolves to the found index
Example
```
const index = await tx.findInputIndexByLockId(scriptIdLike, client);
```
- Defined in ckb/transaction.ts:1038

findInputIndexByLock

findInputIndexByLock(scriptLike, client): Promise<undefined | number>
Find the first occurrence of a input with the specified lock
Parameters
- scriptLike: ScriptLike
  The script associated with the transaction, represented as a ScriptLike object.
- client: Client
  The client for complete extra infos in the transaction.
Returns Promise<undefined | number>
A promise that resolves to the prepared transaction
Example
```
const index = await tx.findInputIndexByLock(scriptLike, client);
```
- Defined in ckb/transaction.ts:1072

findLastInputIndexByLock

findLastInputIndexByLock(scriptLike, client): Promise<undefined | number>
Find the last occurrence of a input with the specified lock
Parameters
- scriptLike: ScriptLike
  The script associated with the transaction, represented as a ScriptLike object.
- client: Client
  The client for complete extra infos in the transaction.
Returns Promise<undefined | number>
A promise that resolves to the prepared transaction
Example
```
const index = await tx.findLastInputIndexByLock(scriptLike, client);
```
- Defined in ckb/transaction.ts:1103

addCellDeps

addCellDeps(...cellDepLikes): void
Add cell deps if they are not existed
Parameters
- Rest...cellDepLikes: (CellDepLike | CellDepLike[])[]
  The cell deps to add
Returns void
Example
```
tx.addCellDeps(cellDep);
```
- Defined in ckb/transaction.ts:1132

addCellDepsAtStart

addCellDepsAtStart(...cellDepLikes): void
Add cell deps at the start if they are not existed
Parameters
- Rest...cellDepLikes: (CellDepLike | CellDepLike[])[]
  The cell deps to add
Returns void
Example
```
tx.addCellDepsAtBegin(cellDep);
```
- Defined in ckb/transaction.ts:1153

addCellDepInfos

addCellDepInfos(client, ...cellDepInfoLikes): Promise<void>
Add cell dep from infos if they are not existed
Parameters
- client: Client
  A client for searching cell deps
- Rest...cellDepInfoLikes: (CellDepInfoLike | CellDepInfoLike[])[]
  The cell dep infos to add
Returns Promise<void>
Example
```
tx.addCellDepInfos(client, cellDepInfos);
```
- Defined in ckb/transaction.ts:1175

addCellDepsOfKnownScripts

addCellDepsOfKnownScripts(client, ...scripts): Promise<void>
Add cell deps from known script
Parameters
- client: Client
  The client for searching known script and cell deps
- Rest...scripts: (KnownScript | KnownScript[])[]
  The known scripts to add
Returns Promise<void>
Example
```
tx.addCellDepsOfKnownScripts(client, KnownScript.OmniLock);
```
- Defined in ckb/transaction.ts:1193

setOutputDataAt

setOutputDataAt(index, witness): void
Set output data at index.
Parameters
- index: number
  The index of the output data.
- witness: BytesLike
  The data to set.
Returns void
Example
```
await tx.setOutputDataAt(0, "0x00");
```
- Defined in ckb/transaction.ts:1220

addOutput

addOutput(outputLike, outputData?): void
Add output
Parameters
- outputLike: Omit<CellOutputLike, "capacity"> & Partial<Pick<CellOutputLike, "capacity">>
  The cell output to add
- outputData: BytesLike = "0x"
  optional output data
Returns void
Example
```
await tx.addOutput(cellOutput, "0xabcd");
```
- Defined in ckb/transaction.ts:1244

getWitnessArgsAt

getWitnessArgsAt(index): undefined | WitnessArgs
Get witness at index as WitnessArgs
Parameters
- index: number
  The index of the witness.
Returns undefined | WitnessArgs
The witness parsed as WitnessArgs.
Example
```
const witnessArgs = await tx.getWitnessArgsAt(0);
```
- Defined in ckb/transaction.ts:1273

setWitnessArgsAt

setWitnessArgsAt(index, witness): void
Set witness at index by WitnessArgs
Parameters
- index: number
  The index of the witness.
- witness: WitnessArgs
  The WitnessArgs to set.
Returns void
Example
```
await tx.setWitnessArgsAt(0, witnessArgs);
```
- Defined in ckb/transaction.ts:1291

prepareSighashAllWitness

prepareSighashAllWitness(scriptLike, lockLen, client): Promise<void>
Prepare dummy witness for sighash all method
Parameters
- scriptLike: ScriptLike
  The script associated with the transaction, represented as a ScriptLike object.
- lockLen: number
  The length of dummy lock bytes.
- client: Client
  The client for complete extra infos in the transaction.
Returns Promise<void>
A promise that resolves to the prepared transaction
Example
```
await tx.prepareSighashAllWitness(scriptLike, 85, client);
```
- Defined in ckb/transaction.ts:1317

getInputsCapacity

getInputsCapacity(client): Promise<bigint>
Parameters
- client: Client
Returns Promise<bigint>
- Defined in ckb/transaction.ts:1332

getOutputsCapacity

getOutputsCapacity(): bigint
Returns bigint
- Defined in ckb/transaction.ts:1346

getInputsUdtBalance

getInputsUdtBalance(client, type): Promise<bigint>
Parameters
- client: Client
- type: ScriptLike
Returns Promise<bigint>
- Defined in ckb/transaction.ts:1353

getOutputsUdtBalance

getOutputsUdtBalance(type): bigint
Parameters
- type: ScriptLike
Returns bigint
- Defined in ckb/transaction.ts:1371

completeInputs

completeInputs<T>(from, filter, accumulator, init): Promise<{
addedCount: number;
accumulated?: T;
}>
Type Parameters
- T
Parameters
- from: ccc.Signer
- filter: ClientCollectableSearchKeyFilterLike
- accumulator: ((acc: T, v: Cell, i: number, array: Cell[]) => undefined | T | Promise<undefined | T>)
  - - (acc, v, i, array): undefined | T | Promise<undefined | T>
    - Parameters
      acc: T
      v: Cell
      i: number
      array: Cell[]
      Returns undefined | T | Promise<undefined | T>
- init: T
Returns Promise<{
addedCount: number;
accumulated?: T;
}>
- Defined in ckb/transaction.ts:1381

completeInputsByCapacity

completeInputsByCapacity(from, capacityTweak?, filter?): Promise<number>
Parameters
- from: ccc.Signer
- OptionalcapacityTweak: NumLike
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<number>
- Defined in ckb/transaction.ts:1439

completeInputsAll

completeInputsAll(from, filter?): Promise<number>
Parameters
- from: ccc.Signer
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<number>
- Defined in ckb/transaction.ts:1473

completeInputsByUdt

completeInputsByUdt(from, type): Promise<number>
Parameters
- from: ccc.Signer
- type: ScriptLike
Returns Promise<number>
- Defined in ckb/transaction.ts:1490

estimateFee

estimateFee(feeRate): bigint
Parameters
- feeRate: NumLike
Returns bigint
- Defined in ckb/transaction.ts:1520

completeFee

completeFee(from, change, expectedFeeRate?, filter?): Promise<[number, boolean]>
Parameters
- from: ccc.Signer
- change: ((tx: Transaction, capacity: bigint) => NumLike | Promise<NumLike>)
  - - (tx, capacity): NumLike | Promise<NumLike>
    - Parameters
      tx: Transaction
      capacity: bigint
      Returns NumLike | Promise<NumLike>
- OptionalexpectedFeeRate: NumLike
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<[number, boolean]>
- Defined in ckb/transaction.ts:1525

completeFeeChangeToLock

completeFeeChangeToLock(from, change, feeRate?, filter?): Promise<[number, boolean]>
Parameters
- from: ccc.Signer
- change: ScriptLike
- OptionalfeeRate: NumLike
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<[number, boolean]>
- Defined in ckb/transaction.ts:1605

completeFeeBy

completeFeeBy(from, feeRate?, filter?): Promise<[number, boolean]>
Parameters
- from: ccc.Signer
- OptionalfeeRate: NumLike
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<[number, boolean]>
- Defined in ckb/transaction.ts:1630

completeFeeChangeToOutput

completeFeeChangeToOutput(from, index, feeRate?, filter?): Promise<[number, boolean]>
Parameters
- from: ccc.Signer
- index: NumLike
- OptionalfeeRate: NumLike
- Optionalfilter: ClientCollectableSearchKeyFilterLike
Returns Promise<[number, boolean]>
- Defined in ckb/transaction.ts:1640

`Static`encode

encode(_): Uint8Array
Encode the entity into bytes
Parameters
- _: TransactionLike
  The entity to encode
Returns Uint8Array
The encoded bytes

Static
Throws
Will throw an error if the entity is not serializable
Inherited from mol.Entity.Base< TransactionLike, Transaction >().encode
- Defined in molecule/entity.ts:33

`Static`decode

decode(_): Transaction
Decode the entity from bytes
Parameters
- _: BytesLike
  The bytes to decode
Returns Transaction
The decoded entity

Static
Throws
Will throw an error if the entity is not serializable
Inherited from mol.Entity.Base< TransactionLike, Transaction >().decode
- Defined in molecule/entity.ts:46

`Static`fromBytes

fromBytes(_bytes): Transaction
Create an entity from bytes
Parameters
- _bytes: BytesLike
Returns Transaction
The created entity

Static
Throws
Will throw an error if the entity is not serializable
Inherited from mol.Entity.Base< TransactionLike, Transaction >().fromBytes
- Defined in molecule/entity.ts:60

toBytes

toBytes(): Uint8Array
Convert the entity to bytes

Returns Uint8Array
The bytes representation of the entity
Inherited from mol.Entity.Base< TransactionLike, Transaction >().toBytes
- Defined in molecule/entity.ts:83

clone

clone(): Transaction
Create a clone of the entity

Returns Transaction
A clone of the entity
Inherited from mol.Entity.Base< TransactionLike, Transaction >().clone
- Defined in molecule/entity.ts:94

eq

eq(other): boolean
Check if the entity is equal to another entity
Parameters
- other: TransactionLike
  The other entity to compare with
Returns boolean
True if the entities are equal, false otherwise
Inherited from mol.Entity.Base< TransactionLike, Transaction >().eq
- Defined in molecule/entity.ts:106

Class Transaction

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Transaction

Properties

version

cellDeps

headerDeps

inputs

outputs

outputsData

witnesses

Static OptionalbyteLength

Static

Methods

Staticdefault

Returns Transaction

Example

copy

Parameters

Returns void

Example

Staticfrom

Parameters

Returns Transaction

Example

StaticfromLumosSkeleton

Parameters

Returns Transaction

Throws

Example

stringify

Returns string

rawToBytes

Returns Uint8Array

Example

hash

Returns `0x${string}`

Example

hashFull

Returns `0x${string}`

Example

StatichashWitnessToHasher

Parameters

Returns void

Example

getSignHashInfo

Parameters

Returns Promise<undefined | { message: `0x${string}`; position: number; }>

Example

findInputIndexByLockId

Parameters

Returns Promise<undefined | number>

Example

findInputIndexByLock

Parameters

Returns Promise<undefined | number>

Example

findLastInputIndexByLock

Parameters

Returns Promise<undefined | number>

Example

addCellDeps

Parameters

Returns void

Example

addCellDepsAtStart

Parameters

Returns void

Example

addCellDepInfos

Parameters

Returns Promise<void>

Example

`Static` `Optional`byteLength

`Static`default

`Static`from

`Static`fromLumosSkeleton

`Static`hashWitnessToHasher

Returns Promise<undefined | {
message: `0x${string}`;
position: number;
}>

Returns Promise<{
addedCount: number;
accumulated?: T;
}>

`Static`encode