@ckb-ccc/core 0.1.0-alpha.7 → 0.1.0

package/dist.commonjs/signer/signer/index.js

@@ -1,15 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignerInfo = exports.Signer = exports.Signature = exports.SignerType = exports.SignerSignType = void 0;
-const index_js_1 = require("../btc/index.js");
-const verifyCkbSecp256k1_js_1 = require("../ckb/verifyCkbSecp256k1.js");
-const verifyJoyId_js_1 = require("../ckb/verifyJoyId.js");
-const verify_js_1 = require("../evm/verify.js");
-const verify_js_2 = require("../nostr/verify.js");
+import { verifyMessageBtcEcdsa } from "../btc/index.js";
+import { verifyMessageCkbSecp256k1 } from "../ckb/verifyCkbSecp256k1.js";
+import { verifyMessageJoyId } from "../ckb/verifyJoyId.js";
+import { verifyMessageDogeEcdsa } from "../doge/verify.js";
+import { verifyMessageEvmPersonal } from "../evm/verify.js";
+import { verifyMessageNostrEvent } from "../nostr/verify.js";
 /**
  * @public
  */
-var SignerSignType;
+export var SignerSignType;
 (function (SignerSignType) {
     SignerSignType["Unknown"] = "Unknown";
     SignerSignType["BtcEcdsa"] = "BtcEcdsa";
@@ -17,35 +15,36 @@ var SignerSignType;
     SignerSignType["JoyId"] = "JoyId";
     SignerSignType["NostrEvent"] = "NostrEvent";
     SignerSignType["CkbSecp256k1"] = "CkbSecp256k1";
-})(SignerSignType || (exports.SignerSignType = SignerSignType = {}));
+    SignerSignType["DogeEcdsa"] = "DogeEcdsa";
+})(SignerSignType || (SignerSignType = {}));
 /**
  * An enumeration of signer display types in wallet.
  * @public
  */
-var SignerType;
+export var SignerType;
 (function (SignerType) {
     SignerType["EVM"] = "EVM";
     SignerType["BTC"] = "BTC";
     SignerType["CKB"] = "CKB";
     SignerType["Nostr"] = "Nostr";
-})(SignerType || (exports.SignerType = SignerType = {}));
+    SignerType["Doge"] = "Doge";
+})(SignerType || (SignerType = {}));
 /**
  * @public
  */
-class Signature {
+export class Signature {
     constructor(signature, identity, signType) {
         this.signature = signature;
         this.identity = identity;
         this.signType = signType;
     }
 }
-exports.Signature = Signature;
 /**
  * An abstract class representing a generic signer.
  * This class provides methods to connect, get addresses, and sign transactions.
  * @public
  */
-class Signer {
+export class Signer {
     constructor(client_) {
         this.client_ = client_;
     }
@@ -68,15 +67,17 @@ class Signer {
     static async verifyMessage(message, signature) {
         switch (signature.signType) {
             case SignerSignType.EvmPersonal:
-                return (0, verify_js_1.verifyMessageEvmPersonal)(message, signature.signature, signature.identity);
+                return verifyMessageEvmPersonal(message, signature.signature, signature.identity);
             case SignerSignType.BtcEcdsa:
-                return (0, index_js_1.verifyMessageBtcEcdsa)(message, signature.signature, signature.identity);
+                return verifyMessageBtcEcdsa(message, signature.signature, signature.identity);
             case SignerSignType.JoyId:
-                return (0, verifyJoyId_js_1.verifyMessageJoyId)(message, signature.signature, signature.identity);
+                return verifyMessageJoyId(message, signature.signature, signature.identity);
             case SignerSignType.NostrEvent:
-                return (0, verify_js_2.verifyMessageNostrEvent)(message, signature.signature, signature.identity);
+                return verifyMessageNostrEvent(message, signature.signature, signature.identity);
             case SignerSignType.CkbSecp256k1:
-                return (0, verifyCkbSecp256k1_js_1.verifyMessageCkbSecp256k1)(message, signature.signature, signature.identity);
+                return verifyMessageCkbSecp256k1(message, signature.signature, signature.identity);
+            case SignerSignType.DogeEcdsa:
+                return verifyMessageDogeEcdsa(message, signature.signature, signature.identity);
             case SignerSignType.Unknown:
                 throw new Error("Unknown signer sign type");
         }
@@ -261,15 +262,13 @@ class Signer {
         throw Error("Signer.signOnlyTransaction not implemented");
     }
 }
-exports.Signer = Signer;
 /**
  * A class representing information about a signer, including its type and the signer instance.
  * @public
  */
-class SignerInfo {
+export class SignerInfo {
     constructor(name, signer) {
         this.name = name;
         this.signer = signer;
     }
 }
-exports.SignerInfo = SignerInfo;

package/dist.commonjs/utils/index.js

@@ -1,10 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apply = apply;
-exports.reduceAsync = reduceAsync;
-exports.sleep = sleep;
-exports.isWebview = isWebview;
-const index_js_1 = require("../num/index.js");
+import { numFrom } from "../num/index.js";
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
  * @public
@@ -13,7 +7,7 @@ const index_js_1 = require("../num/index.js");
  * @param value - The value to be transformed.
  * @returns If the value is empty, it becomes undefined. Otherwise it will be transformed.
  */
-function apply(transformer, value) {
+export function apply(transformer, value) {
     if (value == null) {
         return undefined;
     }
@@ -28,7 +22,7 @@ function apply(transformer, value) {
  * @param init - The initial value.
  * @returns The accumulated result.
  */
-async function reduceAsync(values, accumulator, init) {
+export async function reduceAsync(values, accumulator, init) {
     if (init === undefined) {
         if (values.length === 0) {
             throw new TypeError("Reduce of empty array with no initial value");
@@ -38,12 +32,12 @@ async function reduceAsync(values, accumulator, init) {
     }
     return values.reduce((current, b, i, array) => current.then((v) => Promise.resolve(accumulator(v, b, i, array)).then((r) => r ?? v)), Promise.resolve(init));
 }
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, Number((0, index_js_1.numFrom)(ms))));
+export function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, Number(numFrom(ms))));
 }
 /**
  * @public
  */
-function isWebview(userAgent) {
+export function isWebview(userAgent) {
     return /webview|wv|ip((?!.*Safari)|(?=.*like Safari))/i.test(userAgent);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/core",
-  "version": "0.1.0-alpha.7",
+  "version": "0.1.0",
   "description": "Core of CCC - CKBer's Codebase",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -10,6 +10,7 @@
     "type": "git",
     "url": "git://github.com/ckb-devrel/ccc.git"
   },
+  "type": "module",
   "main": "./dist.commonjs/index.js",
   "module": "./dist/index.js",
   "exports": {
@@ -59,6 +60,7 @@
     "abort-controller": "^3.0.0",
     "bech32": "^2.0.0",
     "bitcoinjs-message": "^2.2.0",
+    "bs58check": "^4.0.0",
     "buffer": "^6.0.3",
     "cross-fetch": "^4.0.0",
     "ethers": "^6.13.1",

package/src/ckb/transactionLumos.ts

@@ -1,4 +1,5 @@
-import { CellDepLike, CellOutputLike, HexLike, OutPointLike } from "../barrel";
+import { CellDepLike, CellOutputLike, OutPointLike } from "../ckb/index.js";
+import { HexLike } from "../hex/index.js";
 
 export interface LumosTransactionSkeletonType {
   cellDeps: {

package/src/client/client.ts

@@ -517,7 +517,7 @@ export abstract class Client {
   async waitTransaction(
     txHash: HexLike,
     confirmations: number = 0,
-    timeout: number = 30000,
+    timeout: number = 60000,
     interval: number = 2000,
   ): Promise<ClientTransactionResponse | undefined> {
     const startTime = Date.now();

package/src/signer/btc/signerBtc.ts

@@ -1,5 +1,3 @@
-import { ripemd160 } from "@noble/hashes/ripemd160";
-import { sha256 } from "@noble/hashes/sha256";
 import { Address } from "../../address/index.js";
 import { bytesConcat, bytesFrom } from "../../bytes/index.js";
 import { Transaction, TransactionLike, WitnessArgs } from "../../ckb/index.js";
@@ -7,6 +5,7 @@ import { KnownScript } from "../../client/index.js";
 import { HexLike, hexFrom } from "../../hex/index.js";
 import { numToBytes } from "../../num/index.js";
 import { Signer, SignerSignType, SignerType } from "../signer/index.js";
+import { btcEcdsaPublicKeyHash } from "./verify.js";
 
 /**
  * An abstract class extending the Signer class for Bitcoin-like signing operations.
@@ -62,7 +61,7 @@ export abstract class SignerBtc extends Signer {
    */
   async getAddressObjs(): Promise<Address[]> {
     const publicKey = await this.getBtcPublicKey();
-    const hash = ripemd160(sha256(bytesFrom(publicKey)));
+    const hash = btcEcdsaPublicKeyHash(publicKey);
 
     return [
       await Address.fromKnownScript(

package/src/signer/btc/verify.ts

@@ -1,7 +1,36 @@
 import { secp256k1 } from "@noble/curves/secp256k1";
+import { ripemd160 } from "@noble/hashes/ripemd160";
+import { sha256 } from "@noble/hashes/sha256";
 import { magicHash } from "bitcoinjs-message";
-import { BytesLike, bytesFrom } from "../../bytes/index.js";
-import { hexFrom } from "../../hex/index.js";
+import bs58check from "bs58check";
+import { Bytes, BytesLike, bytesConcat, bytesFrom } from "../../bytes/index.js";
+import { Hex, hexFrom } from "../../hex/index.js";
+
+/**
+ * @public
+ */
+export function btcEcdsaPublicKeyHash(publicKey: BytesLike): Bytes {
+  return ripemd160(sha256(bytesFrom(publicKey)));
+}
+
+/**
+ * @public
+ */
+export function btcP2pkhAddressFromPublicKey(
+  publicKey: BytesLike,
+  network: number,
+): string {
+  return bs58check.encode(
+    bytesConcat([network], btcEcdsaPublicKeyHash(publicKey)),
+  );
+}
+
+/**
+ * @public
+ */
+export function btcPublicKeyFromP2pkhAddress(address: string): Hex {
+  return hexFrom(bs58check.decode(address).slice(1));
+}
 
 /**
  * @public

package/src/signer/doge/index.ts

@@ -0,0 +1,4 @@
+export * from "./signerDoge.js";
+export * from "./signerDogeAddressReadonly.js";
+export * from "./signerDogePrivateKey.js";
+export * from "./verify.js";

package/src/signer/doge/signerDoge.ts

@@ -0,0 +1,116 @@
+import bs58check from "bs58check";
+import { Address } from "../../address/index.js";
+import { bytesConcat, bytesFrom } from "../../bytes/index.js";
+import { Transaction, TransactionLike, WitnessArgs } from "../../ckb/index.js";
+import { KnownScript } from "../../client/index.js";
+import { hexFrom } from "../../hex/index.js";
+import { numToBytes } from "../../num/index.js";
+import { Signer, SignerSignType, SignerType } from "../signer/index.js";
+
+/**
+ * An abstract class extending the Signer class for Dogecoin-like signing operations.
+ * This class provides methods to get Doge account, public key, and internal address,
+ * as well as signing transactions.
+ * @public
+ */
+export abstract class SignerDoge extends Signer {
+  get type(): SignerType {
+    return SignerType.Doge;
+  }
+
+  get signType(): SignerSignType {
+    return SignerSignType.DogeEcdsa;
+  }
+
+  /**
+   * Gets the Doge address associated with the signer.
+   *
+   * @returns A promise that resolves to a string representing the Doge account.
+   */
+  abstract getDogeAddress(): Promise<string>;
+
+  /**
+   * Gets the internal address, which is the Doge account in this case.
+   *
+   * @returns A promise that resolves to a string representing the internal address.
+   */
+  async getInternalAddress(): Promise<string> {
+    return this.getDogeAddress();
+  }
+
+  /**
+   * Gets the identity, which is the Doge address in this case.
+   *
+   * @returns A promise that resolves to a string representing the identity
+   */
+  async getIdentity(): Promise<string> {
+    return this.getDogeAddress();
+  }
+
+  /**
+   * Gets an array of Address objects representing the known script addresses for the signer.
+   *
+   * @returns A promise that resolves to an array of Address objects.
+   */
+  async getAddressObjs(): Promise<Address[]> {
+    const hash = bs58check.decode(await this.getDogeAddress()).slice(1);
+
+    return [
+      await Address.fromKnownScript(
+        this.client,
+        KnownScript.OmniLock,
+        hexFrom([0x05, ...hash, 0x00]),
+      ),
+    ];
+  }
+
+  /**
+   * prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
+   *
+   * @param txLike - The transaction to prepare, represented as a TransactionLike object.
+   * @returns A promise that resolves to the prepared Transaction object.
+   */
+  async prepareTransaction(txLike: TransactionLike): Promise<Transaction> {
+    const tx = Transaction.from(txLike);
+    const { script } = await this.getRecommendedAddressObj();
+    await tx.addCellDepsOfKnownScripts(this.client, KnownScript.OmniLock);
+    await tx.prepareSighashAllWitness(script, 85, this.client);
+    return tx;
+  }
+
+  /**
+   * Signs a transaction without modifying it.
+   *
+   * @param txLike - The transaction to sign, represented as a TransactionLike object.
+   * @returns A promise that resolves to a signed Transaction object.
+   */
+  async signOnlyTransaction(txLike: TransactionLike): Promise<Transaction> {
+    const tx = Transaction.from(txLike);
+    const { script } = await this.getRecommendedAddressObj();
+    const info = await tx.getSignHashInfo(script, this.client);
+    if (!info) {
+      return tx;
+    }
+
+    const signature = bytesFrom(
+      await this.signMessageRaw(info.message.slice(2)),
+      "base64",
+    );
+    signature[0] = 31 + ((signature[0] - 27) % 4);
+
+    const witness = WitnessArgs.fromBytes(tx.witnesses[info.position]);
+    witness.lock = hexFrom(
+      bytesConcat(
+        numToBytes(5 * 4 + signature.length, 4),
+        numToBytes(4 * 4, 4),
+        numToBytes(5 * 4 + signature.length, 4),
+        numToBytes(5 * 4 + signature.length, 4),
+        numToBytes(signature.length, 4),
+        signature,
+      ),
+    );
+
+    tx.setWitnessArgsAt(info.position, witness);
+    return tx;
+  }
+}

package/src/signer/doge/signerDogeAddressReadonly.ts

@@ -0,0 +1,52 @@
+import { Client } from "../../client/index.js";
+import { SignerDoge } from "./signerDoge.js";
+
+/**
+ * A class extending SignerDoge that provides read-only access to a Doge address.
+ * This class does not support signing operations.
+ * @public
+ */
+export class SignerDogeAddressReadonly extends SignerDoge {
+  /**
+   * Creates an instance of SignerDogeAddressReadonly.
+   *
+   * @param client - The client instance used for communication.
+   * @param address - The Doge address with the signer.
+   */
+  constructor(
+    client: Client,
+    private readonly address: string,
+  ) {
+    super(client);
+  }
+
+  /**
+   * Connects to the client. This implementation does nothing as the class is read-only.
+   *
+   * @returns A promise that resolves when the connection is complete.
+   */
+  async connect(): Promise<void> {}
+
+  /**
+   * Check if the signer is connected.
+   *
+   * @returns A promise that resolves the connection status.
+   */
+  async isConnected(): Promise<boolean> {
+    return true;
+  }
+
+  /**
+   * Gets the Doge address associated with the signer.
+   *
+   * @returns A promise that resolves to a string representing the Doge address.
+   *
+   * @example
+   * ```typescript
+   * const account = await signer.getDogeAddress(); // Outputs the Doge address
+   * ```
+   */
+  async getDogeAddress(): Promise<string> {
+    return this.address;
+  }
+}

package/src/signer/doge/signerDogePrivateKey.ts

@@ -0,0 +1,97 @@
+import { secp256k1 } from "@noble/curves/secp256k1";
+import { magicHash } from "bitcoinjs-message";
+import {
+  Bytes,
+  bytesConcat,
+  bytesFrom,
+  BytesLike,
+  bytesTo,
+} from "../../bytes/index.js";
+import { Client } from "../../client/index.js";
+import { Hex, hexFrom } from "../../hex/index.js";
+import { btcP2pkhAddressFromPublicKey } from "../btc/verify.js";
+import { SignerDoge } from "./signerDoge.js";
+
+/**
+ * A class extending SignerDoge that provides access to a Doge address.
+ * @public
+ */
+export class SignerDogePrivateKey extends SignerDoge {
+  private readonly privateKey: Bytes;
+
+  /**
+   * Creates an instance of SignerDogePrivateKey
+   *
+   * @param client - The client instance used for communication.
+   * @param privateKey - The Doge private key with the signer.
+   */
+  constructor(
+    client: Client,
+    privateKey: BytesLike,
+    public readonly dogeNetwork = 0x1e,
+  ) {
+    super(client);
+    this.privateKey = bytesFrom(privateKey);
+    if (this.privateKey.length !== 32) {
+      throw new Error("Private key must be 32 bytes!");
+    }
+  }
+
+  /**
+   * Connects to the client. This implementation does nothing as the class is always connected.
+   *
+   * @returns A promise that resolves when the connection is complete.
+   */
+  async connect(): Promise<void> {}
+
+  /**
+   * Check if the signer is connected.
+   *
+   * @returns A promise that resolves the connection status.
+   */
+  async isConnected(): Promise<boolean> {
+    return true;
+  }
+
+  async getDogePublicKey(): Promise<Hex> {
+    return hexFrom(secp256k1.getPublicKey(this.privateKey, true));
+  }
+
+  /**
+   * Gets the Doge address associated with the signer.
+   *
+   * @returns A promise that resolves to a string representing the Doge address.
+   *
+   * @example
+   * ```typescript
+   * const account = await signer.getDogeAddress(); // Outputs the Doge address
+   * ```
+   */
+  async getDogeAddress(): Promise<string> {
+    return btcP2pkhAddressFromPublicKey(
+      await this.getDogePublicKey(),
+      this.dogeNetwork,
+    );
+  }
+
+  /**
+   * Signs a message and returns signature only.
+   *
+   * @param msg - The message to sign, as a string or BytesLike object.
+   * @returns A promise that resolves to the signature as a string.
+   * @throws Will throw an error if not implemented.
+   */
+  async signMessageRaw(msg: string | BytesLike): Promise<string> {
+    const challenge = typeof msg === "string" ? msg : hexFrom(msg).slice(2);
+
+    const signature = secp256k1.sign(
+      magicHash(challenge, "\x19Dogecoin Signed Message:\n"),
+      this.privateKey,
+    );
+
+    return bytesTo(
+      bytesConcat([31 + signature.recovery], signature.toCompactRawBytes()),
+      "base64",
+    );
+  }
+}

package/src/signer/doge/verify.ts

@@ -0,0 +1,38 @@
+import { secp256k1 } from "@noble/curves/secp256k1";
+import { magicHash } from "bitcoinjs-message";
+import { bytesFrom, BytesLike } from "../../bytes/index.js";
+import { hexFrom } from "../../hex/index.js";
+import {
+  btcEcdsaPublicKeyHash,
+  btcPublicKeyFromP2pkhAddress,
+} from "../btc/verify.js";
+
+/**
+ * @public
+ */
+export function verifyMessageDogeEcdsa(
+  message: string | BytesLike,
+  signature: string,
+  address: string,
+): boolean {
+  const challenge =
+    typeof message === "string" ? message : hexFrom(message).slice(2);
+  const [recoveryBit, ...rawSign] = bytesFrom(signature, "base64");
+
+  const sig = secp256k1.Signature.fromCompact(
+    hexFrom(rawSign).slice(2),
+  ).addRecoveryBit(recoveryBit - 31);
+
+  return (
+    btcPublicKeyFromP2pkhAddress(address) ===
+    hexFrom(
+      btcEcdsaPublicKeyHash(
+        sig
+          .recoverPublicKey(
+            magicHash(challenge, "\x19Dogecoin Signed Message:\n"),
+          )
+          .toHex(),
+      ),
+    )
+  );
+}

package/src/signer/index.ts

@@ -1,5 +1,6 @@
 export * from "./btc/index.js";
 export * from "./ckb/index.js";
+export * from "./doge/index.js";
 export * from "./dummy/index.js";
 export * from "./evm/index.js";
 export * from "./nostr/index.js";

package/src/signer/nostr/index.ts

@@ -1 +1,2 @@
 export * from "./signerNostr.js";
+export * from "./verify.js";

package/src/signer/signer/index.ts

@@ -12,6 +12,7 @@ import { Num } from "../../num/index.js";
 import { verifyMessageBtcEcdsa } from "../btc/index.js";
 import { verifyMessageCkbSecp256k1 } from "../ckb/verifyCkbSecp256k1.js";
 import { verifyMessageJoyId } from "../ckb/verifyJoyId.js";
+import { verifyMessageDogeEcdsa } from "../doge/verify.js";
 import { verifyMessageEvmPersonal } from "../evm/verify.js";
 import { verifyMessageNostrEvent } from "../nostr/verify.js";
 
@@ -25,6 +26,7 @@ export enum SignerSignType {
   JoyId = "JoyId",
   NostrEvent = "NostrEvent",
   CkbSecp256k1 = "CkbSecp256k1",
+  DogeEcdsa = "DogeEcdsa",
 }
 
 /**
@@ -36,6 +38,7 @@ export enum SignerType {
   BTC = "BTC",
   CKB = "CKB",
   Nostr = "Nostr",
+  Doge = "Doge",
 }
 
 /**
@@ -141,6 +144,12 @@ export abstract class Signer {
           signature.signature,
           signature.identity,
         );
+      case SignerSignType.DogeEcdsa:
+        return verifyMessageDogeEcdsa(
+          message,
+          signature.signature,
+          signature.identity,
+        );
       case SignerSignType.Unknown:
         throw new Error("Unknown signer sign type");
     }