@ckb-ccc/core 0.0.4-alpha.1 → 0.0.4-alpha.11

package/dist/signer/signer.d.ts

@@ -1,34 +1,125 @@
 import { Address } from "../address";
 import { BytesLike } from "../bytes";
-import { Transaction } from "../ckb";
+import { Transaction, TransactionLike } from "../ckb";
 import { Client } from "../client";
 import { Hex } from "../hex";
+/**
+ * An abstract class representing a generic signer.
+ * This class provides methods to connect, get addresses, and sign transactions.
+ */
 export declare abstract class Signer {
-    readonly client: Client;
-    constructor(client: Client);
+    protected client_: Client;
+    constructor(client_: Client);
+    get client(): Client;
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    abstract replaceClient(client: Client): Promise<Signer>;
+    /**
+     * Connects to the signer.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     */
     abstract connect(): Promise<void>;
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    abstract isConnected(): Promise<boolean>;
+    /**
+     * Gets the internal address associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     */
     abstract getInternalAddress(): Promise<string>;
+    /**
+     * Gets an array of Address objects associated with the signer.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     */
     abstract getAddressObjs(): Promise<Address[]>;
+    /**
+     * Gets the recommended Address object for the signer.
+     *
+     * @param _preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended Address object.
+     */
     getRecommendedAddressObj(_preference?: unknown): Promise<Address>;
+    /**
+     * Gets the recommended address for the signer as a string.
+     *
+     * @param preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended address as a string.
+     */
     getRecommendedAddress(preference?: unknown): Promise<string>;
+    /**
+     * Gets an array of addresses associated with the signer as strings.
+     *
+     * @returns A promise that resolves to an array of addresses as strings.
+     */
     getAddresses(): Promise<string[]>;
+    /**
+     * Signs a message. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The message to sign, as a string or BytesLike object.
+     * @returns A promise that resolves to the signed message as a string.
+     * @throws Will throw an error if not implemented.
+     */
     signMessage(_: string | BytesLike): Promise<string>;
-    sendTransaction(tx: Transaction): Promise<Hex>;
-    signTransaction(tx: Transaction): Promise<Transaction>;
-    signOnlyTransaction(_: Transaction): Promise<Transaction>;
+    /**
+     * Sends a transaction after signing it.
+     *
+     * @param tx - The transaction to send, represented as a TransactionLike object.
+     * @returns A promise that resolves to the transaction hash as a Hex string.
+     */
+    sendTransaction(tx: TransactionLike): Promise<Hex>;
+    /**
+     * Signs a transaction.
+     *
+     * @param tx - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     */
+    signTransaction(tx: TransactionLike): Promise<Transaction>;
+    /**
+     * prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to prepare, represented as a TransactionLike object.
+     * @returns A promise that resolves to the prepared Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
+    prepareTransaction(_: TransactionLike): Promise<Transaction>;
+    /**
+     * Signs a transaction without sending it. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
+    signOnlyTransaction(_: TransactionLike): Promise<Transaction>;
 }
+/**
+ * An enumeration of signer types.
+ */
 export declare enum SignerType {
     EVM = "EVM",
     BTC = "BTC"
 }
+/**
+ * A class representing information about a signer, including its type and the signer instance.
+ */
 export declare class SignerInfo {
     type: SignerType;
     signer: Signer;
     constructor(type: SignerType, signer: Signer);
 }
+/**
+ * Represents a wallet with a name, icon, and an array of signer information.
+ */
 export type Wallet = {
     name: string;
     icon: string;
-    signers: SignerInfo[];
 };
 //# sourceMappingURL=signer.d.ts.map

package/dist/signer/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B,8BAAsB,MAAM;aACE,MAAM,EAAE,MAAM;gBAAd,MAAM,EAAE,MAAM;IAE1C,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAE9C,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IACvC,wBAAwB,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjE,qBAAqB,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAG5D,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAMvC,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7C,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAI5D,mBAAmB,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;CAG1D;AAED,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED,qBAAa,UAAU;IAEZ,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM;gBADd,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM;CAExB;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B;;;GAGG;AACH,8BAAsB,MAAM;IACd,SAAS,CAAC,OAAO,EAAE,MAAM;gBAAf,OAAO,EAAE,MAAM;IAErC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEvD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAExC;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAE7C;;;;;OAKG;IACG,wBAAwB,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE;;;;;OAKG;IACG,qBAAqB,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlE;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAMvC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAInD;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAKhE;;;;;;OAMG;IACH,kBAAkB,CAAC,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAI5D;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAG9D;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,qBAAa,UAAU;IAEZ,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM;gBADd,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM;CAExB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/signer/signer.js

@@ -1,34 +1,101 @@
+/**
+ * An abstract class representing a generic signer.
+ * This class provides methods to connect, get addresses, and sign transactions.
+ */
 export class Signer {
-    constructor(client) {
-        this.client = client;
+    constructor(client_) {
+        this.client_ = client_;
     }
+    get client() {
+        return this.client_;
+    }
+    /**
+     * Gets the recommended Address object for the signer.
+     *
+     * @param _preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended Address object.
+     */
     async getRecommendedAddressObj(_preference) {
         return (await this.getAddressObjs())[0];
     }
+    /**
+     * Gets the recommended address for the signer as a string.
+     *
+     * @param preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended address as a string.
+     */
     async getRecommendedAddress(preference) {
         return (await this.getRecommendedAddressObj(preference)).toString();
     }
+    /**
+     * Gets an array of addresses associated with the signer as strings.
+     *
+     * @returns A promise that resolves to an array of addresses as strings.
+     */
     async getAddresses() {
         return this.getAddressObjs().then((addresses) => addresses.map((address) => address.toString()));
     }
+    /**
+     * Signs a message. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The message to sign, as a string or BytesLike object.
+     * @returns A promise that resolves to the signed message as a string.
+     * @throws Will throw an error if not implemented.
+     */
     signMessage(_) {
         throw Error("Signer.signMessage not implemented");
     }
+    /**
+     * Sends a transaction after signing it.
+     *
+     * @param tx - The transaction to send, represented as a TransactionLike object.
+     * @returns A promise that resolves to the transaction hash as a Hex string.
+     */
     async sendTransaction(tx) {
         return this.client.sendTransaction(await this.signTransaction(tx));
     }
+    /**
+     * Signs a transaction.
+     *
+     * @param tx - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     */
     async signTransaction(tx) {
-        return this.signOnlyTransaction(tx);
+        const preparedTx = await this.prepareTransaction(tx);
+        return this.signOnlyTransaction(preparedTx);
+    }
+    /**
+     * prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to prepare, represented as a TransactionLike object.
+     * @returns A promise that resolves to the prepared Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
+    prepareTransaction(_) {
+        throw Error("Signer.prepareTransaction not implemented");
     }
+    /**
+     * Signs a transaction without sending it. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
     signOnlyTransaction(_) {
         throw Error("Signer.signOnlyTransaction not implemented");
     }
 }
+/**
+ * An enumeration of signer types.
+ */
 export var SignerType;
 (function (SignerType) {
     SignerType["EVM"] = "EVM";
     SignerType["BTC"] = "BTC";
 })(SignerType || (SignerType = {}));
+/**
+ * A class representing information about a signer, including its type and the signer instance.
+ */
 export class SignerInfo {
     constructor(type, signer) {
         this.type = type;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/core",
-  "version": "0.0.4-alpha.1",
+  "version": "0.0.4-alpha.11",
   "description": "Common Chains Connector Core",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -23,7 +23,6 @@
     "format": "prettier --write . && eslint --fix"
   },
   "devDependencies": {
-    "@ckb-lumos/helpers": "^0.22.2",
     "@eslint/js": "^9.1.1",
     "@types/blake2b": "^2.1.3",
     "eslint": "^9.1.0",
@@ -40,6 +39,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@ckb-lumos/helpers": "^0.22.2",
     "@noble/hashes": "^1.4.0",
     "abort-controller": "^3.0.0",
     "bech32": "^2.0.0",
@@ -47,5 +47,5 @@
     "buffer": "^6.0.3",
     "cross-fetch": "^4.0.0"
   },
-  "gitHead": "7dab1a1d6e3e380b26f43d0d0308bd4da1617029"
+  "gitHead": "db0297c0753349e2650d2845f42f546316078d5d"
 }

package/src/address/address.advanced.ts

@@ -1,8 +1,25 @@
 import { bech32, bech32m } from "bech32";
-import { Script, hashTypeFromBytes } from "../ckb";
+import { hashTypeFromBytes } from "../ckb";
 import { Client, KnownScript } from "../client";
 import { hexFrom } from "../hex";
-import { type Address } from "./index";
+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 function addressPayloadFromString(address: string): {
   prefix: string;
@@ -37,12 +54,31 @@ export function addressPayloadFromString(address: string): {
   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: string,
   format: AddressFormat,
   payload: number[],
   client: Client,
-): Promise<Address> {
+): Promise<AddressLike> {
   if (format === AddressFormat.Full) {
     if (payload.length < 32 + 1) {
       throw new Error(
@@ -51,11 +87,11 @@ export async function addressFromPayload(
     }
 
     return {
-      script: Script.from({
-        codeHash: hexFrom(payload.slice(0, 32)),
+      script: {
+        codeHash: payload.slice(0, 32),
         hashType: hashTypeFromBytes(payload.slice(32, 33)),
-        args: hexFrom(payload.slice(33)),
-      }),
+        args: payload.slice(33),
+      },
       prefix,
     };
   }
@@ -68,11 +104,11 @@ export async function addressFromPayload(
     }
 
     return {
-      script: Script.from({
-        codeHash: hexFrom(payload.slice(0, 32)),
+      script: {
+        codeHash: payload.slice(0, 32),
         hashType: "data",
-        args: hexFrom(payload.slice(32)),
-      }),
+        args: payload.slice(32),
+      },
       prefix,
     };
   }
@@ -85,11 +121,11 @@ export async function addressFromPayload(
     }
 
     return {
-      script: Script.from({
-        codeHash: hexFrom(payload.slice(0, 32)),
+      script: {
+        codeHash: payload.slice(0, 32),
         hashType: "type",
-        args: hexFrom(payload.slice(32)),
-      }),
+        args: payload.slice(32),
+      },
       prefix,
     };
   }
@@ -112,10 +148,10 @@ export async function addressFromPayload(
   }
 
   return {
-    script: Script.from({
+    script: {
       ...(await client.getKnownScript(script)),
-      args: hexFrom(payload.slice(1)),
-    }),
+      args: payload.slice(1),
+    },
     prefix,
   };
 }

package/src/address/index.ts

@@ -14,12 +14,30 @@ export type AddressLike = {
   script: ScriptLike;
   prefix: string;
 };
+
+/**
+ * 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(
     public script: Script,
     public 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 {
     if (address instanceof Address) {
       return address;
@@ -28,6 +46,16 @@ export class 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: string,
     clients: Client | Record<string, Client>,
@@ -45,14 +73,24 @@ export class Address {
       );
     }
 
-    return addressFromPayload(prefix, format, payload, client);
+    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: ScriptLike,
     client: Client,
   ): Promise<Address> {
-    return new Address(Script.from(script), await client.getAddressPrefix());
+    return Address.from({ script, prefix: await client.getAddressPrefix() });
   }
 
   static async fromKnownScript(
@@ -60,15 +98,21 @@ export class Address {
     args: HexLike,
     client: Client,
   ) {
-    return new Address(
-      Script.from({
+    return Address.from({
+      script: {
         ...(await client.getKnownScript(script)),
         args,
-      }),
-      await client.getAddressPrefix(),
-    );
+      },
+      prefix: await client.getAddressPrefix(),
+    });
   }
 
+  /**
+   * Converts the Address instance to a string.
+   *
+   * @returns The address as a string.
+   */
+
   toString(): string {
     const data = bytesConcat(
       [AddressFormat.Full],

package/src/bytes/advanced.ts

@@ -1,10 +1,13 @@
+/**
+ * Represents the possible encoding formats for converting bytes.
+ */
 export type BytesFromEncoding =
-  | "utf8"
-  | "utf16le"
-  | "latin1"
-  | "base64"
-  | "base64url"
-  | "hex"
-  | "ascii"
-  | "binary"
-  | "ucs2";
+  | "utf8" // UTF-8 encoding
+  | "utf16le" // UTF-16 Little Endian encoding
+  | "latin1" // Latin-1 (ISO-8859-1) encoding
+  | "base64" // Base64 encoding
+  | "base64url" // Base64 URL encoding
+  | "hex" // Hexadecimal encoding
+  | "ascii" // ASCII encoding
+  | "binary" // Binary encoding
+  | "ucs2"; // UCS-2 (alias of UTF-16LE) encoding

package/src/bytes/index.ts

@@ -4,6 +4,24 @@ 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 function bytesConcat(...args: BytesLike[]): Bytes {
   return new Uint8Array(
     args.reduce((acc: number[], v) => {
@@ -13,10 +31,52 @@ export 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 function bytesTo(val: BytesLike, encoding: BytesFromEncoding): string {
   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: BytesLike,
   encoding?: BytesFromEncoding,