feat(type): rename is_dep_group to dep_type

BREAKING CHANGE: rename is_dep_group to dep_type
ckb-js · Aug 24, 2019 · 06c324a · 06c324a
1 parent ce48faf
commit 06c324a
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 28 deletions.
diff --git a/packages/ckb-sdk-core/examples/sendTransaction.js b/packages/ckb-sdk-core/examples/sendTransaction.js
@@ -184,7 +184,7 @@ const bootstrap = async () => {
       version: '0',
       cellDeps: [{
         outPoint: secp256k1Dep.outPoint,
-        isDepGroup: true,
+        depType: "depGroup",
       }, ],
       headerDeps: [],
       inputs,

diff --git a/packages/ckb-sdk-rpc/__tests__/formatters/params.json b/packages/ckb-sdk-rpc/__tests__/formatters/params.json
@@ -30,18 +30,28 @@
         "target": null
       }
     ],
+    "toDepType": [
+      {
+        "source": "code",
+        "target": "code"
+      },
+      {
+        "source": "depGroup",
+        "target": "dep_group"
+      }
+    ],
     "toCellDep": [
       {
         "source": null,
         "target": null
       },
       {
         "source": {
-          "isDepGroup": false
+          "depType": "depGroup"
         },
         "target": {
           "out_point": null,
-          "is_dep_group": false
+          "dep_type": "dep_group"
         }
       },
       {
@@ -50,17 +60,17 @@
         },
         "target": {
           "out_point": null,
-          "is_dep_group": false
+          "dep_type": "code"
         }
       },
       {
         "source": {
           "outPoint": null,
-          "isDepGroup": false
+          "depType": "depGroup"
         },
         "target": {
           "out_point": null,
-          "is_dep_group": false
+          "dep_type": "dep_group"
         }
       },
       {
@@ -69,14 +79,14 @@
             "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
             "index": "4294967295"
           },
-          "isDepGroup": true
+          "depType": "code"
         },
         "target": {
           "out_point": {
             "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
             "index": "4294967295"
           },
-          "is_dep_group": true
+          "dep_type": "code"
         }
       }
     ],
@@ -194,7 +204,7 @@
                 "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
                 "index": "4294967295"
               },
-              "isDepGroup": false
+              "depType": "code"
             }
           ],
           "headerDeps": [],
@@ -233,7 +243,7 @@
                 "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
                 "index": "4294967295"
               },
-              "is_dep_group": false
+              "dep_type": "code"
             }
           ],
           "header_deps": [],

diff --git a/packages/ckb-sdk-rpc/__tests__/formatters/result.json b/packages/ckb-sdk-rpc/__tests__/formatters/result.json
@@ -129,11 +129,11 @@
       },
       {
         "source": {
-          "is_dep_group": false
+          "dep_type": "dep_group"
         },
         "target": {
           "outPoint": null,
-          "isDepGroup": false
+          "depType": "depGroup"
         }
       },
       {
@@ -142,17 +142,17 @@
         },
         "target": {
           "outPoint": null,
-          "isDepGroup": false
+          "depType": "code"
         }
       },
       {
         "source": {
           "out_point": null,
-          "is_dep_group": false
+          "dep_type": "code"
         },
         "target": {
           "outPoint": null,
-          "isDepGroup": false
+          "depType": "code"
         }
       },
       {
@@ -161,14 +161,14 @@
             "tx_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
             "index": "4294967295"
           },
-          "is_dep_group": true
+          "dep_type": "code"
         },
         "target": {
           "outPoint": {
             "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
             "index": "4294967295"
           },
-          "isDepGroup": true
+          "depType": "code"
         }
       }
     ],
@@ -638,6 +638,16 @@
         }
       }
     ],
+    "toDepType": [
+      {
+        "source": "dep_group",
+        "target": "depGroup"
+      },
+      {
+        "source": "code",
+        "target": "code"
+      }
+    ],
     "toCell": [
       {
         "source": null,
@@ -646,7 +656,6 @@
       {
         "source": {
           "capacity": "5000000000000",
-
           "lock": {
             "args": [],
             "code_hash": "0x0000000000000000000000000000000000000000000000000000000000000001",
@@ -660,7 +669,6 @@
         },
         "target": {
           "capacity": "5000000000000",
-
           "lock": {
             "args": [],
             "codeHash": "0x0000000000000000000000000000000000000000000000000000000000000001",
@@ -683,7 +691,6 @@
         "source": {
           "cell": {
             "capacity": "5000000000000",
-
             "lock": {
               "args": [],
               "code_hash": "0x0000000000000000000000000000000000000000000000000000000000000001",
@@ -696,7 +703,6 @@
         "target": {
           "cell": {
             "capacity": "5000000000000",
-
             "lock": {
               "args": [],
               "codeHash": "0x0000000000000000000000000000000000000000000000000000000000000001",

diff --git a/packages/ckb-sdk-rpc/src/paramsFormatter.ts b/packages/ckb-sdk-rpc/src/paramsFormatter.ts
@@ -35,12 +35,18 @@ const formatter = {
       ...rest,
     }
   },
+  toDepType: (type: CKBComponents.DepType) => {
+    if (type === 'depGroup') {
+      return 'dep_group'
+    }
+    return type
+  },
   toCellDep: (cellDep: CKBComponents.CellDep): CKB_RPC.CellDep => {
     if (!cellDep) return cellDep
-    const { outPoint = null, isDepGroup: is_dep_group = false, ...rest } = cellDep
+    const { outPoint = null, depType = 'code', ...rest } = cellDep
     return {
       out_point: formatter.toOutPoint(outPoint),
-      is_dep_group,
+      dep_type: formatter.toDepType(depType),
       ...rest,
     }
   },

diff --git a/packages/ckb-sdk-rpc/src/resultFormatter.ts b/packages/ckb-sdk-rpc/src/resultFormatter.ts
@@ -57,12 +57,19 @@ const formatter = {
       ...rest,
     }
   },
+  toDepType: (type: CKB_RPC.DepType) => {
+    if (type === 'dep_group') {
+      return 'depGroup'
+    }
+    return type
+  },
+
   toCellDep: (cellDep: CKB_RPC.CellDep): CKBComponents.CellDep => {
     if (!cellDep) return cellDep
-    const { out_point: outPoint = null, is_dep_group: isDepGroup = false, ...rest } = cellDep
+    const { out_point: outPoint = null, dep_type = 'code', ...rest } = cellDep
     return {
       outPoint: formatter.toOutPoint(outPoint),
-      isDepGroup,
+      depType: formatter.toDepType(dep_type),
       ...rest,
     }
   },

diff --git a/packages/ckb-sdk-rpc/types/CKB_RPC/index.d.ts b/packages/ckb-sdk-rpc/types/CKB_RPC/index.d.ts
@@ -28,6 +28,8 @@ declare module CKB_RPC {
     Type = 'Type',
   }
 
+  export type DepType = 'code' | 'dep_group'
+
   export interface Script {
     args: Bytes[]
     code_hash: Hash256
@@ -54,7 +56,7 @@ declare module CKB_RPC {
 
   export interface CellDep {
     out_point: OutPoint | null
-    is_dep_group: boolean
+    dep_type: DepType
   }
 
   export interface CellIncludingOutPoint {

diff --git a/packages/ckb-types/index.d.ts b/packages/ckb-types/index.d.ts
@@ -30,6 +30,8 @@ declare namespace CKBComponents {
     Type = 'Type',
   }
 
+  export type DepType = 'code' | 'depGroup'
+
   /**
    * @typedef Bytes, keep consistent with CKB
    * @description Bytes will be serialized to string
@@ -102,11 +104,11 @@ declare namespace CKBComponents {
   /**
    * @typeof CellDep, cell dependencies in a transaction
    * @property outPoint, the out point of the cell dependency
-   * @property isDepGroup, indicate if the data of the cell containing a group of dependencies
+   * @property depType, indicate if the data of the cell containing a group of dependencies
    */
   export interface CellDep {
     outPoint: OutPoint | null
-    isDepGroup: boolean
+    depType: DepType
   }
 
   export interface Witness {