fix(molecule): incorrect fallback Bytes codec in codegen (#737)

ckb-js · Aug 5, 2024 · 66bbbfd · 66bbbfd · github-actions · Aug 5, 2024
1 parent 3cf82d9
commit 66bbbfd
Show file tree

Hide file tree

Showing 14 changed files with 1,234 additions and 23 deletions.
diff --git a/.changeset/shaggy-beans-grab.md b/.changeset/shaggy-beans-grab.md
@@ -0,0 +1,5 @@
+---
+"@ckb-lumos/molecule": minor
+---
+
+fix: incorrect fallback `Bytes` codec from codegen
diff --git a/examples/molecule-codegen-dir/generated/common/basic_types.ts b/examples/molecule-codegen-dir/generated/common/basic_types.ts
@@ -3,12 +3,9 @@
 import { bytes, createBytesCodec, createFixedBytesCodec, molecule } from "@ckb-lumos/codec";
 import  { Uint32, Uint64, Uint128, DepType, HashType }  from '../../customized'
 
-const { array, vector, union, option, struct, table } = molecule;
+const { array, vector, union, option, struct, table, byteVecOf } = molecule;
 
-const fallbackBytesCodec = createBytesCodec({
-  pack: bytes.bytify,
-  unpack: bytes.hexify,
-});
+const fallbackBytesCodec = byteVecOf({ pack: bytes.bytify, unpack: bytes.hexify });
 
 function createFallbackFixedBytesCodec(byteLength: number) {
   return createFixedBytesCodec({

diff --git a/examples/molecule-codegen-dir/generated/skills.ts b/examples/molecule-codegen-dir/generated/skills.ts
@@ -4,12 +4,9 @@ import { bytes, createBytesCodec, createFixedBytesCodec, molecule } from "@ckb-l
 import  { Uint32, Uint64, Uint128, DepType, HashType }  from '../customized'
 import { AttrValue, SkillLevel, Uint8, Uint16 } from './common/basic_types'
 
-const { array, vector, union, option, struct, table } = molecule;
+const { array, vector, union, option, struct, table, byteVecOf } = molecule;
 
-const fallbackBytesCodec = createBytesCodec({
-  pack: bytes.bytify,
-  unpack: bytes.hexify,
-});
+const fallbackBytesCodec = byteVecOf({ pack: bytes.bytify, unpack: bytes.hexify });
 
 function createFallbackFixedBytesCodec(byteLength: number) {
   return createFixedBytesCodec({

diff --git a/examples/molecule-codegen/blockchain.ts b/examples/molecule-codegen/blockchain.ts
@@ -1,15 +1,11 @@
 // This file is generated by @ckb-lumos/molecule, please do not modify it manually.
 /* eslint-disable */
-
 import { bytes, createBytesCodec, createFixedBytesCodec, molecule } from "@ckb-lumos/codec";
 import { Uint32, Uint64, Uint128, DepType, HashType } from './customized'
 
-const { array, vector, union, option, struct, table } = molecule;
+const { array, vector, union, option, struct, table, byteVecOf } = molecule;
 
-const fallbackBytesCodec = createBytesCodec({
-  pack: bytes.bytify,
-  unpack: bytes.hexify,
-});
+const fallbackBytesCodec = byteVecOf({ pack: bytes.bytify, unpack: bytes.hexify });
 
 function createFallbackFixedBytesCodec(byteLength: number) {
   return createFixedBytesCodec({
@@ -140,3 +136,4 @@ export const BlockV1 = table({
   proposals: ProposalShortIdVec,
   extension: Bytes
 }, ['header', 'uncles', 'transactions', 'proposals', 'extension']);
+
diff --git a/packages/molecule/package.json b/packages/molecule/package.json
@@ -60,6 +60,8 @@
   },
   "devDependencies": {
     "@ckb-lumos/base": "0.24.0-next.1",
-    "jsbi": "^4.1.0"
+    "jsbi": "^4.1.0",
+    "js-yaml": "^4.1.0",
+    "@types/js-yaml": "^4.0.9"
   }
 }
diff --git a/packages/molecule/src/cli.ts b/packages/molecule/src/cli.ts
@@ -119,5 +119,5 @@ function outputSingleToConsole(schemaFile: string) {
     codegenOption
   );
 
-  console.log(generated);
+  console.log(generated.code);
 }
diff --git a/packages/molecule/src/codegen.ts b/packages/molecule/src/codegen.ts
@@ -198,12 +198,9 @@ export function codegen(schema: string, options: Options = {}): CodegenResult {
 import { bytes, createBytesCodec, createFixedBytesCodec, molecule } from "@ckb-lumos/codec";
 ${options.prepend || ""}
 
-const { array, vector, union, option, struct, table } = molecule;
+const { array, vector, union, option, struct, table, byteVecOf } = molecule;
 
-const fallbackBytesCodec = createBytesCodec({
-  pack: bytes.bytify,
-  unpack: bytes.hexify,
-});
+const fallbackBytesCodec = byteVecOf({ pack: bytes.bytify, unpack: bytes.hexify });
 
 function createFallbackFixedBytesCodec(byteLength: number) {
   return createFixedBytesCodec({

diff --git a/packages/molecule/tests/codegen/customization.ts b/packages/molecule/tests/codegen/customization.ts
@@ -0,0 +1,5 @@
+import { molecule } from "@ckb-lumos/codec";
+
+// the compiler does not support empty block declaration
+// so the Table0 is manually declared
+export const Table0 = molecule.table({}, []);