@ckb-ccc/core 0.0.7-alpha.2 → 0.0.8-alpha.3

package/README.md

@@ -21,11 +21,13 @@
 </p>
 
 <p align="center">
-  "Common Chains Connector" is where CCC begins.
+  "CCC - CKBers' Codebase" is the next step of "Common Chains Connector".
   <br />
-  CCC helps you to interoperate wallets from different chain ecosystems with CKB,
+  Empower yourself with CCC to discover the unlimited potential of CKB.
   <br />
-  fully enabling CKB's cryptographic freedom power.
+  Interoperate with wallets from different chain ecosystems.
+  <br />
+  Fully enabling CKB's Turing completeness and cryptographic freedom power.
 </p>
 
 ## Preview
@@ -36,7 +38,7 @@
   </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/).
+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.
 
 <h3 align="center">
   Read more about CCC on its <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.

package/dist.commonjs/address/address.advanced.d.ts

@@ -17,9 +17,9 @@ import { type AddressLike } from "./index";
  * ```
  */
 export declare function addressPayloadFromString(address: string): {
-    prefix: string;
-    format: AddressFormat;
-    payload: number[];
+  prefix: string;
+  format: AddressFormat;
+  payload: number[];
 };
 /**
  * Converts an address payload into an address-like object.
@@ -39,27 +39,32 @@ export declare function addressPayloadFromString(address: string): {
  * console.log(address.prefix); // Outputs the address prefix
  * ```
  */
-export declare function addressFromPayload(prefix: string, format: AddressFormat, payload: number[], client: Client): Promise<AddressLike>;
+export declare function addressFromPayload(
+  prefix: string,
+  format: AddressFormat,
+  payload: number[],
+  client: Client,
+): Promise<AddressLike>;
 export declare enum AddressFormat {
-    /**
-     * full version identifies the hashType
-     */
-    Full = 0,
-    /**
-     * @deprecated
-     * short version for locks with Known codeHash, deprecated
-     */
-    Short = 1,
-    /**
-     * @deprecated
-     * full version with hashType = "Data", deprecated
-     */
-    FullData = 2,
-    /**
-     * @deprecated
-     * full version with hashType = "Type", deprecated
-     */
-    FullType = 4
+  /**
+   * full version identifies the hashType
+   */
+  Full = 0,
+  /**
+   * @deprecated
+   * short version for locks with Known codeHash, deprecated
+   */
+  Short = 1,
+  /**
+   * @deprecated
+   * full version with hashType = "Data", deprecated
+   */
+  FullData = 2,
+  /**
+   * @deprecated
+   * full version with hashType = "Type", deprecated
+   */
+  FullType = 4,
 }
 export declare const ADDRESS_BECH32_LIMIT = 1023;
-//# sourceMappingURL=address.advanced.d.ts.map
+//# sourceMappingURL=address.advanced.d.ts.map

package/dist.commonjs/address/address.advanced.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADDRESS_BECH32_LIMIT = exports.AddressFormat = exports.addressFromPayload = exports.addressPayloadFromString = void 0;
+exports.ADDRESS_BECH32_LIMIT =
+  exports.AddressFormat =
+  exports.addressFromPayload =
+  exports.addressPayloadFromString =
+    void 0;
 const bech32_1 = require("bech32");
 const ckb_1 = require("../ckb");
 const client_1 = require("../client");
@@ -22,27 +26,35 @@ const hex_1 = require("../hex");
  * ```
  */
 function addressPayloadFromString(address) {
-    // Try parse full format address
-    {
-        const { words, prefix } = bech32_1.bech32m.decode(address, exports.ADDRESS_BECH32_LIMIT);
-        const [formatType, ...payload] = bech32_1.bech32m.fromWords(words);
-        if (formatType === AddressFormat.Full) {
-            return { prefix, format: AddressFormat.Full, payload };
-        }
+  // Try parse full format address
+  {
+    const { words, prefix } = bech32_1.bech32m.decode(
+      address,
+      exports.ADDRESS_BECH32_LIMIT,
+    );
+    const [formatType, ...payload] = bech32_1.bech32m.fromWords(words);
+    if (formatType === AddressFormat.Full) {
+      return { prefix, format: AddressFormat.Full, payload };
     }
-    // Try parse legacy 2019 format address
-    {
-        const { prefix, words } = bech32_1.bech32.decode(address, exports.ADDRESS_BECH32_LIMIT);
-        const [formatType, ...payload] = bech32_1.bech32.fromWords(words);
-        if ([
-            AddressFormat.FullData,
-            AddressFormat.FullType,
-            AddressFormat.Short,
-        ].includes(formatType)) {
-            return { prefix, format: formatType, payload };
-        }
+  }
+  // Try parse legacy 2019 format address
+  {
+    const { prefix, words } = bech32_1.bech32.decode(
+      address,
+      exports.ADDRESS_BECH32_LIMIT,
+    );
+    const [formatType, ...payload] = bech32_1.bech32.fromWords(words);
+    if (
+      [
+        AddressFormat.FullData,
+        AddressFormat.FullType,
+        AddressFormat.Short,
+      ].includes(formatType)
+    ) {
+      return { prefix, format: formatType, payload };
     }
-    throw Error(`Unknown address format ${address}`);
+  }
+  throw Error(`Unknown address format ${address}`);
 }
 exports.addressPayloadFromString = addressPayloadFromString;
 /**
@@ -64,83 +76,97 @@ exports.addressPayloadFromString = addressPayloadFromString;
  * ```
  */
 async function addressFromPayload(prefix, format, payload, client) {
-    if (format === AddressFormat.Full) {
-        if (payload.length < 32 + 1) {
-            throw new Error(`Invalid full address without enough payload ${(0, hex_1.hexFrom)(payload)}`);
-        }
-        return {
-            script: {
-                codeHash: payload.slice(0, 32),
-                hashType: (0, ckb_1.hashTypeFromBytes)(payload.slice(32, 33)),
-                args: payload.slice(33),
-            },
-            prefix,
-        };
+  if (format === AddressFormat.Full) {
+    if (payload.length < 32 + 1) {
+      throw new Error(
+        `Invalid full address without enough payload ${(0, hex_1.hexFrom)(payload)}`,
+      );
     }
-    if (format === AddressFormat.FullData) {
-        if (payload.length < 32) {
-            throw new Error(`Invalid full data address without enough payload ${(0, hex_1.hexFrom)(payload)}`);
-        }
-        return {
-            script: {
-                codeHash: payload.slice(0, 32),
-                hashType: "data",
-                args: payload.slice(32),
-            },
-            prefix,
-        };
-    }
-    if (format === AddressFormat.FullType) {
-        if (payload.length < 32) {
-            throw new Error(`Invalid full type address without enough payload ${(0, hex_1.hexFrom)(payload)}`);
-        }
-        return {
-            script: {
-                codeHash: payload.slice(0, 32),
-                hashType: "type",
-                args: payload.slice(32),
-            },
-            prefix,
-        };
-    }
-    // format === AddressFormat.Short
-    if (payload.length !== 21) {
-        throw new Error(`Invalid short address without enough payload ${(0, hex_1.hexFrom)(payload)}`);
+    return {
+      script: {
+        codeHash: payload.slice(0, 32),
+        hashType: (0, ckb_1.hashTypeFromBytes)(payload.slice(32, 33)),
+        args: payload.slice(33),
+      },
+      prefix,
+    };
+  }
+  if (format === AddressFormat.FullData) {
+    if (payload.length < 32) {
+      throw new Error(
+        `Invalid full data address without enough payload ${(0, hex_1.hexFrom)(payload)}`,
+      );
     }
-    const script = [
-        client_1.KnownScript.Secp256k1Blake160,
-        client_1.KnownScript.Secp256k1Multisig,
-        client_1.KnownScript.AnyoneCanPay,
-    ][payload[0]];
-    if (script === undefined) {
-        throw new Error(`Invalid short address with unknown script ${(0, hex_1.hexFrom)(payload)}`);
+    return {
+      script: {
+        codeHash: payload.slice(0, 32),
+        hashType: "data",
+        args: payload.slice(32),
+      },
+      prefix,
+    };
+  }
+  if (format === AddressFormat.FullType) {
+    if (payload.length < 32) {
+      throw new Error(
+        `Invalid full type address without enough payload ${(0, hex_1.hexFrom)(payload)}`,
+      );
     }
     return {
-        script: await ckb_1.Script.fromKnownScript(client, script, payload.slice(1)),
-        prefix,
+      script: {
+        codeHash: payload.slice(0, 32),
+        hashType: "type",
+        args: payload.slice(32),
+      },
+      prefix,
     };
+  }
+  // format === AddressFormat.Short
+  if (payload.length !== 21) {
+    throw new Error(
+      `Invalid short address without enough payload ${(0, hex_1.hexFrom)(payload)}`,
+    );
+  }
+  const script = [
+    client_1.KnownScript.Secp256k1Blake160,
+    client_1.KnownScript.Secp256k1Multisig,
+    client_1.KnownScript.AnyoneCanPay,
+  ][payload[0]];
+  if (script === undefined) {
+    throw new Error(
+      `Invalid short address with unknown script ${(0, hex_1.hexFrom)(payload)}`,
+    );
+  }
+  return {
+    script: await ckb_1.Script.fromKnownScript(
+      client,
+      script,
+      payload.slice(1),
+    ),
+    prefix,
+  };
 }
 exports.addressFromPayload = addressFromPayload;
 var AddressFormat;
 (function (AddressFormat) {
-    /**
-     * full version identifies the hashType
-     */
-    AddressFormat[AddressFormat["Full"] = 0] = "Full";
-    /**
-     * @deprecated
-     * short version for locks with Known codeHash, deprecated
-     */
-    AddressFormat[AddressFormat["Short"] = 1] = "Short";
-    /**
-     * @deprecated
-     * full version with hashType = "Data", deprecated
-     */
-    AddressFormat[AddressFormat["FullData"] = 2] = "FullData";
-    /**
-     * @deprecated
-     * full version with hashType = "Type", deprecated
-     */
-    AddressFormat[AddressFormat["FullType"] = 4] = "FullType";
+  /**
+   * full version identifies the hashType
+   */
+  AddressFormat[(AddressFormat["Full"] = 0)] = "Full";
+  /**
+   * @deprecated
+   * short version for locks with Known codeHash, deprecated
+   */
+  AddressFormat[(AddressFormat["Short"] = 1)] = "Short";
+  /**
+   * @deprecated
+   * full version with hashType = "Data", deprecated
+   */
+  AddressFormat[(AddressFormat["FullData"] = 2)] = "FullData";
+  /**
+   * @deprecated
+   * full version with hashType = "Type", deprecated
+   */
+  AddressFormat[(AddressFormat["FullType"] = 4)] = "FullType";
 })(AddressFormat || (exports.AddressFormat = AddressFormat = {}));
 exports.ADDRESS_BECH32_LIMIT = 1023;

package/dist.commonjs/address/advanced.d.ts

@@ -1,2 +1,2 @@
 export * from "./address.advanced";
-//# sourceMappingURL=advanced.d.ts.map
+//# sourceMappingURL=advanced.d.ts.map

package/dist.commonjs/address/advanced.js

@@ -1,17 +1,33 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./address.advanced"), exports);

package/dist.commonjs/address/index.d.ts

@@ -2,53 +2,60 @@ import { Script, ScriptLike } from "../ckb";
 import { Client, KnownScript } from "../client";
 import { HexLike } from "../hex";
 export type AddressLike = {
-    script: ScriptLike;
-    prefix: string;
+  script: ScriptLike;
+  prefix: string;
 };
 /**
  * Represents a ckb address with associated script and prefix.
  */
 export declare class Address {
-    script: Script;
-    prefix: string;
-    /**
-     * Creates an instance of Address.
-     *
-     * @param script - The script associated with the address.
-     * @param prefix - The address prefix.
-     */
-    constructor(script: Script, prefix: string);
-    /**
-     * Creates an Address instance from an AddressLike object.
-     *
-     * @param address - An AddressLike object or an instance of Address.
-     * @returns An Address instance.
-     */
-    static from(address: AddressLike): Address;
-    /**
-     * Creates an Address instance from an address string.
-     *
-     * @param address - The address string to parse.
-     * @param clients - A Client instance or a record of Client instances keyed by prefix.
-     * @returns A promise that resolves to an Address instance.
-     *
-     * @throws Will throw an error if the address prefix is unknown or mismatched.
-     */
-    static fromString(address: string, clients: Client | Record<string, Client>): Promise<Address>;
-    /**
-     * Creates an Address instance from a script and client.
-     *
-     * @param script - The script-like object.
-     * @param client - The client instance used to fetch the address prefix.
-     * @returns A promise that resolves to an Address instance.
-     */
-    static fromScript(script: ScriptLike, client: Client): Address;
-    static fromKnownScript(client: Client, script: KnownScript, args: HexLike): Promise<Address>;
-    /**
-     * Converts the Address instance to a string.
-     *
-     * @returns The address as a string.
-     */
-    toString(): string;
+  script: Script;
+  prefix: string;
+  /**
+   * Creates an instance of Address.
+   *
+   * @param script - The script associated with the address.
+   * @param prefix - The address prefix.
+   */
+  constructor(script: Script, prefix: string);
+  /**
+   * Creates an Address instance from an AddressLike object.
+   *
+   * @param address - An AddressLike object or an instance of Address.
+   * @returns An Address instance.
+   */
+  static from(address: AddressLike): Address;
+  /**
+   * Creates an Address instance from an address string.
+   *
+   * @param address - The address string to parse.
+   * @param clients - A Client instance or a record of Client instances keyed by prefix.
+   * @returns A promise that resolves to an Address instance.
+   *
+   * @throws Will throw an error if the address prefix is unknown or mismatched.
+   */
+  static fromString(
+    address: string,
+    clients: Client | Record<string, Client>,
+  ): Promise<Address>;
+  /**
+   * Creates an Address instance from a script and client.
+   *
+   * @param script - The script-like object.
+   * @param client - The client instance used to fetch the address prefix.
+   * @returns A promise that resolves to an Address instance.
+   */
+  static fromScript(script: ScriptLike, client: Client): Address;
+  static fromKnownScript(
+    client: Client,
+    script: KnownScript,
+    args: HexLike,
+  ): Promise<Address>;
+  /**
+   * Converts the Address instance to a string.
+   *
+   * @returns The address as a string.
+   */
+  toString(): string;
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/address/index.js

@@ -9,73 +9,92 @@ const address_advanced_1 = require("./address.advanced");
  * Represents a ckb address with associated script and prefix.
  */
 class Address {
-    /**
-     * Creates an instance of Address.
-     *
-     * @param script - The script associated with the address.
-     * @param prefix - The address prefix.
-     */
-    constructor(script, prefix) {
-        this.script = script;
-        this.prefix = prefix;
+  /**
+   * Creates an instance of Address.
+   *
+   * @param script - The script associated with the address.
+   * @param prefix - The address prefix.
+   */
+  constructor(script, prefix) {
+    this.script = script;
+    this.prefix = prefix;
+  }
+  /**
+   * Creates an Address instance from an AddressLike object.
+   *
+   * @param address - An AddressLike object or an instance of Address.
+   * @returns An Address instance.
+   */
+  static from(address) {
+    if (address instanceof Address) {
+      return address;
     }
-    /**
-     * Creates an Address instance from an AddressLike object.
-     *
-     * @param address - An AddressLike object or an instance of Address.
-     * @returns An Address instance.
-     */
-    static from(address) {
-        if (address instanceof Address) {
-            return address;
-        }
-        return new Address(ckb_1.Script.from(address.script), address.prefix);
+    return new Address(ckb_1.Script.from(address.script), address.prefix);
+  }
+  /**
+   * Creates an Address instance from an address string.
+   *
+   * @param address - The address string to parse.
+   * @param clients - A Client instance or a record of Client instances keyed by prefix.
+   * @returns A promise that resolves to an Address instance.
+   *
+   * @throws Will throw an error if the address prefix is unknown or mismatched.
+   */
+  static async fromString(address, clients) {
+    const { prefix, format, payload } = (0,
+    address_advanced_1.addressPayloadFromString)(address);
+    const client = clients[prefix] ?? clients;
+    if (!client) {
+      throw new Error(`Unknown address prefix ${prefix}`);
     }
-    /**
-     * Creates an Address instance from an address string.
-     *
-     * @param address - The address string to parse.
-     * @param clients - A Client instance or a record of Client instances keyed by prefix.
-     * @returns A promise that resolves to an Address instance.
-     *
-     * @throws Will throw an error if the address prefix is unknown or mismatched.
-     */
-    static async fromString(address, clients) {
-        const { prefix, format, payload } = (0, address_advanced_1.addressPayloadFromString)(address);
-        const client = clients[prefix] ?? clients;
-        if (!client) {
-            throw new Error(`Unknown address prefix ${prefix}`);
-        }
-        const expectedPrefix = client.addressPrefix;
-        if (expectedPrefix !== prefix) {
-            throw new Error(`Unknown address prefix ${prefix}, expected ${expectedPrefix}`);
-        }
-        return Address.from(await (0, address_advanced_1.addressFromPayload)(prefix, format, payload, client));
-    }
-    /**
-     * Creates an Address instance from a script and client.
-     *
-     * @param script - The script-like object.
-     * @param client - The client instance used to fetch the address prefix.
-     * @returns A promise that resolves to an Address instance.
-     */
-    static fromScript(script, client) {
-        return Address.from({ script, prefix: client.addressPrefix });
-    }
-    static async fromKnownScript(client, script, args) {
-        return Address.from({
-            script: await ckb_1.Script.fromKnownScript(client, script, args),
-            prefix: client.addressPrefix,
-        });
-    }
-    /**
-     * Converts the Address instance to a string.
-     *
-     * @returns The address as a string.
-     */
-    toString() {
-        const data = (0, bytes_1.bytesConcat)([address_advanced_1.AddressFormat.Full], (0, bytes_1.bytesFrom)(this.script.codeHash), (0, ckb_1.hashTypeToBytes)(this.script.hashType), (0, bytes_1.bytesFrom)(this.script.args));
-        return bech32_1.bech32m.encode(this.prefix, bech32_1.bech32m.toWords(data), address_advanced_1.ADDRESS_BECH32_LIMIT);
+    const expectedPrefix = client.addressPrefix;
+    if (expectedPrefix !== prefix) {
+      throw new Error(
+        `Unknown address prefix ${prefix}, expected ${expectedPrefix}`,
+      );
     }
+    return Address.from(
+      await (0, address_advanced_1.addressFromPayload)(
+        prefix,
+        format,
+        payload,
+        client,
+      ),
+    );
+  }
+  /**
+   * Creates an Address instance from a script and client.
+   *
+   * @param script - The script-like object.
+   * @param client - The client instance used to fetch the address prefix.
+   * @returns A promise that resolves to an Address instance.
+   */
+  static fromScript(script, client) {
+    return Address.from({ script, prefix: client.addressPrefix });
+  }
+  static async fromKnownScript(client, script, args) {
+    return Address.from({
+      script: await ckb_1.Script.fromKnownScript(client, script, args),
+      prefix: client.addressPrefix,
+    });
+  }
+  /**
+   * Converts the Address instance to a string.
+   *
+   * @returns The address as a string.
+   */
+  toString() {
+    const data = (0, bytes_1.bytesConcat)(
+      [address_advanced_1.AddressFormat.Full],
+      (0, bytes_1.bytesFrom)(this.script.codeHash),
+      (0, ckb_1.hashTypeToBytes)(this.script.hashType),
+      (0, bytes_1.bytesFrom)(this.script.args),
+    );
+    return bech32_1.bech32m.encode(
+      this.prefix,
+      bech32_1.bech32m.toWords(data),
+      address_advanced_1.ADDRESS_BECH32_LIMIT,
+    );
+  }
 }
 exports.Address = Address;

package/dist.commonjs/advanced.d.ts

@@ -1,3 +1,3 @@
 export * from "./advancedBarrel";
 export * as cccA from "./advancedBarrel";
-//# sourceMappingURL=advanced.d.ts.map
+//# sourceMappingURL=advanced.d.ts.map