Class Cell

constructor

• new Cell(outPoint, cellOutput, outputData): Cell

• Creates an instance of Cell.

  Parameters

  • outPoint: OutPoint

    The output point of the cell.
  • cellOutput: CellOutput

    The cell output of the cell.
  • outputData: `0x${string}`

    The output data of the cell.

  Returns Cell

outPoint

cellOutput

outputData

capacityFree

• get capacityFree(): bigint

• Returns bigint

occupiedSize

• get occupiedSize(): number

• Occupied bytes of a cell on chain It's CellOutput.occupiedSize + bytesFrom(outputData).byteLength

  Returns number

Staticfrom

• from(cell): Cell

• Creates a Cell instance from a CellLike object. This method accepts either outPoint or previousOutput to specify the cell's location, and supports automatic capacity calculation for the cell output.

  Parameters

  • cell: CellLike

    A CellLike object or an instance of Cell. The object can use either: - outPoint: For referencing a cell output - previousOutput: For referencing a cell input (alternative name for outPoint) The cellOutput can omit capacity for automatic calculation.

  Returns Cell

  A Cell instance.

  Example

  // Using outPoint with explicit capacity
  const cell1 = Cell.from({
    outPoint: { txHash: "0x...", index: 0 },
    cellOutput: {
      capacity: 1000n,
      lock: { codeHash: "0x...", hashType: "type", args: "0x..." }
    },
    outputData: "0x"
  });
  
  // Using previousOutput with automatic capacity calculation
  const cell2 = Cell.from({
    previousOutput: { txHash: "0x...", index: 0 },
    cellOutput: {
      lock: { codeHash: "0x...", hashType: "type", args: "0x..." }
      // capacity will be calculated automatically
    },
    outputData: "0x1234"
  });
  Copy

getDaoProfit

• getDaoProfit(client): Promise<bigint>

• Gets confirmed Nervos DAO profit of a Cell It returns non-zero value only when the cell is in withdrawal phase 2 See https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md

  Parameters

  • client: Client

    A client for searching DAO related headers

  Returns Promise<bigint>

  Profit

  Example

  const profit = await cell.getDaoProfit(client);
  Copy

isNervosDao

• isNervosDao(client, phase?): Promise<boolean>

• Parameters

  • client: Client
  • Optionalphase: "deposited" | "withdrew"

  Returns Promise<boolean>

getNervosDaoInfo

• getNervosDaoInfo(client): Promise<{
      depositHeader?: undefined;
      withdrawHeader?: undefined;
  } | {
      depositHeader: ClientBlockHeader;
      withdrawHeader?: undefined;
  } | {
      depositHeader: ClientBlockHeader;
      withdrawHeader: ClientBlockHeader;
  }>

• Parameters

  • client: Client

  Returns Promise<{
      depositHeader?: undefined;
      withdrawHeader?: undefined;
  } | {
      depositHeader: ClientBlockHeader;
      withdrawHeader?: undefined;
  } | {
      depositHeader: ClientBlockHeader;
      withdrawHeader: ClientBlockHeader;
  }>

clone

• clone(): Cell

• Clone a Cell

  Returns Cell

  A cloned Cell instance.

  Example

  const cell1 = cell0.clone();
  Copy