@ckb-ccc/core 1.22.1 → 1.23.0

package/src/codec/entity.ts

@@ -3,7 +3,7 @@ import { hashCkb } from "../hasher/index.js";
 import { Hex, hexFrom } from "../hex/index.js";
 import type { UnionDecoded, UnionMatchHandlers } from "../molecule/codec.js";
 import { Constructor } from "../utils/index.js";
-import type { CodecLike, DecodedType } from "./codec.js";
+import type { CodecLike, ContextType, DecodedType } from "./codec.js";
 
 /**
  * The base class of CCC to create a serializable instance. This should be used with the {@link codec} decorator.
@@ -15,7 +15,12 @@ export abstract class Entity {
    * This should be used with the {@link codec} decorator.
    * @public
    */
-  static Base<SubTypeLike, SubType = SubTypeLike>() {
+  static Base<
+    SubTypeLike,
+    SubType = SubTypeLike,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    Context = any,
+  >() {
     abstract class Impl extends Entity {
       /**
        * The bytes length of the entity, if it is fixed, otherwise undefined
@@ -41,10 +46,11 @@ export abstract class Entity {
        * @public
        * @static
        * @param _ - The bytes to decode
+       * @param _context - Optional context passed to the codec
        * @returns The decoded entity
        * @throws Will throw an error if the entity is not serializable
        */
-      static decode(_: BytesLike): SubType {
+      static decode(_: BytesLike, _context?: Context): SubType {
         throw new Error(
           "decode not implemented, use @ccc.codec to decorate your type",
         );
@@ -55,10 +61,11 @@ export abstract class Entity {
        * @public
        * @static
        * @param _ - The bytes to create the entity from
+       * @param _context - Optional context passed to the codec
        * @returns The created entity
        * @throws Will throw an error if the entity is not serializable
        */
-      static fromBytes(_bytes: BytesLike): SubType {
+      static fromBytes(_bytes: BytesLike, _context?: Context): SubType {
         throw new Error(
           "fromBytes not implemented, use @ccc.codec to decorate your type",
         );
@@ -181,14 +188,18 @@ export abstract class Entity {
    */
   static BaseUnion<
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    CodecType extends CodecLike<any, UnionDecoded<any, any>>,
+    CodecType extends CodecLike<any, UnionDecoded<any, any>, any>,
     SubTypeLike,
     SubType = SubTypeLike,
   >() {
     type Handlers<Result> = UnionMatchHandlers<CodecType, Result>;
     type Decoded = DecodedType<CodecType>;
 
-    abstract class Impl extends Entity.Base<SubTypeLike, SubType>() {
+    abstract class Impl extends Entity.Base<
+      SubTypeLike,
+      SubType,
+      ContextType<CodecType>
+    >() {
       /**
        * The inner decoded object representing the union value.
        * @public
@@ -263,12 +274,11 @@ export function codec<
   Encodable,
   TypeLike extends Encodable,
   Decoded extends TypeLike,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Context = any,
 >(codec: {
   encode: (encodable: Encodable) => Bytes;
-  decode: (
-    decodable: Bytes,
-    config?: { isExtraFieldIgnored?: boolean },
-  ) => Decoded;
+  decode: (decodable: Bytes, context?: Context) => Decoded;
   byteLength?: number;
 }) {
   return function <
@@ -277,8 +287,8 @@ export function codec<
       from(decoded: TypeLike): Type;
       byteLength?: number;
       encode(encodable: TypeLike): Bytes;
-      decode(bytesLike: BytesLike): Type;
-      fromBytes(bytes: BytesLike): Type;
+      decode(bytesLike: BytesLike, context?: Context): Type;
+      fromBytes(bytes: BytesLike, context?: Context): Type;
     },
   >(Constructor: ConstructorType, ..._: unknown[]) {
     Constructor.byteLength = codec.byteLength;
@@ -288,13 +298,13 @@ export function codec<
       };
     }
     if (Constructor.decode === undefined) {
-      Constructor.decode = function (bytesLike: BytesLike) {
-        return Constructor.from(codec.decode(bytesFrom(bytesLike)));
+      Constructor.decode = function (bytesLike: BytesLike, context?: Context) {
+        return Constructor.from(codec.decode(bytesFrom(bytesLike), context));
       };
     }
     if (Constructor.fromBytes === undefined) {
-      Constructor.fromBytes = function (bytes: BytesLike) {
-        return Constructor.from(codec.decode(bytesFrom(bytes)));
+      Constructor.fromBytes = function (bytes: BytesLike, context?: Context) {
+        return Constructor.from(codec.decode(bytesFrom(bytes), context));
       };
     }