@ckb-ccc/lumos-patches 0.0.12-alpha.6 → 0.0.12

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @ckb-ccc/lumos-patches
+
+## 0.0.12
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @ckb-ccc/core@0.0.12

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://ckbccc-demo.vercel.app/">
+  <a href="https://app.ckbccc.com/">
     <img alt="Logo" src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/logo.svg" width="20%" />
   </a>
 </p>
@@ -15,7 +15,7 @@
   <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/ckb-ecofund/ccc" />
   <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/ckb-ecofund/ccc/master" />
   <img alt="GitHub deployments" src="https://img.shields.io/github/deployments/ckb-ecofund/ccc/production" />
-  <a href="https://ckbccc-demo.vercel.app/"><img
+  <a href="https://app.ckbccc.com/"><img
     alt="Demo" src="https://img.shields.io/website?url=https%3A%2F%2Fckbccc-demo.vercel.app%2F&label=Demo"
   /></a>
 </p>
@@ -33,13 +33,13 @@
 ## Preview
 
 <p align="center">
-  <a href="https://ckbccc-demo.vercel.app/">
+  <a href="https://app.ckbccc.com/">
     <img src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/preview.png" width="30%" />
   </a>
 </p>
 
-This project is still under active development, and we are looking forward to your feedback. [Try its demo now here](https://ckbccc-demo.vercel.app/). It showcases how to use CCC for some basic scenarios in CKB.
+This project is still under active development, and we are looking forward to your feedback. [Try its demo now here](https://app.ckbccc.com/). It showcases how to use CCC for some basic scenarios in CKB.
 
 <h3 align="center">
-  Read more about CCC on its <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.
+  Read more about CCC on <a href="https://docs.ckbccc.com">our website</a> or <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.
 </h3>

package/dist/default.d.ts

@@ -2,14 +2,16 @@ import { ccc } from "@ckb-ccc/core";
 import { LockScriptInfo } from "@ckb-lumos/common-scripts";
 /**
  * Generates custom lock script information.
- * @param {string} codeHash - The code hash of the custom script.
- * @param {CellDep[]} cellDeps - The cell dependencies for the custom script.
- * @returns {LockScriptInfo} The lock script information.
+ * @public
+ *
+ * @param codeHash - The code hash of the custom script.
+ * @param cellDeps - The cell dependencies for the custom script.
+ * @returns The lock script information.
  */
 export declare function generateScriptInfo(codeHash: string, cellDeps: ccc.CellDepInfoLike[], dummyLockLength: number): LockScriptInfo;
 /**
  * Generates default script information for CCC.
- * @returns {LockScriptInfo[]} An array of lock script information.
+ * @returns An array of lock script information.
  */
 export declare function generateDefaultScriptInfos(): LockScriptInfo[];
 //# sourceMappingURL=default.d.ts.map

package/dist/default.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../src/default.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAWpC,OAAO,EAEL,cAAc,EAEf,MAAM,2BAA2B,CAAC;AAqGnC;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,CAAC,eAAe,EAAE,EAC/B,eAAe,EAAE,MAAM,GACtB,cAAc,CAmGhB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,cAAc,EAAE,CAwB7D"}
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../src/default.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAWpC,OAAO,EAEL,cAAc,EAEf,MAAM,2BAA2B,CAAC;AAoGnC;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,CAAC,eAAe,EAAE,EAC/B,eAAe,EAAE,MAAM,GACtB,cAAc,CAmGhB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,cAAc,EAAE,CAwB7D"}

package/dist/default.js

@@ -21,22 +21,21 @@ function addCellDep(txSkeleton, newCellDep) {
 }
 /**
  * Generates a class for collecting custom script cells.
- * @param {string} codeHash - The code hash of the custom script.
- * @returns {typeof JoyIDCellCollector} The CustomCellCollector class.
+ * @param codeHash - The code hash of the custom script.
+ * @returns The CustomCellCollector class.
  */
 function generateCollectorClass(codeHash) {
     /**
      * Class representing a collector for custom script cells.
-     * @class
      */
     return class CustomCellCollector {
         /**
          * Creates an instance of CustomCollector.
-         * @param {FromInfo} fromInfo - The information about the address to collect cells from.
-         * @param {CellProvider} cellProvider - The provider to collect cells from.
-         * @param {Object} options - The options for the collector.
-         * @param {QueryOptions} [options.queryOptions={}] - The query options for collecting cells.
-         * @param {Config} [options.config=getConfig()] - The Lumos configuration.
+         * @param fromInfo - The information about the address to collect cells from.
+         * @param cellProvider - The provider to collect cells from.
+         * @param options - The options for the collector.
+         * @param] - The query options for collecting cells.
+         * @param [options.config=getConfig()] - The Lumos configuration.
          * @throws {Error} If cellProvider is not provided or fromInfo is not a string.
          */
         constructor(fromInfo, cellProvider, { queryOptions = {}, config = getConfig(), }) {
@@ -75,9 +74,11 @@ function generateCollectorClass(codeHash) {
 }
 /**
  * Generates custom lock script information.
- * @param {string} codeHash - The code hash of the custom script.
- * @param {CellDep[]} cellDeps - The cell dependencies for the custom script.
- * @returns {LockScriptInfo} The lock script information.
+ * @public
+ *
+ * @param codeHash - The code hash of the custom script.
+ * @param cellDeps - The cell dependencies for the custom script.
+ * @returns The lock script information.
  */
 export function generateScriptInfo(codeHash, cellDeps, dummyLockLength) {
     return {
@@ -150,7 +151,7 @@ export function generateScriptInfo(codeHash, cellDeps, dummyLockLength) {
 }
 /**
  * Generates default script information for CCC.
- * @returns {LockScriptInfo[]} An array of lock script information.
+ * @returns An array of lock script information.
  */
 export function generateDefaultScriptInfos() {
     const mainnet = cccA.MAINNET_SCRIPTS;

package/dist/utils.d.ts

@@ -1,7 +1,9 @@
 /**
  * Asserts that a condition is true, throwing an error if it is not.
- * @param {unknown} condition - The condition to assert.
- * @param {string} [message="Assert failed"] - The error message to throw if the condition is false.
+ * @public
+ *
+ * @param condition - The condition to assert.
+ * @param [message="Assert failed"] - The error message to throw if the condition is false.
  * @throws {Error} If the condition is false.
  */
 export declare function asserts(condition: unknown, message?: string): asserts condition;

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,OAAO,EAClB,OAAO,SAAkB,GACxB,OAAO,CAAC,SAAS,CAInB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,OAAO,EAClB,OAAO,SAAkB,GACxB,OAAO,CAAC,SAAS,CAInB"}

package/dist/utils.js

@@ -1,7 +1,9 @@
 /**
  * Asserts that a condition is true, throwing an error if it is not.
- * @param {unknown} condition - The condition to assert.
- * @param {string} [message="Assert failed"] - The error message to throw if the condition is false.
+ * @public
+ *
+ * @param condition - The condition to assert.
+ * @param [message="Assert failed"] - The error message to throw if the condition is false.
  * @throws {Error} If the condition is false.
  */
 export function asserts(condition, message = "Assert failed") {

package/dist.commonjs/default.d.ts

@@ -2,14 +2,16 @@ import { ccc } from "@ckb-ccc/core";
 import { LockScriptInfo } from "@ckb-lumos/common-scripts";
 /**
  * Generates custom lock script information.
- * @param {string} codeHash - The code hash of the custom script.
- * @param {CellDep[]} cellDeps - The cell dependencies for the custom script.
- * @returns {LockScriptInfo} The lock script information.
+ * @public
+ *
+ * @param codeHash - The code hash of the custom script.
+ * @param cellDeps - The cell dependencies for the custom script.
+ * @returns The lock script information.
  */
 export declare function generateScriptInfo(codeHash: string, cellDeps: ccc.CellDepInfoLike[], dummyLockLength: number): LockScriptInfo;
 /**
  * Generates default script information for CCC.
- * @returns {LockScriptInfo[]} An array of lock script information.
+ * @returns An array of lock script information.
  */
 export declare function generateDefaultScriptInfos(): LockScriptInfo[];
 //# sourceMappingURL=default.d.ts.map

package/dist.commonjs/default.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../src/default.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAWpC,OAAO,EAEL,cAAc,EAEf,MAAM,2BAA2B,CAAC;AAqGnC;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,CAAC,eAAe,EAAE,EAC/B,eAAe,EAAE,MAAM,GACtB,cAAc,CAmGhB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,cAAc,EAAE,CAwB7D"}
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../src/default.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAWpC,OAAO,EAEL,cAAc,EAEf,MAAM,2BAA2B,CAAC;AAoGnC;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,GAAG,CAAC,eAAe,EAAE,EAC/B,eAAe,EAAE,MAAM,GACtB,cAAc,CAmGhB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,cAAc,EAAE,CAwB7D"}

package/dist.commonjs/default.js

@@ -24,22 +24,21 @@ function addCellDep(txSkeleton, newCellDep) {
 }
 /**
  * Generates a class for collecting custom script cells.
- * @param {string} codeHash - The code hash of the custom script.
- * @returns {typeof JoyIDCellCollector} The CustomCellCollector class.
+ * @param codeHash - The code hash of the custom script.
+ * @returns The CustomCellCollector class.
  */
 function generateCollectorClass(codeHash) {
     /**
      * Class representing a collector for custom script cells.
-     * @class
      */
     return class CustomCellCollector {
         /**
          * Creates an instance of CustomCollector.
-         * @param {FromInfo} fromInfo - The information about the address to collect cells from.
-         * @param {CellProvider} cellProvider - The provider to collect cells from.
-         * @param {Object} options - The options for the collector.
-         * @param {QueryOptions} [options.queryOptions={}] - The query options for collecting cells.
-         * @param {Config} [options.config=getConfig()] - The Lumos configuration.
+         * @param fromInfo - The information about the address to collect cells from.
+         * @param cellProvider - The provider to collect cells from.
+         * @param options - The options for the collector.
+         * @param] - The query options for collecting cells.
+         * @param [options.config=getConfig()] - The Lumos configuration.
          * @throws {Error} If cellProvider is not provided or fromInfo is not a string.
          */
         constructor(fromInfo, cellProvider, { queryOptions = {}, config = (0, config_manager_1.getConfig)(), }) {
@@ -78,9 +77,11 @@ function generateCollectorClass(codeHash) {
 }
 /**
  * Generates custom lock script information.
- * @param {string} codeHash - The code hash of the custom script.
- * @param {CellDep[]} cellDeps - The cell dependencies for the custom script.
- * @returns {LockScriptInfo} The lock script information.
+ * @public
+ *
+ * @param codeHash - The code hash of the custom script.
+ * @param cellDeps - The cell dependencies for the custom script.
+ * @returns The lock script information.
  */
 function generateScriptInfo(codeHash, cellDeps, dummyLockLength) {
     return {
@@ -154,7 +155,7 @@ function generateScriptInfo(codeHash, cellDeps, dummyLockLength) {
 exports.generateScriptInfo = generateScriptInfo;
 /**
  * Generates default script information for CCC.
- * @returns {LockScriptInfo[]} An array of lock script information.
+ * @returns An array of lock script information.
  */
 function generateDefaultScriptInfos() {
     const mainnet = advanced_1.cccA.MAINNET_SCRIPTS;

package/dist.commonjs/utils.d.ts

@@ -1,7 +1,9 @@
 /**
  * Asserts that a condition is true, throwing an error if it is not.
- * @param {unknown} condition - The condition to assert.
- * @param {string} [message="Assert failed"] - The error message to throw if the condition is false.
+ * @public
+ *
+ * @param condition - The condition to assert.
+ * @param [message="Assert failed"] - The error message to throw if the condition is false.
  * @throws {Error} If the condition is false.
  */
 export declare function asserts(condition: unknown, message?: string): asserts condition;

package/dist.commonjs/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,OAAO,EAClB,OAAO,SAAkB,GACxB,OAAO,CAAC,SAAS,CAInB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,OAAO,EAClB,OAAO,SAAkB,GACxB,OAAO,CAAC,SAAS,CAInB"}

package/dist.commonjs/utils.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.asserts = void 0;
 /**
  * Asserts that a condition is true, throwing an error if it is not.
- * @param {unknown} condition - The condition to assert.
- * @param {string} [message="Assert failed"] - The error message to throw if the condition is false.
+ * @public
+ *
+ * @param condition - The condition to assert.
+ * @param [message="Assert failed"] - The error message to throw if the condition is false.
  * @throws {Error} If the condition is false.
  */
 function asserts(condition, message = "Assert failed") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/lumos-patches",
-  "version": "0.0.12-alpha.6",
+  "version": "0.0.12",
   "description": "Patches for using Lumos with CCC",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -18,11 +18,6 @@
       "default": "./dist.commonjs/index.js"
     }
   },
-  "scripts": {
-    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
-    "lint": "eslint",
-    "format": "prettier --write . && eslint --fix"
-  },
   "devDependencies": {
     "@eslint/js": "^9.1.1",
     "copyfiles": "^2.4.1",
@@ -39,13 +34,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.12-alpha.1",
     "@ckb-lumos/base": "^0.24.0-next.1",
     "@ckb-lumos/codec": "^0.24.0-next.1",
     "@ckb-lumos/common-scripts": "^0.24.0-next.1",
     "@ckb-lumos/config-manager": "^0.24.0-next.1",
     "@ckb-lumos/helpers": "^0.24.0-next.1",
-    "@joyid/ckb": "^1.0.1"
+    "@joyid/ckb": "^1.0.1",
+    "@ckb-ccc/core": "0.0.12"
   },
-  "gitHead": "3679eba15c5ec5397c514444594a09b777c3ffe1"
-}
+  "scripts": {
+    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
+    "lint": "eslint",
+    "format": "prettier --write . && eslint --fix"
+  }
+}

package/src/default.ts

@@ -45,13 +45,12 @@ function addCellDep(
 
 /**
  * Generates a class for collecting custom script cells.
- * @param {string} codeHash - The code hash of the custom script.
- * @returns {typeof JoyIDCellCollector} The CustomCellCollector class.
+ * @param codeHash - The code hash of the custom script.
+ * @returns The CustomCellCollector class.
  */
 function generateCollectorClass(codeHash: string) {
   /**
    * Class representing a collector for custom script cells.
-   * @class
    */
   return class CustomCellCollector {
     readonly fromScript: Script;
@@ -59,11 +58,11 @@ function generateCollectorClass(codeHash: string) {
 
     /**
      * Creates an instance of CustomCollector.
-     * @param {FromInfo} fromInfo - The information about the address to collect cells from.
-     * @param {CellProvider} cellProvider - The provider to collect cells from.
-     * @param {Object} options - The options for the collector.
-     * @param {QueryOptions} [options.queryOptions={}] - The query options for collecting cells.
-     * @param {Config} [options.config=getConfig()] - The Lumos configuration.
+     * @param fromInfo - The information about the address to collect cells from.
+     * @param cellProvider - The provider to collect cells from.
+     * @param options - The options for the collector.
+     * @param] - The query options for collecting cells.
+     * @param [options.config=getConfig()] - The Lumos configuration.
      * @throws {Error} If cellProvider is not provided or fromInfo is not a string.
      */
     constructor(
@@ -116,9 +115,11 @@ function generateCollectorClass(codeHash: string) {
 
 /**
  * Generates custom lock script information.
- * @param {string} codeHash - The code hash of the custom script.
- * @param {CellDep[]} cellDeps - The cell dependencies for the custom script.
- * @returns {LockScriptInfo} The lock script information.
+ * @public
+ *
+ * @param codeHash - The code hash of the custom script.
+ * @param cellDeps - The cell dependencies for the custom script.
+ * @returns The lock script information.
  */
 export function generateScriptInfo(
   codeHash: string,
@@ -227,7 +228,7 @@ export function generateScriptInfo(
 
 /**
  * Generates default script information for CCC.
- * @returns {LockScriptInfo[]} An array of lock script information.
+ * @returns An array of lock script information.
  */
 export function generateDefaultScriptInfos(): LockScriptInfo[] {
   const mainnet = cccA.MAINNET_SCRIPTS;

package/src/utils.ts

@@ -1,7 +1,9 @@
 /**
  * Asserts that a condition is true, throwing an error if it is not.
- * @param {unknown} condition - The condition to assert.
- * @param {string} [message="Assert failed"] - The error message to throw if the condition is false.
+ * @public
+ *
+ * @param condition - The condition to assert.
+ * @param [message="Assert failed"] - The error message to throw if the condition is false.
  * @throws {Error} If the condition is false.
  */
 export function asserts(

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "extends": ["../../typedoc.base.json"],
+  "name": "@ckb-ccc lumos-patches"
+}