@ckb-ccc/core 0.0.4-alpha.2 → 0.0.4-alpha.4

package/README.md

@@ -1,12 +1,17 @@
-<h1 align="center" style="font-size: 64px;">
-  CCC
+<h1 align="center" style="font-size: 48px;">
+  CCC Core
 </h1>
 
 <p align="center">
-  <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">
-  <img alt="Demo" src="https://img.shields.io/website?url=https%3A%2F%2Fckbccc-demo.vercel.app%2F&label=Demo">
+  <a href="https://www.npmjs.com/package/@ckb-ccc/core"><img
+    alt="NPM Version" src="https://img.shields.io/npm/v/%40ckb-ccc%2Fcore"
+  /></a>
+  <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
+    alt="Demo" src="https://img.shields.io/website?url=https%3A%2F%2Fckbccc-demo.vercel.app%2F&label=Demo"
+  /></a>
 </p>
 
 <p align="center">

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

@@ -1,10 +1,44 @@
 import { Client } from "../client";
 import { type AddressLike } from "./index";
+/**
+ * Parses an address string into an address information object.
+ *
+ * @param address - The address string to parse.
+ * @returns An object containing the address prefix, address format, and payload array.
+ *
+ * @throws Will throw an error if the address format is unknown.
+ *
+ * @example
+ * ```typescript
+ * const addressInfo = addressPayloadFromString("ckt1112139193129");
+ * console.log(addressInfo.prefix); // Outputs the address prefix
+ * console.log(addressInfo.format); // Outputs the address format
+ * console.log(addressInfo.payload); // Outputs the payload array
+ * ```
+ */
 export declare function addressPayloadFromString(address: string): {
     prefix: string;
     format: AddressFormat;
     payload: number[];
 };
+/**
+ * Converts an address payload into an address-like object.
+ *
+ * @param prefix - The address prefix.
+ * @param format - The format of the address, as defined by the AddressFormat enum.
+ * @param payload - The payload array containing the address data.
+ * @param client - The client instance used to fetch known scripts.
+ * @returns A promise that resolves to an AddressLike object.
+ *
+ * @throws Will throw an error if the payload length is insufficient or if the script type is unknown.
+ *
+ * @example
+ * ```typescript
+ * const address = await addressFromPayload("ckt", AddressFormat.Full, [/* payload data *\/], client);
+ * console.log(address.script); // Outputs the script object
+ * console.log(address.prefix); // Outputs the address prefix
+ * ```
+ */
 export declare function addressFromPayload(prefix: string, format: AddressFormat, payload: number[], client: Client): Promise<AddressLike>;
 export declare enum AddressFormat {
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"address.advanced.d.ts","sourceRoot":"","sources":["../../src/address/address.advanced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAe,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CA2BA;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CA4EtB;AAED,oBAAY,aAAa;IACvB;;OAEG;IACH,IAAI,IAAO;IACX;;;OAGG;IACH,KAAK,IAAO;IACZ;;;OAGG;IACH,QAAQ,IAAO;IACf;;;OAGG;IACH,QAAQ,IAAO;CAChB;AAED,eAAO,MAAM,oBAAoB,OAAO,CAAC"}
+{"version":3,"file":"address.advanced.d.ts","sourceRoot":"","sources":["../../src/address/address.advanced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAe,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;;;;;;;;;;;GAeG;AAEH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CA2BA;AAED;;;;;;;;;;;;;;;;;GAiBG;AAEH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CA4EtB;AAED,oBAAY,aAAa;IACvB;;OAEG;IACH,IAAI,IAAO;IACX;;;OAGG;IACH,KAAK,IAAO;IACZ;;;OAGG;IACH,QAAQ,IAAO;IACf;;;OAGG;IACH,QAAQ,IAAO;CAChB;AAED,eAAO,MAAM,oBAAoB,OAAO,CAAC"}

package/dist/address/address.advanced.js

@@ -2,6 +2,22 @@ import { bech32, bech32m } from "bech32";
 import { hashTypeFromBytes } from "../ckb";
 import { KnownScript } from "../client";
 import { hexFrom } from "../hex";
+/**
+ * Parses an address string into an address information object.
+ *
+ * @param address - The address string to parse.
+ * @returns An object containing the address prefix, address format, and payload array.
+ *
+ * @throws Will throw an error if the address format is unknown.
+ *
+ * @example
+ * ```typescript
+ * const addressInfo = addressPayloadFromString("ckt1112139193129");
+ * console.log(addressInfo.prefix); // Outputs the address prefix
+ * console.log(addressInfo.format); // Outputs the address format
+ * console.log(addressInfo.payload); // Outputs the payload array
+ * ```
+ */
 export function addressPayloadFromString(address) {
     // Try parse full format address
     {
@@ -25,6 +41,24 @@ export function addressPayloadFromString(address) {
     }
     throw Error(`Unknown address format ${address}`);
 }
+/**
+ * Converts an address payload into an address-like object.
+ *
+ * @param prefix - The address prefix.
+ * @param format - The format of the address, as defined by the AddressFormat enum.
+ * @param payload - The payload array containing the address data.
+ * @param client - The client instance used to fetch known scripts.
+ * @returns A promise that resolves to an AddressLike object.
+ *
+ * @throws Will throw an error if the payload length is insufficient or if the script type is unknown.
+ *
+ * @example
+ * ```typescript
+ * const address = await addressFromPayload("ckt", AddressFormat.Full, [/* payload data *\/], client);
+ * console.log(address.script); // Outputs the script object
+ * console.log(address.prefix); // Outputs the address prefix
+ * ```
+ */
 export async function addressFromPayload(prefix, format, payload, client) {
     if (format === AddressFormat.Full) {
         if (payload.length < 32 + 1) {

package/dist/address/index.d.ts

@@ -5,14 +5,50 @@ export type AddressLike = {
     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): Promise<Address>;
     static fromKnownScript(script: KnownScript, args: HexLike, client: Client): Promise<Address>;
+    /**
+     * Converts the Address instance to a string.
+     *
+     * @returns The address as a string.
+     */
     toString(): string;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/address/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAmB,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAQjC,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,qBAAa,OAAO;IAET,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;gBADd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM;IAGvB,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;WAQ7B,UAAU,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,OAAO,CAAC,OAAO,CAAC;WAmBN,UAAU,CACrB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,OAAO,CAAC;WAIN,eAAe,CAC1B,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,MAAM;IAWhB,QAAQ,IAAI,MAAM;CAcnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/address/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAmB,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAQjC,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AAEH,qBAAa,OAAO;IAQT,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IARvB;;;;;OAKG;gBAEM,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM;IAGvB;;;;;OAKG;IAEH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;IAQ1C;;;;;;;;OAQG;WAEU,UAAU,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;;;OAMG;WAEU,UAAU,CACrB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,OAAO,CAAC;WAIN,eAAe,CAC1B,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,MAAM;IAWhB;;;;OAIG;IAEH,QAAQ,IAAI,MAAM;CAcnB"}

package/dist/address/index.js

@@ -2,17 +2,41 @@ import { bech32m } from "bech32";
 import { bytesConcat, bytesFrom } from "../bytes";
 import { Script, hashTypeToBytes } from "../ckb";
 import { ADDRESS_BECH32_LIMIT, AddressFormat, addressFromPayload, addressPayloadFromString, } from "./address.advanced";
+/**
+ * Represents a ckb address with associated script and prefix.
+ */
 export 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 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(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 } = addressPayloadFromString(address);
         const client = clients[prefix] ?? clients;
@@ -25,6 +49,13 @@ export class Address {
         }
         return Address.from(await 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 async fromScript(script, client) {
         return Address.from({ script, prefix: await client.getAddressPrefix() });
     }
@@ -37,6 +68,11 @@ export class Address {
             prefix: await client.getAddressPrefix(),
         });
     }
+    /**
+     * Converts the Address instance to a string.
+     *
+     * @returns The address as a string.
+     */
     toString() {
         const data = bytesConcat([AddressFormat.Full], bytesFrom(this.script.codeHash), hashTypeToBytes(this.script.hashType), bytesFrom(this.script.args));
         return bech32m.encode(this.prefix, bech32m.toWords(data), ADDRESS_BECH32_LIMIT);

package/dist/bytes/advanced.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Represents the possible encoding formats for converting bytes.
+ */
 export type BytesFromEncoding = "utf8" | "utf16le" | "latin1" | "base64" | "base64url" | "hex" | "ascii" | "binary" | "ucs2";
 //# sourceMappingURL=advanced.d.ts.map

package/dist/bytes/advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../../src/bytes/advanced.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,CAAC"}
+{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../../src/bytes/advanced.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,CAAC"}

package/dist/bytes/index.d.ts

@@ -1,7 +1,64 @@
 import { BytesFromEncoding } from "./advanced";
 export type Bytes = Uint8Array;
 export type BytesLike = string | Uint8Array | ArrayBuffer | number[];
+/**
+ * Concatenates multiple byte-like arrays into a single byte array.
+ *
+ * @param args - The byte-like arrays to concatenate.
+ * @returns A Uint8Array containing the concatenated bytes.
+ *
+ * @example
+ * ```typescript
+ * const concatenatedBytes = bytesConcat(
+ *   new Uint8Array([1, 2]),
+ *   new Uint8Array([3, 4]),
+ *   "hello",
+ *   [5, 6, 7]
+ * );
+ * console.log(concatenatedBytes); // Outputs Uint8Array [1, 2, 3, 4, /* bytes of "hello" *\/, 5, 6, 7]
+ * ```
+ */
 export declare function bytesConcat(...args: BytesLike[]): Bytes;
+/**
+ * Converts a byte-like value to a string using the specified encoding.
+ *
+ * @param val - The byte-like value to convert.
+ * @param encoding - The encoding to use for the conversion, as defined by the BytesFromEncoding type.
+ * @returns A string representing the encoded bytes.
+ *
+ * @example
+ * ```typescript
+ * const encodedString = bytesTo(new Uint8Array([104, 101, 108, 108, 111]), "utf8");
+ * console.log(encodedString); // Outputs "hello"
+ *
+ * const base64String = bytesTo(new Uint8Array([104, 101, 108, 108, 111]), "base64");
+ * console.log(base64String); // Outputs "aGVsbG8="
+ * ```
+ */
 export declare function bytesTo(val: BytesLike, encoding: BytesFromEncoding): string;
+/**
+ * Converts various types of byte-like values to a Uint8Array.
+ *
+ * @param bytes - The byte-like value to convert. It can be a string, Uint8Array, ArrayBuffer, or number array.
+ * @param encoding - Optional encoding to use if the input is a string. Defaults to hexadecimal if not specified.
+ * @returns A Uint8Array representing the input bytes.
+ *
+ * @throws Will throw an error if the input bytes are invalid or out of range.
+ *
+ * @example
+ * ```typescript
+ * const bytes1 = bytesFrom(new Uint8Array([1, 2, 3]));
+ * console.log(bytes1); // Outputs Uint8Array [1, 2, 3]
+ *
+ * const bytes2 = bytesFrom("68656c6c6f", "hex");
+ * console.log(bytes2); // Outputs Uint8Array [104, 101, 108, 108, 111]
+ *
+ * const bytes3 = bytesFrom("hello", "utf8");
+ * console.log(bytes3); // Outputs Uint8Array [104, 101, 108, 108, 111]
+ *
+ * const bytes4 = bytesFrom([1, 2, 255]);
+ * console.log(bytes4); // Outputs Uint8Array [1, 2, 255]
+ * ```
+ */
 export declare function bytesFrom(bytes: BytesLike, encoding?: BytesFromEncoding): Bytes;
 //# sourceMappingURL=index.d.ts.map

package/dist/bytes/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bytes/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC;AAC/B,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,EAAE,CAAC;AAErE,wBAAgB,WAAW,CAAC,GAAG,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAOvD;AAED,wBAAgB,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,GAAG,MAAM,CAE3E;AAED,wBAAgB,SAAS,CACvB,KAAK,EAAE,SAAS,EAChB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,KAAK,CA2BP"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bytes/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC;AAC/B,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,EAAE,CAAC;AAErE;;;;;;;;;;;;;;;;GAgBG;AAEH,wBAAgB,WAAW,CAAC,GAAG,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAOvD;AAED;;;;;;;;;;;;;;;GAeG;AAEH,wBAAgB,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,GAAG,MAAM,CAE3E;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,wBAAgB,SAAS,CACvB,KAAK,EAAE,SAAS,EAChB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,KAAK,CA2BP"}

package/dist/bytes/index.js

@@ -1,13 +1,70 @@
 import { Buffer } from "buffer/";
+/**
+ * Concatenates multiple byte-like arrays into a single byte array.
+ *
+ * @param args - The byte-like arrays to concatenate.
+ * @returns A Uint8Array containing the concatenated bytes.
+ *
+ * @example
+ * ```typescript
+ * const concatenatedBytes = bytesConcat(
+ *   new Uint8Array([1, 2]),
+ *   new Uint8Array([3, 4]),
+ *   "hello",
+ *   [5, 6, 7]
+ * );
+ * console.log(concatenatedBytes); // Outputs Uint8Array [1, 2, 3, 4, /* bytes of "hello" *\/, 5, 6, 7]
+ * ```
+ */
 export function bytesConcat(...args) {
     return new Uint8Array(args.reduce((acc, v) => {
         acc.push(...bytesFrom(v));
         return acc;
     }, []));
 }
+/**
+ * Converts a byte-like value to a string using the specified encoding.
+ *
+ * @param val - The byte-like value to convert.
+ * @param encoding - The encoding to use for the conversion, as defined by the BytesFromEncoding type.
+ * @returns A string representing the encoded bytes.
+ *
+ * @example
+ * ```typescript
+ * const encodedString = bytesTo(new Uint8Array([104, 101, 108, 108, 111]), "utf8");
+ * console.log(encodedString); // Outputs "hello"
+ *
+ * const base64String = bytesTo(new Uint8Array([104, 101, 108, 108, 111]), "base64");
+ * console.log(base64String); // Outputs "aGVsbG8="
+ * ```
+ */
 export function bytesTo(val, encoding) {
     return Buffer.from(bytesFrom(val)).toString(encoding);
 }
+/**
+ * Converts various types of byte-like values to a Uint8Array.
+ *
+ * @param bytes - The byte-like value to convert. It can be a string, Uint8Array, ArrayBuffer, or number array.
+ * @param encoding - Optional encoding to use if the input is a string. Defaults to hexadecimal if not specified.
+ * @returns A Uint8Array representing the input bytes.
+ *
+ * @throws Will throw an error if the input bytes are invalid or out of range.
+ *
+ * @example
+ * ```typescript
+ * const bytes1 = bytesFrom(new Uint8Array([1, 2, 3]));
+ * console.log(bytes1); // Outputs Uint8Array [1, 2, 3]
+ *
+ * const bytes2 = bytesFrom("68656c6c6f", "hex");
+ * console.log(bytes2); // Outputs Uint8Array [104, 101, 108, 108, 111]
+ *
+ * const bytes3 = bytesFrom("hello", "utf8");
+ * console.log(bytes3); // Outputs Uint8Array [104, 101, 108, 108, 111]
+ *
+ * const bytes4 = bytesFrom([1, 2, 255]);
+ * console.log(bytes4); // Outputs Uint8Array [1, 2, 255]
+ * ```
+ */
 export function bytesFrom(bytes, encoding) {
     if (bytes instanceof Uint8Array) {
         return bytes;

package/dist/ckb/script.d.ts

@@ -3,8 +3,46 @@ import { Hex } from "../hex";
 import * as mol from "./molecule.advanced";
 export type HashTypeLike = string | number | bigint;
 export type HashType = "type" | "data" | "data1" | "data2";
+/**
+ * Converts a HashTypeLike value to a HashType.
+ *
+ * @param val - The value to convert, which can be a string, number, or bigint.
+ * @returns The corresponding HashType.
+ *
+ * @throws Will throw an error if the input value is not a valid hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashType = hashTypeFrom(1); // Outputs "data"
+ * const hashType = hashTypeFrom("type"); // Outputs "type"
+ * ```
+ */
 export declare function hashTypeFrom(val: HashTypeLike): HashType;
+/**
+ * Converts a HashTypeLike value to its corresponding byte representation.
+ *
+ * @param hashType - The hash type value to convert.
+ * @returns A Uint8Array containing the byte representation of the hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashTypeBytes = hashTypeToBytes("type"); // Outputs Uint8Array [0]
+ * ```
+ */
 export declare function hashTypeToBytes(hashType: HashTypeLike): Bytes;
+/**
+ * Converts a byte-like value to a HashType.
+ *
+ * @param bytes - The byte-like value to convert.
+ * @returns The corresponding HashType.
+ *
+ * @throws Will throw an error if the input bytes do not correspond to a valid hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashType = hashTypeFromBytes(new Uint8Array([0])); // Outputs "type"
+ * ```
+ */
 export declare function hashTypeFromBytes(bytes: BytesLike): HashType;
 export type ScriptLike = {
     codeHash: BytesLike;
@@ -15,15 +53,74 @@ export declare class Script {
     codeHash: Hex;
     hashType: HashType;
     args: Hex;
+    /**
+     * Creates an instance of Script.
+     *
+     * @param codeHash - The code hash of the script.
+     * @param hashType - The hash type of the script.
+     * @param args - The arguments for the script.
+     */
     constructor(codeHash: Hex, hashType: HashType, args: Hex);
+    /**
+     * Creates a Script instance from a ScriptLike object.
+     *
+     * @param script - A ScriptLike object or an instance of Script.
+     * @returns A Script instance.
+     *
+     * @example
+     * ```typescript
+     * const script = Script.from({
+     *   codeHash: "0x1234...",
+     *   hashType: "type",
+     *   args: "0xabcd..."
+     * });
+     * ```
+     */
     static from(script: ScriptLike): Script;
+    /**
+     * Converts the Script instance to molecule data format.
+     *
+     * @returns An object representing the script in molecule data format.
+     */
     _toMolData(): {
         codeHash: Uint8Array;
         hashType: Uint8Array;
         args: Uint8Array;
     };
+    /**
+     * Converts the Script instance to bytes.
+     *
+     * @returns A Uint8Array containing the script bytes.
+     *
+     * @example
+     * ```typescript
+     * const scriptBytes = script.toBytes();
+     * ```
+     */
     toBytes(): Bytes;
+    /**
+     * Creates a Script instance from a byte-like value or molecule Script.
+     *
+     * @param bytes - The byte-like value or molecule Script to convert.
+     * @returns A Script instance.
+     *
+     * @example
+     * ```typescript
+     * const script = Script.fromBytes(new Uint8Array([/* script bytes *\/]));
+     * ```
+     */
     static fromBytes(bytes: BytesLike | mol.Script): Script;
+    /**
+     * Compares the current Script instance with another ScriptLike object for equality.
+     *
+     * @param val - The ScriptLike object to compare with.
+     * @returns True if the scripts are equal, otherwise false.
+     *
+     * @example
+     * ```typescript
+     * const isEqual = script.eq(anotherScript);
+     * ```
+     */
     eq(val: ScriptLike): boolean;
 }
 //# sourceMappingURL=script.d.ts.map

package/dist/ckb/script.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../src/ckb/script.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAa,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,GAAG,EAAW,MAAM,QAAQ,CAAC;AACtC,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAO3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AACpD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAC3D,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,QAAQ,CAmBxD;AACD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,YAAY,GAAG,KAAK,CAE7D;AACD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,CAE5D;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,YAAY,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF,qBAAa,MAAM;IAER,QAAQ,EAAE,GAAG;IACb,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,GAAG;gBAFT,QAAQ,EAAE,GAAG,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,GAAG;IAGlB,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAYvC,UAAU;;;;;IAQV,OAAO,IAAI,KAAK;IAIhB,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,GAAG,CAAC,MAAM,GAAG,MAAM;IAWvD,EAAE,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO;CAQ7B"}
+{"version":3,"file":"script.d.ts","sourceRoot":"","sources":["../../src/ckb/script.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAa,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,GAAG,EAAW,MAAM,QAAQ,CAAC;AACtC,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAO3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AACpD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAE3D;;;;;;;;;;;;;GAaG;AAEH,wBAAgB,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,QAAQ,CAmBxD;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,YAAY,GAAG,KAAK,CAE7D;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,CAE5D;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,YAAY,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF,qBAAa,MAAM;IAUR,QAAQ,EAAE,GAAG;IACb,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,GAAG;IAXlB;;;;;;OAMG;gBAGM,QAAQ,EAAE,GAAG,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,GAAG;IAGlB;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAYvC;;;;OAIG;IAEH,UAAU;;;;;IAQV;;;;;;;;;OASG;IAEH,OAAO,IAAI,KAAK;IAIhB;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,GAAG,CAAC,MAAM,GAAG,MAAM;IAWvD;;;;;;;;;;OAUG;IAEH,EAAE,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO;CAQ7B"}

package/dist/ckb/script.js

@@ -2,6 +2,20 @@ import { bytesFrom } from "../bytes";
 import { hexFrom } from "../hex";
 import * as mol from "./molecule.advanced";
 import { HASH_TYPES, HASH_TYPE_TO_NUM, NUM_TO_HASH_TYPE, } from "./script.advanced";
+/**
+ * Converts a HashTypeLike value to a HashType.
+ *
+ * @param val - The value to convert, which can be a string, number, or bigint.
+ * @returns The corresponding HashType.
+ *
+ * @throws Will throw an error if the input value is not a valid hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashType = hashTypeFrom(1); // Outputs "data"
+ * const hashType = hashTypeFrom("type"); // Outputs "type"
+ * ```
+ */
 export function hashTypeFrom(val) {
     const hashType = (() => {
         if (typeof val === "number") {
@@ -20,24 +34,75 @@ export function hashTypeFrom(val) {
     }
     return hashType;
 }
+/**
+ * Converts a HashTypeLike value to its corresponding byte representation.
+ *
+ * @param hashType - The hash type value to convert.
+ * @returns A Uint8Array containing the byte representation of the hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashTypeBytes = hashTypeToBytes("type"); // Outputs Uint8Array [0]
+ * ```
+ */
 export function hashTypeToBytes(hashType) {
     return bytesFrom([HASH_TYPE_TO_NUM[hashTypeFrom(hashType)]]);
 }
+/**
+ * Converts a byte-like value to a HashType.
+ *
+ * @param bytes - The byte-like value to convert.
+ * @returns The corresponding HashType.
+ *
+ * @throws Will throw an error if the input bytes do not correspond to a valid hash type.
+ *
+ * @example
+ * ```typescript
+ * const hashType = hashTypeFromBytes(new Uint8Array([0])); // Outputs "type"
+ * ```
+ */
 export function hashTypeFromBytes(bytes) {
     return NUM_TO_HASH_TYPE[bytesFrom(bytes)[0]];
 }
 export class Script {
+    /**
+     * Creates an instance of Script.
+     *
+     * @param codeHash - The code hash of the script.
+     * @param hashType - The hash type of the script.
+     * @param args - The arguments for the script.
+     */
     constructor(codeHash, hashType, args) {
         this.codeHash = codeHash;
         this.hashType = hashType;
         this.args = args;
     }
+    /**
+     * Creates a Script instance from a ScriptLike object.
+     *
+     * @param script - A ScriptLike object or an instance of Script.
+     * @returns A Script instance.
+     *
+     * @example
+     * ```typescript
+     * const script = Script.from({
+     *   codeHash: "0x1234...",
+     *   hashType: "type",
+     *   args: "0xabcd..."
+     * });
+     * ```
+     */
     static from(script) {
         if (script instanceof Script) {
             return script;
         }
         return new Script(hexFrom(script.codeHash), hashTypeFrom(script.hashType), hexFrom(script.args));
     }
+    /**
+     * Converts the Script instance to molecule data format.
+     *
+     * @returns An object representing the script in molecule data format.
+     */
     _toMolData() {
         return {
             codeHash: bytesFrom(this.codeHash),
@@ -45,13 +110,45 @@ export class Script {
             args: bytesFrom(this.args),
         };
     }
+    /**
+     * Converts the Script instance to bytes.
+     *
+     * @returns A Uint8Array containing the script bytes.
+     *
+     * @example
+     * ```typescript
+     * const scriptBytes = script.toBytes();
+     * ```
+     */
     toBytes() {
         return bytesFrom(mol.SerializeScript(this._toMolData()));
     }
+    /**
+     * Creates a Script instance from a byte-like value or molecule Script.
+     *
+     * @param bytes - The byte-like value or molecule Script to convert.
+     * @returns A Script instance.
+     *
+     * @example
+     * ```typescript
+     * const script = Script.fromBytes(new Uint8Array([/* script bytes *\/]));
+     * ```
+     */
     static fromBytes(bytes) {
         const view = bytes instanceof mol.Script ? bytes : new mol.Script(bytesFrom(bytes));
         return new Script(hexFrom(view.getCodeHash().raw()), hashTypeFromBytes([view.getHashType()]), hexFrom(view.getArgs().raw()));
     }
+    /**
+     * Compares the current Script instance with another ScriptLike object for equality.
+     *
+     * @param val - The ScriptLike object to compare with.
+     * @returns True if the scripts are equal, otherwise false.
+     *
+     * @example
+     * ```typescript
+     * const isEqual = script.eq(anotherScript);
+     * ```
+     */
     eq(val) {
         const script = Script.from(val);
         return (this.codeHash === script.codeHash &&