feat(core): add Encodable type for wider hex like types

Author: Hanssen0

packages/core/src/address/index.ts

@@ -2,6 +2,7 @@ import { bech32m } from "bech32";
 import { bytesConcat, bytesFrom } from "../bytes/index.js";
 import { Script, ScriptLike, hashTypeToBytes } from "../ckb/index.js";
 import { Client, KnownScript } from "../client/index.js";
+import { Encodable } from "../codec/index.js";
 import { HexLike } from "../hex/index.js";
 import {
   ADDRESS_BECH32_LIMIT,
@@ -96,7 +97,7 @@ export class Address {
   static async fromKnownScript(
     client: Client,
     script: KnownScript,
-    args: HexLike,
+    args: Encodable,
   ): Promise<Address> {
     return Address.from({
       script: await Script.fromKnownScript(client, script, args),

packages/core/src/ckb/hash.ts

@@ -21,8 +21,5 @@ export function hashTypeId(
   cellInputLike: CellInputLike,
   outputIndex: NumLike,
 ): Hex {
-  return hashCkb(
-    CellInput.from(cellInputLike).toBytes(),
-    numLeToBytes(outputIndex, 8),
-  );
+  return hashCkb(CellInput.from(cellInputLike), numLeToBytes(outputIndex, 8));
 }

packages/core/src/ckb/script.ts

@@ -1,7 +1,7 @@
 import { Bytes, BytesLike, bytesFrom } from "../bytes/index.js";
 import type { Client } from "../client/index.js";
 import { KnownScript } from "../client/knownScript.js";
-import { Codec, Entity, codec } from "../codec/index.js";
+import { Codec, Encodable, Entity, codec, encodableToHex } from "../codec/index.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import { mol } from "../molecule/index.js";
 import {
@@ -102,9 +102,9 @@ export function hashTypeFromBytes(bytes: BytesLike): HashType {
  * @public
  */
 export type ScriptLike = {
-  codeHash: BytesLike;
+  codeHash: Encodable;
   hashType: HashTypeLike;
-  args: BytesLike;
+  args: Encodable;
 };
 /**
  * @public
@@ -192,9 +192,9 @@ export class Script extends Entity.Base<ScriptLike, Script>() {
     }
 
     return new Script(
-      hexFrom(script.codeHash),
+      encodableToHex(script.codeHash),
       hashTypeFrom(script.hashType),
-      hexFrom(script.args),
+      encodableToHex(script.args),
     );
   }
 
@@ -219,10 +219,10 @@ export class Script extends Entity.Base<ScriptLike, Script>() {
   static async fromKnownScript(
     client: Client,
     knownScript: KnownScript,
-    args: HexLike,
+    args: Encodable,
   ): Promise<Script> {
     const script = await client.getKnownScript(knownScript);
-    return new Script(script.codeHash, script.hashType, hexFrom(args));
+    return new Script(script.codeHash, script.hashType, encodableToHex(args));
   }
 
   /**

packages/core/src/ckb/transaction.ts

@@ -7,7 +7,13 @@ import {
   type ClientBlockHeaderLike,
 } from "../client/index.js";
 import { KnownScript } from "../client/knownScript.js";
-import { Codec, Entity, codec } from "../codec/index.js";
+import {
+  Codec,
+  Encodable,
+  Entity,
+  codec,
+  encodableToHex,
+} from "../codec/index.js";
 import { Zero, fixedPointFrom } from "../fixedPoint/index.js";
 import { Hasher, HasherCkb, hashCkb } from "../hasher/index.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
@@ -121,7 +127,7 @@ export function depTypeFromBytes(bytes: BytesLike): DepType {
  * @public
  */
 export type OutPointLike = {
-  txHash: HexLike;
+  txHash: Encodable;
   index: NumLike;
 };
 /**
@@ -163,7 +169,10 @@ export class OutPoint extends Entity.Base<OutPointLike, OutPoint>() {
     if (outPoint instanceof OutPoint) {
       return outPoint;
     }
-    return new OutPoint(hexFrom(outPoint.txHash), numFrom(outPoint.index));
+    return new OutPoint(
+      encodableToHex(outPoint.txHash),
+      numFrom(outPoint.index),
+    );
   }
 
   /**
@@ -263,7 +272,7 @@ export class CellOutput extends Entity.Base<CellOutputLike, CellOutput>() {
    */
   static from(
     cellOutput: CellOutputLike,
-    outputData?: HexLike | null,
+    outputData?: Encodable | null,
   ): CellOutput {
     const output = (() => {
       if (cellOutput instanceof CellOutput) {
@@ -279,7 +288,9 @@ export class CellOutput extends Entity.Base<CellOutputLike, CellOutput>() {
     if (outputData != null) {
       output.capacity = numMax(
         output.capacity,
-        fixedPointFrom(output.occupiedSize + bytesFrom(outputData).length),
+        fixedPointFrom(
+          output.occupiedSize + encodableToBytes(outputData).length,
+        ),
       );
     }
 
@@ -783,7 +794,7 @@ export type CellInputLike = (
 ) & {
   since?: SinceLike | NumLike | null;
   cellOutput?: CellOutputLike | null;
-  outputData?: HexLike | null;
+  outputData?: Encodable | null;
 };
 /**
  * @public
@@ -840,10 +851,11 @@ export class CellInput extends Entity.Base<CellInputLike, CellInput>() {
           ? cellInput.previousOutput
           : cellInput.outPoint,
       ),
-      Since.from(cellInput.since ?? 0).toNum(),
+      numFrom(cellInput.since ?? 0),
       apply(CellOutput.from, cellInput.cellOutput),
-      apply(hexFrom, cellInput.outputData),
+      apply(encodableToHex, cellInput.outputData),
     );
+
   }
 
   async getCell(client: Client): Promise<Cell> {
@@ -992,9 +1004,9 @@ export const CellDepVec = mol.vector(CellDep);
  * @public
  */
 export type WitnessArgsLike = {
-  lock?: HexLike | null;
-  inputType?: HexLike | null;
-  outputType?: HexLike | null;
+  lock?: Encodable | null;
+  inputType?: Encodable | null;
+  outputType?: Encodable | null;
 };
 /**
  * @public
@@ -1045,9 +1057,9 @@ export class WitnessArgs extends Entity.Base<WitnessArgsLike, WitnessArgs>() {
     }
 
     return new WitnessArgs(
-      apply(hexFrom, witnessArgs.lock),
-      apply(hexFrom, witnessArgs.inputType),
-      apply(hexFrom, witnessArgs.outputType),
+      apply(encodableToHex, witnessArgs.lock),
+      apply(encodableToHex, witnessArgs.inputType),
+      apply(encodableToHex, witnessArgs.outputType),
     );
   }
 }
@@ -1083,8 +1095,8 @@ export type TransactionLike = {
     | (Omit<CellOutputLike, "capacity"> &
         Partial<Pick<CellOutputLike, "capacity">>)[]
     | null;
-  outputsData?: HexLike[] | null;
-  witnesses?: HexLike[] | null;
+  outputsData?: Encodable[] | null;
+  witnesses?: Encodable[] | null;
 };
 /**
  * @public
@@ -1243,11 +1255,13 @@ export class Transaction extends Entity.Base<TransactionLike, Transaction>() {
         CellOutput.from(output, tx.outputsData?.[i] ?? []),
       ) ?? [];
     const outputsData = outputs.map((_, i) =>
-      hexFrom(tx.outputsData?.[i] ?? "0x"),
+      encodableToHex(tx.outputsData?.[i] ?? "0x"),
     );
     if (tx.outputsData != null && outputsData.length < tx.outputsData.length) {
       outputsData.push(
-        ...tx.outputsData.slice(outputsData.length).map((d) => hexFrom(d)),
+        ...tx.outputsData
+          .slice(outputsData.length)
+          .map((d) => encodableToHex(d)),
       );
     }
 
@@ -1258,7 +1272,7 @@ export class Transaction extends Entity.Base<TransactionLike, Transaction>() {
       tx.inputs?.map((input) => CellInput.from(input)) ?? [],
       outputs,
       outputsData,
-      tx.witnesses?.map(hexFrom) ?? [],
+      tx.witnesses?.map(encodableToHex) ?? [],
     );
   }
 
@@ -1808,8 +1822,8 @@ export class Transaction extends Entity.Base<TransactionLike, Transaction>() {
    * await tx.setWitnessArgsAt(0, witnessArgs);
    * ```
    */
-  setWitnessArgsAt(index: number, witness: WitnessArgs): void {
-    this.setWitnessAt(index, witness.toBytes());
+  setWitnessArgsAt(index: number, witness: WitnessArgsLike): void {
+    this.setWitnessAt(index, WitnessArgs.from(witness).toBytes());
   }
 
   /**

packages/core/src/client/cache/memory.ts

@@ -77,7 +77,7 @@ export class ClientCacheMemory extends ClientCache {
   ): Promise<void> {
     cellLikes.flat().forEach((cellLike) => {
       const cell = Cell.from(cellLike).clone();
-      const outPointStr = hexFrom(cell.outPoint.toBytes());
+      const outPointStr = cell.outPoint.toHex();
 
       this.cells.set(outPointStr, [true, cell]);
     });
@@ -88,7 +88,7 @@ export class ClientCacheMemory extends ClientCache {
   ): Promise<void> {
     outPointLikes.flat().forEach((outPointLike) => {
       const outPoint = OutPoint.from(outPointLike);
-      const outPointStr = hexFrom(outPoint.toBytes());
+      const outPointStr = outPoint.toHex();
 
       const existed = this.cells.get(outPointStr);
       if (existed) {
@@ -123,13 +123,13 @@ export class ClientCacheMemory extends ClientCache {
   async isUnusable(outPointLike: OutPointLike): Promise<boolean> {
     const outPoint = OutPoint.from(outPointLike);
 
-    return !(this.cells.get(hexFrom(outPoint.toBytes()))?.[0] ?? true);
+    return !(this.cells.get(outPoint.toHex())?.[0] ?? true);
   }
 
   async recordCells(...cells: (CellLike | CellLike[])[]): Promise<void> {
     cells.flat().map((cellLike) => {
       const cell = Cell.from(cellLike);
-      const outPointStr = hexFrom(cell.outPoint.toBytes());
+      const outPointStr = cell.outPoint.toHex();
 
       if (this.cells.get(outPointStr)) {
         return;
@@ -140,7 +140,7 @@ export class ClientCacheMemory extends ClientCache {
   async getCell(outPointLike: OutPointLike): Promise<Cell | undefined> {
     const outPoint = OutPoint.from(outPointLike);
 
-    const cell = this.cells.get(hexFrom(outPoint.toBytes()))?.[1];
+    const cell = this.cells.get(outPoint.toHex())?.[1];
     if (cell && cell.cellOutput && cell.outputData) {
       return Cell.from((cell as Cell).clone());
     }

packages/core/src/codec/entity.ts

@@ -1,6 +1,6 @@
 import { Bytes, bytesEq, bytesFrom, BytesLike } from "../bytes/index.js";
 import { hashCkb } from "../hasher/index.js";
-import { Hex, hexFrom } from "../hex/index.js";
+import { Hex, hexFrom, HexLike } from "../hex/index.js";
 import { Constructor } from "../utils/index.js";
 
 /**
@@ -123,7 +123,7 @@ export abstract class Entity {
        * @returns The hash of the entity
        */
       hash(): Hex {
-        return hashCkb(this.toBytes());
+        return hashCkb(this);
       }
 
       /**
@@ -151,6 +151,53 @@ export abstract class Entity {
   abstract clone(): Entity;
 }
 
+/**
+ * Represents any type that can be encoded into bytes or hex.
+ * @public
+ */
+export type Encodable =
+  | BytesLike
+  | { toBytes(): BytesLike }
+  | { toHex(): HexLike };
+
+/**
+ * Converts an {@link Encodable} object to {@link Bytes}.
+ *
+ * @param entity - The encodable object.
+ * @returns The bytes representation.
+ * @public
+ */
+export function encodableToBytes(entity: Encodable): Bytes {
+  if (entity instanceof Object) {
+    if ("toBytes" in entity) {
+      return bytesFrom(entity.toBytes());
+    } else if ("toHex" in entity) {
+      return bytesFrom(entity.toHex());
+    }
+  }
+
+  return bytesFrom(entity);
+}
+
+/**
+ * Converts an {@link Encodable} object to {@link Hex}.
+ *
+ * @param entity - The encodable object.
+ * @returns The hex representation.
+ * @public
+ */
+export function encodableToHex(entity: Encodable): Hex {
+  if (entity instanceof Object) {
+    if ("toBytes" in entity) {
+      return hexFrom(entity.toBytes());
+    } else if ("toHex" in entity) {
+      return hexFrom(entity.toHex());
+    }
+  }
+
+  return hexFrom(entity);
+}
+
 /**
  * A class decorator to add methods implementation on the {@link Entity.Base} class
  * @example

packages/core/src/hasher/hasherCkb.ts

@@ -1,5 +1,6 @@
 import { blake2b } from "@noble/hashes/blake2.js";
-import { BytesLike, bytesFrom } from "../bytes/index.js";
+import { BytesLike } from "../bytes/index.js";
+import { Encodable, encodableToBytes } from "../codec/index.js";
 import { Hex, hexFrom } from "../hex/index.js";
 import { CKB_BLAKE2B_PERSONAL } from "./advanced.js";
 import { Hasher } from "./hasher.js";
@@ -41,8 +42,8 @@ export class HasherCkb implements Hasher {
    * ```
    */
 
-  update(data: BytesLike): HasherCkb {
-    this.hasher.update(bytesFrom(data));
+  update(data: Encodable): HasherCkb {
+    this.hasher.update(encodableToBytes(data));
     return this;
   }
 
@@ -76,12 +77,12 @@ export class HasherCkb implements Hasher {
  * const hash = hashCkb("some data"); // Outputs something like "0x..."
  * ```
  */
-export function hashCkb(...data: BytesLike[]): Hex {
+export function hashCkb(...data: Encodable[]): Hex {
   const hasher = new HasherCkb();
   data.forEach((d) => hasher.update(d));
   return hasher.digest();
 }
 
-export function hashCkbShort(...data: BytesLike[]): Hex {
+export function hashCkbShort(...data: Encodable[]): Hex {
   return hashCkb(...data).slice(0, HASH_CKB_SHORT_LENGTH * 2 + 2) as Hex;
 }

packages/core/src/signer/btc/signerBtc.ts

@@ -124,19 +124,17 @@ export abstract class SignerBtc extends Signer {
     );
     signature[0] = 31 + ((signature[0] - 27) % 4);
 
-    const witness = WitnessArgs.fromBytes(tx.witnesses[info.position]);
-    witness.lock = hexFrom(
-      bytesConcat(
+    tx.setWitnessArgsAt(info.position, {
+      ...(tx.getWitnessArgsAt(info.position) ?? {}),
+      lock: bytesConcat(
         numToBytes(5 * 4 + signature.length, 4),
         numToBytes(4 * 4, 4),
         numToBytes(5 * 4 + signature.length, 4),
         numToBytes(5 * 4 + signature.length, 4),
         numToBytes(signature.length, 4),
         signature,
       ),
-    );
-
-    tx.setWitnessArgsAt(info.position, witness);
+    });
     return tx;
   }