@ckb-ccc/core 0.0.4 → 0.0.5-alpha.0

package/src/fixedPoint/index.test.ts

@@ -0,0 +1,55 @@
+import { fixedPointFrom, fixedPointToString } from ".";
+
+describe("fixedPointToString", () => {
+  const cases: [bigint, string, number?][] = [
+    [0n, "0"],
+    [1n, "0.00000001"],
+    [100000000n, "1"],
+    [1000000000n, "10"],
+    [1010100000n, "10.101"],
+    [11n, "1.1", 1],
+    [0n, "0", 1],
+    [1n, "1", 0],
+    [0n, "0", 0],
+  ];
+
+  cases.forEach(([i, o, decimals]) =>
+    test(`${i} with ${decimals ?? "default"} decimals = "${o}"`, () => {
+      expect(fixedPointToString(i, decimals)).toBe(o);
+    }),
+  );
+});
+
+describe("fixedPointFrom string", () => {
+  const cases: [string, bigint, number?][] = [
+    ["0", 0n],
+    ["0.00000001", 1n],
+    ["1", 100000000n],
+    ["10", 1000000000n],
+    ["10.101", 1010100000n],
+    ["1.1", 11n, 1],
+    ["0", 0n, 1],
+    ["1", 1n, 0],
+    ["0", 0n, 0],
+  ];
+
+  cases.forEach(([i, o, decimals]) =>
+    test(`"${i}" = ${o} with ${decimals ?? "default"} decimals `, () => {
+      expect(fixedPointFrom(i, decimals)).toBe(o);
+    }),
+  );
+});
+
+describe("fixedPointFrom number", () => {
+  const cases: [number, bigint, number?][] = [
+    [0.00000001, 1n],
+    [10.101, 1010100000n],
+    [1.1, 11n, 1],
+  ];
+
+  cases.forEach(([i, o, decimals]) =>
+    test(`${i} = ${o} with ${decimals ?? "default"} decimals `, () => {
+      expect(fixedPointFrom(i, decimals)).toBe(o);
+    }),
+  );
+});

package/src/fixedPoint/index.ts

@@ -28,6 +28,10 @@ export type FixedPointLike = bigint | string | number;
 
 export function fixedPointToString(val: FixedPointLike, decimals = 8): string {
   const str = fixedPointFrom(val).toString();
+  if (decimals === 0) {
+    return str;
+  }
+
   const l = str.length <= decimals ? "0" : str.slice(0, -decimals);
   const r = str.slice(-decimals).padStart(decimals, "0").replace(/0*$/, "");
   if (r === "") {
@@ -57,7 +61,9 @@ export function fixedPointFrom(val: FixedPointLike, decimals = 8): FixedPoint {
     return val;
   }
 
-  const [l, r] = val.toString().split(".");
+  const [l, r] = (
+    typeof val === "number" ? val.toFixed(decimals) : val.toString()
+  ).split(".");
   const lVal = BigInt(l.padEnd(l.length + decimals, "0"));
   if (r === undefined) {
     return lVal;

package/src/signer/btc/signerBtc.ts

@@ -6,7 +6,6 @@ import { Transaction, TransactionLike, WitnessArgs } from "../../ckb";
 import { KnownScript } from "../../client";
 import { HexLike, hexFrom } from "../../hex";
 import { numToBytes } from "../../num";
-import { getSignHashInfo, prepareSighashAllWitness } from "../helpers";
 import { Signer } from "../signer";
 
 /**
@@ -64,7 +63,11 @@ export abstract class SignerBtc extends Signer {
    */
   async prepareTransaction(txLike: TransactionLike): Promise<Transaction> {
     const { script } = await this.getRecommendedAddressObj();
-    return prepareSighashAllWitness(txLike, script, 85, this.client);
+    return Transaction.from(txLike).prepareSighashAllWitness(
+      script,
+      85,
+      this.client,
+    );
   }
 
   /**
@@ -76,7 +79,7 @@ export abstract class SignerBtc extends Signer {
   async signOnlyTransaction(txLike: TransactionLike): Promise<Transaction> {
     const tx = Transaction.from(txLike);
     const { script } = await this.getRecommendedAddressObj();
-    const info = await getSignHashInfo(tx, script, this.client);
+    const info = await tx.getSignHashInfo(script, this.client);
     if (!info) {
       return tx;
     }

package/src/signer/evm/signerEvm.ts

@@ -4,7 +4,6 @@ import { Script, Transaction, TransactionLike, WitnessArgs } from "../../ckb";
 import { KnownScript } from "../../client";
 import { hexFrom } from "../../hex";
 import { numToBytes } from "../../num";
-import { getSignHashInfo, prepareSighashAllWitness } from "../helpers";
 import { Signer } from "../signer";
 
 /**
@@ -69,7 +68,7 @@ export abstract class SignerEvm extends Signer {
     return addresses.reduce(
       (txPromise, { script }) =>
         txPromise.then((tx) =>
-          prepareSighashAllWitness(tx, script, 85, this.client),
+          tx.prepareSighashAllWitness(script, 85, this.client),
         ),
       Promise.resolve(Transaction.from(txLike)),
     );
@@ -108,7 +107,7 @@ export abstract class SignerEvm extends Signer {
     script: Script,
     messageTransformer: (hash: string) => BytesLike,
   ): Promise<Transaction> {
-    const info = await getSignHashInfo(tx, script, this.client);
+    const info = await tx.getSignHashInfo(script, this.client);
     if (!info) {
       return tx;
     }

package/src/signer/index.ts

@@ -1,5 +1,4 @@
 export * from "./btc";
 export * from "./ckb";
 export * from "./evm";
-export * from "./helpers";
 export * from "./signer";

package/src/signer/signer.ts

@@ -29,6 +29,13 @@ export abstract class Signer {
    */
   abstract connect(): Promise<void>;
 
+  /**
+   * Disconnects to the signer.
+   *
+   * @returns A promise that resolves when disconnected.
+   */
+  async disconnect(): Promise<void> {}
+
   /**
    * Check if the signer is connected.
    *
@@ -142,6 +149,7 @@ export abstract class Signer {
 export enum SignerType {
   EVM = "EVM",
   BTC = "BTC",
+  CKB = "CKB",
 }
 
 /**
@@ -149,6 +157,7 @@ export enum SignerType {
  */
 export class SignerInfo {
   constructor(
+    public name: string,
     public type: SignerType,
     public signer: Signer,
   ) {}

package/dist/signer/helpers.d.ts

@@ -1,40 +0,0 @@
-import { ScriptLike, Transaction, TransactionLike } from "../ckb";
-import { Client } from "../client";
-import { Hex } from "../hex";
-/**
- * Computes the signing hash information for a given transaction and script.
- *
- * @param txLike - The transaction to sign, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to an object containing the signing message and the witness position,
- *          or undefined if no matching input is found.
- *
- * @example
- * ```typescript
- * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike, client);
- * if (signHashInfo) {
- *   console.log(signHashInfo.message); // Outputs the signing message
- *   console.log(signHashInfo.position); // Outputs the witness position
- * }
- * ```
- */
-export declare function getSignHashInfo(txLike: TransactionLike, scriptLike: ScriptLike, client: Client): Promise<{
-    message: Hex;
-    position: number;
-} | undefined>;
-/**
- * Prepare dummy witness for sighash all method
- *
- * @param txLike - The transaction to prepare, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to the prepared transaction
- *
- * @example
- * ```typescript
- * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
- * ```
- */
-export declare function prepareSighashAllWitness(txLike: TransactionLike, scriptLike: ScriptLike, lockLen: number, client: Client): Promise<Transaction>;
-//# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/signer/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,WAAW,EACX,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,GAAG,EAAW,MAAM,QAAQ,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAuCzD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CA+BtB"}

package/dist/signer/helpers.js

@@ -1,91 +0,0 @@
-import { Script, Transaction, WitnessArgs, } from "../ckb";
-import { Hasher } from "../hasher";
-import { hexFrom } from "../hex";
-/**
- * Computes the signing hash information for a given transaction and script.
- *
- * @param txLike - The transaction to sign, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to an object containing the signing message and the witness position,
- *          or undefined if no matching input is found.
- *
- * @example
- * ```typescript
- * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike, client);
- * if (signHashInfo) {
- *   console.log(signHashInfo.message); // Outputs the signing message
- *   console.log(signHashInfo.position); // Outputs the witness position
- * }
- * ```
- */
-export async function getSignHashInfo(txLike, scriptLike, client) {
-    const tx = Transaction.from(txLike);
-    const script = Script.from(scriptLike);
-    let position = -1;
-    const hasher = new Hasher();
-    hasher.update(tx.hash());
-    for (let i = 0; i < tx.witnesses.length; i += 1) {
-        if (tx.inputs[i]) {
-            const input = await tx.inputs[i].completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw Error("Unable to resolve inputs info");
-            }
-            if (!script.eq(input.cellOutput.lock)) {
-                continue;
-            }
-            if (position === -1) {
-                position = i;
-            }
-        }
-        if (position === -1) {
-            return undefined;
-        }
-        Transaction.hashWitnessToHasher(tx.witnesses[i], hasher);
-    }
-    if (position === -1) {
-        return undefined;
-    }
-    return {
-        message: hasher.digest(),
-        position,
-    };
-}
-/**
- * Prepare dummy witness for sighash all method
- *
- * @param txLike - The transaction to prepare, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to the prepared transaction
- *
- * @example
- * ```typescript
- * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
- * ```
- */
-export async function prepareSighashAllWitness(txLike, scriptLike, lockLen, client) {
-    const tx = Transaction.from(txLike);
-    const script = Script.from(scriptLike);
-    let position = -1;
-    for (let i = 0; i < tx.inputs.length; i += 1) {
-        const input = await tx.inputs[i].completeExtraInfos(client);
-        if (!input.cellOutput) {
-            throw Error("Unable to resolve inputs info");
-        }
-        if (script.eq(input.cellOutput.lock)) {
-            position = i;
-            break;
-        }
-    }
-    if (position === -1) {
-        return tx;
-    }
-    const rawWitness = tx.witnesses[position];
-    const witness = (rawWitness ?? "0x") !== "0x"
-        ? WitnessArgs.fromBytes(rawWitness)
-        : WitnessArgs.from({});
-    witness.lock = hexFrom(Array.from(new Array(lockLen), () => 0));
-    tx.witnesses[position] = hexFrom(witness.toBytes());
-    return tx;
-}

package/dist.commonjs/signer/helpers.d.ts

@@ -1,40 +0,0 @@
-import { ScriptLike, Transaction, TransactionLike } from "../ckb";
-import { Client } from "../client";
-import { Hex } from "../hex";
-/**
- * Computes the signing hash information for a given transaction and script.
- *
- * @param txLike - The transaction to sign, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to an object containing the signing message and the witness position,
- *          or undefined if no matching input is found.
- *
- * @example
- * ```typescript
- * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike, client);
- * if (signHashInfo) {
- *   console.log(signHashInfo.message); // Outputs the signing message
- *   console.log(signHashInfo.position); // Outputs the witness position
- * }
- * ```
- */
-export declare function getSignHashInfo(txLike: TransactionLike, scriptLike: ScriptLike, client: Client): Promise<{
-    message: Hex;
-    position: number;
-} | undefined>;
-/**
- * Prepare dummy witness for sighash all method
- *
- * @param txLike - The transaction to prepare, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to the prepared transaction
- *
- * @example
- * ```typescript
- * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
- * ```
- */
-export declare function prepareSighashAllWitness(txLike: TransactionLike, scriptLike: ScriptLike, lockLen: number, client: Client): Promise<Transaction>;
-//# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/signer/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,WAAW,EACX,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,GAAG,EAAW,MAAM,QAAQ,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAuCzD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CA+BtB"}

package/dist.commonjs/signer/helpers.js

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareSighashAllWitness = exports.getSignHashInfo = void 0;
-const ckb_1 = require("../ckb");
-const hasher_1 = require("../hasher");
-const hex_1 = require("../hex");
-/**
- * Computes the signing hash information for a given transaction and script.
- *
- * @param txLike - The transaction to sign, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to an object containing the signing message and the witness position,
- *          or undefined if no matching input is found.
- *
- * @example
- * ```typescript
- * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike, client);
- * if (signHashInfo) {
- *   console.log(signHashInfo.message); // Outputs the signing message
- *   console.log(signHashInfo.position); // Outputs the witness position
- * }
- * ```
- */
-async function getSignHashInfo(txLike, scriptLike, client) {
-    const tx = ckb_1.Transaction.from(txLike);
-    const script = ckb_1.Script.from(scriptLike);
-    let position = -1;
-    const hasher = new hasher_1.Hasher();
-    hasher.update(tx.hash());
-    for (let i = 0; i < tx.witnesses.length; i += 1) {
-        if (tx.inputs[i]) {
-            const input = await tx.inputs[i].completeExtraInfos(client);
-            if (!input.cellOutput) {
-                throw Error("Unable to resolve inputs info");
-            }
-            if (!script.eq(input.cellOutput.lock)) {
-                continue;
-            }
-            if (position === -1) {
-                position = i;
-            }
-        }
-        if (position === -1) {
-            return undefined;
-        }
-        ckb_1.Transaction.hashWitnessToHasher(tx.witnesses[i], hasher);
-    }
-    if (position === -1) {
-        return undefined;
-    }
-    return {
-        message: hasher.digest(),
-        position,
-    };
-}
-exports.getSignHashInfo = getSignHashInfo;
-/**
- * Prepare dummy witness for sighash all method
- *
- * @param txLike - The transaction to prepare, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to the prepared transaction
- *
- * @example
- * ```typescript
- * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
- * ```
- */
-async function prepareSighashAllWitness(txLike, scriptLike, lockLen, client) {
-    const tx = ckb_1.Transaction.from(txLike);
-    const script = ckb_1.Script.from(scriptLike);
-    let position = -1;
-    for (let i = 0; i < tx.inputs.length; i += 1) {
-        const input = await tx.inputs[i].completeExtraInfos(client);
-        if (!input.cellOutput) {
-            throw Error("Unable to resolve inputs info");
-        }
-        if (script.eq(input.cellOutput.lock)) {
-            position = i;
-            break;
-        }
-    }
-    if (position === -1) {
-        return tx;
-    }
-    const rawWitness = tx.witnesses[position];
-    const witness = (rawWitness ?? "0x") !== "0x"
-        ? ckb_1.WitnessArgs.fromBytes(rawWitness)
-        : ckb_1.WitnessArgs.from({});
-    witness.lock = (0, hex_1.hexFrom)(Array.from(new Array(lockLen), () => 0));
-    tx.witnesses[position] = (0, hex_1.hexFrom)(witness.toBytes());
-    return tx;
-}
-exports.prepareSighashAllWitness = prepareSighashAllWitness;

package/src/signer/helpers.ts

@@ -1,124 +0,0 @@
-import {
-  Script,
-  ScriptLike,
-  Transaction,
-  TransactionLike,
-  WitnessArgs,
-} from "../ckb";
-import { Client } from "../client";
-import { Hasher } from "../hasher";
-import { Hex, hexFrom } from "../hex";
-
-/**
- * Computes the signing hash information for a given transaction and script.
- *
- * @param txLike - The transaction to sign, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to an object containing the signing message and the witness position,
- *          or undefined if no matching input is found.
- *
- * @example
- * ```typescript
- * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike, client);
- * if (signHashInfo) {
- *   console.log(signHashInfo.message); // Outputs the signing message
- *   console.log(signHashInfo.position); // Outputs the witness position
- * }
- * ```
- */
-export async function getSignHashInfo(
-  txLike: TransactionLike,
-  scriptLike: ScriptLike,
-  client: Client,
-): Promise<{ message: Hex; position: number } | undefined> {
-  const tx = Transaction.from(txLike);
-  const script = Script.from(scriptLike);
-  let position = -1;
-  const hasher = new Hasher();
-  hasher.update(tx.hash());
-
-  for (let i = 0; i < tx.witnesses.length; i += 1) {
-    if (tx.inputs[i]) {
-      const input = await tx.inputs[i].completeExtraInfos(client);
-
-      if (!input.cellOutput) {
-        throw Error("Unable to resolve inputs info");
-      }
-
-      if (!script.eq(input.cellOutput.lock)) {
-        continue;
-      }
-
-      if (position === -1) {
-        position = i;
-      }
-    }
-
-    if (position === -1) {
-      return undefined;
-    }
-
-    Transaction.hashWitnessToHasher(tx.witnesses[i], hasher);
-  }
-
-  if (position === -1) {
-    return undefined;
-  }
-
-  return {
-    message: hasher.digest(),
-    position,
-  };
-}
-
-/**
- * Prepare dummy witness for sighash all method
- *
- * @param txLike - The transaction to prepare, represented as a TransactionLike object.
- * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
- * @param client - The client for complete extra infos in the transaction.
- * @returns A promise that resolves to the prepared transaction
- *
- * @example
- * ```typescript
- * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
- * ```
- */
-export async function prepareSighashAllWitness(
-  txLike: TransactionLike,
-  scriptLike: ScriptLike,
-  lockLen: number,
-  client: Client,
-): Promise<Transaction> {
-  const tx = Transaction.from(txLike);
-  const script = Script.from(scriptLike);
-
-  let position = -1;
-
-  for (let i = 0; i < tx.inputs.length; i += 1) {
-    const input = await tx.inputs[i].completeExtraInfos(client);
-
-    if (!input.cellOutput) {
-      throw Error("Unable to resolve inputs info");
-    }
-
-    if (script.eq(input.cellOutput.lock)) {
-      position = i;
-      break;
-    }
-  }
-  if (position === -1) {
-    return tx;
-  }
-
-  const rawWitness = tx.witnesses[position];
-  const witness =
-    (rawWitness ?? "0x") !== "0x"
-      ? WitnessArgs.fromBytes(rawWitness)
-      : WitnessArgs.from({});
-  witness.lock = hexFrom(Array.from(new Array(lockLen), () => 0));
-  tx.witnesses[position] = hexFrom(witness.toBytes());
-
-  return tx;
-}

package/tsconfig.base.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2020",
-    "incremental": true,
-    "allowJs": true,
-    "importHelpers": false,
-    "declaration": true,
-    "declarationMap": true,
-    "experimentalDecorators": true,
-    "useDefineForClassFields": false,
-    "esModuleInterop": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "strictBindCallApply": true,
-    "strictNullChecks": true,
-    "alwaysStrict": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"]
-}

package/tsconfig.commonjs.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "outDir": "./dist.commonjs"
-  }
-}