Class Transaction

constructor

• new Transaction(version, cellDeps, headerDeps, inputs, outputs, outputsData, witnesses): ccc.Transaction

• Creates an instance of Transaction.

  Parameters

  • version: bigint

    The version of the transaction.
  • cellDeps: ccc.CellDep[]

    The cell dependencies of the transaction.
  • headerDeps: `0x${string}`[]

    The header dependencies of the transaction.
  • inputs: ccc.CellInput[]

    The inputs of the transaction.
  • outputs: ccc.CellOutput[]

    The outputs of the transaction.
  • outputsData: `0x${string}`[]

    The data associated with the outputs.
  • witnesses: `0x${string}`[]

    The witnesses of the transaction.

  Returns ccc.Transaction

version

cellDeps

headerDeps

inputs

outputs

outputsData

witnesses

Staticdefault

• default(): ccc.Transaction

• Creates a default Transaction instance with empty fields.

  Returns ccc.Transaction

  A default Transaction instance.

  Example

  const defaultTx = Transaction.default();
  Copy

copy

• copy(txLike): void

• Copy every properties from another transaction.

  Parameters

  • txLike: TransactionLike

  Returns void

  Example

  this.copy(Transaction.default());
  Copy

clone

• clone(): ccc.Transaction

• Clone a Transaction.

  Returns ccc.Transaction

  A cloned instance

  Example

  const tx1 = tx0.clone();
  Copy

Staticfrom

• from(tx): ccc.Transaction

• Creates a Transaction instance from a TransactionLike object.

  Parameters

  • tx: TransactionLike

    A TransactionLike object or an instance of Transaction.

  Returns ccc.Transaction

  A Transaction instance.

  Example

  const transaction = Transaction.from({
    version: 0,
    cellDeps: [],
    headerDeps: [],
    inputs: [],
    outputs: [],
    outputsData: [],
    witnesses: []
  });
  Copy

StaticfromLumosSkeleton

• fromLumosSkeleton(skeleton): ccc.Transaction

• Creates a Transaction instance from a Lumos skeleton.

  Parameters

  • skeleton: LumosTransactionSkeletonType

    The Lumos transaction skeleton.

  Returns ccc.Transaction

  A Transaction instance.

  Throws

  Will throw an error if an input's outPoint is missing.

  Example

  const transaction = Transaction.fromLumosSkeleton(skeleton);
  Copy

stringify

• stringify(): string

• Returns string

rawToBytes

• rawToBytes(): Uint8Array

• Converts the raw transaction data to bytes.

  Returns Uint8Array

  A Uint8Array containing the raw transaction bytes.

  Example

  const rawTxBytes = transaction.rawToBytes();
  Copy

toBytes

• toBytes(): Uint8Array

• Converts the whole transaction data to bytes.

  Returns Uint8Array

  A Uint8Array containing the full transaction bytes.

  Example

  const txBytes = transaction.toBytes();
  Copy

hash

• hash(): `0x${string}`

• Calculates the hash of the transaction.

  Returns `0x${string}`

  The hash of the transaction.

  Example

  const txHash = transaction.hash();
  Copy

StatichashWitnessToHasher

• 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);
  Copy

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
  }
  Copy

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);
  Copy

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);
  Copy

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);
  Copy

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);
  Copy

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);
  Copy

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);
  Copy

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);
  Copy

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");
  Copy

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");
  Copy

getWitnessArgsAt

• getWitnessArgsAt(index): undefined | ccc.WitnessArgs

• Get witness at index as WitnessArgs

  Parameters

  • index: number

    The index of the witness.

  Returns undefined | ccc.WitnessArgs

  The witness parsed as WitnessArgs.

  Example

  const witnessArgs = await tx.getWitnessArgsAt(0);
  Copy

setWitnessArgsAt

• setWitnessArgsAt(index, witness): void

• Set witness at index by WitnessArgs

  Parameters

  • index: number

    The index of the witness.
  • witness: ccc.WitnessArgs

    The WitnessArgs to set.

  Returns void

  Example

  await tx.setWitnessArgsAt(0, witnessArgs);
  Copy

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);
  Copy

getInputsCapacity

• getInputsCapacity(client): Promise<bigint>

• Parameters

  • client: Client

  Returns Promise<bigint>

getOutputsCapacity

• getOutputsCapacity(): bigint

• Returns bigint

getInputsUdtBalance

• getInputsUdtBalance(client, type): Promise<bigint>

• Parameters

  • client: Client
  • type: ScriptLike

  Returns Promise<bigint>

getOutputsUdtBalance

• getOutputsUdtBalance(type): bigint

• Parameters

  • type: ScriptLike

  Returns bigint

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;
  }>

completeInputsByCapacity

• completeInputsByCapacity(from, capacityTweak?, filter?): Promise<number>

• Parameters

  • from: ccc.Signer
  • OptionalcapacityTweak: NumLike
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<number>

completeInputsAll

• completeInputsAll(from, filter?): Promise<number>

• Parameters

  • from: ccc.Signer
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<number>

completeInputsByUdt

• completeInputsByUdt(from, type): Promise<number>

• Parameters

  • from: ccc.Signer
  • type: ScriptLike

  Returns Promise<number>

estimateFee

• estimateFee(feeRate): bigint

• Parameters

  • feeRate: NumLike

  Returns bigint

completeFee

• completeFee(from, change, feeRate, filter?): Promise<[number, boolean]>

• Parameters

  • from: ccc.Signer
  • change: ((tx: ccc.Transaction, capacity: bigint) => NumLike | Promise<NumLike>)
    • • (tx, capacity): NumLike | Promise<NumLike>

      • Parameters

        • tx: ccc.Transaction
        • capacity: bigint

        Returns NumLike | Promise<NumLike>

  • feeRate: NumLike
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<[number, boolean]>

completeFeeChangeToLock

• completeFeeChangeToLock(from, change, feeRate, filter?): Promise<[number, boolean]>

• Parameters

  • from: ccc.Signer
  • change: ScriptLike
  • feeRate: NumLike
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<[number, boolean]>

completeFeeBy

• completeFeeBy(from, feeRate, filter?): Promise<[number, boolean]>

• Parameters

  • from: ccc.Signer
  • feeRate: NumLike
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<[number, boolean]>

completeFeeChangeToOutput

• completeFeeChangeToOutput(from, index, feeRate, filter?): Promise<[number, boolean]>

• Parameters

  • from: ccc.Signer
  • index: NumLike
  • feeRate: NumLike
  • Optionalfilter: ClientCollectableSearchKeyFilterLike

  Returns Promise<[number, boolean]>