Class CellOutput

constructor

• new CellOutput(
      capacity: DecodedRecord<
          {
              capacity: Codec<NumLike, bigint, any>;
              lock: typeof Script;
              type: Codec<
                  | {} & {
                      codeHash: BytesLike;
                      hashType: HashTypeLike;
                      args: BytesLike;
                  }
                  | null
                  | undefined,
                  Script
                  | undefined,
                  unknown,
              >;
          },
      >,
  ): CellOutput

  Creates an instance of CellOutput.

  Parameters

  • capacity: DecodedRecord<
        {
            capacity: Codec<NumLike, bigint, any>;
            lock: typeof Script;
            type: Codec<
                | {} & {
                    codeHash: BytesLike;
                    hashType: HashTypeLike;
                    args: BytesLike;
                }
                | null
                | undefined,
                Script
                | undefined,
                unknown,
            >;
        },
    >

    The capacity of the cell.

  Returns CellOutput

capacity

lock

Optionaltype

occupiedSize

• get occupiedSize(): number

  Returns number

Staticfrom

• from(cellOutput: CellOutputLike, outputData?: BytesLike | null): CellOutput

  Creates a CellOutput instance from a CellOutputLike object.

  If outputData is provided, capacity is ensured to meet the occupied minimum. Valid instances are returned as-is, while invalid instances are reconstructed shallowly without mutating the original.

  Parameters

  • cellOutput: CellOutputLike

    A CellOutputLike object or an instance of CellOutput.

  • OptionaloutputData: BytesLike | null

    Optional output data for capacity verification.

  Returns CellOutput

  A CellOutput instance.

  Example

  // Basic usage with explicit capacity
  const cellOutput1 = CellOutput.from({
    capacity: 1000n,
    lock: { codeHash: "0x...", hashType: "type", args: "0x..." },
    type: { codeHash: "0x...", hashType: "type", args: "0x..." }
  });
  
  // Automatic capacity calculation
  const cellOutput2 = CellOutput.from({
    lock: { codeHash: "0x...", hashType: "type", args: "0x..." }
  }, "0x1234");
  Copy

clone

• clone(): CellOutput

  Clone a CellOutput.

  Returns CellOutput

  A cloned CellOutput instance.

  Example

  const cellOutput1 = cellOutput0.clone();
  Copy