@haneullabs/haneul 0.1.0

package/dist/esm/jsonRpc/types/params.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/esm/keypairs/ed25519/ed25519-hd-key.d.ts

@@ -0,0 +1,8 @@
+type Hex = string;
+type Path = string;
+type Keys = {
+    key: Uint8Array;
+    chainCode: Uint8Array;
+};
+export declare const derivePath: (path: Path, seed: Hex, offset?: number) => Keys;
+export {};

package/dist/esm/keypairs/ed25519/ed25519-hd-key.js

@@ -0,0 +1,57 @@
+import { fromHex } from "@haneullabs/bcs";
+import { hmac } from "@noble/hashes/hmac";
+import { sha512 } from "@noble/hashes/sha512";
+const ED25519_CURVE = "ed25519 seed";
+const HARDENED_OFFSET = 2147483648;
+const pathRegex = new RegExp("^m(\\/[0-9]+')+$");
+const replaceDerive = (val) => val.replace("'", "");
+const getMasterKeyFromSeed = (seed) => {
+  const h = hmac.create(sha512, ED25519_CURVE);
+  const I = h.update(fromHex(seed)).digest();
+  const IL = I.slice(0, 32);
+  const IR = I.slice(32);
+  return {
+    key: IL,
+    chainCode: IR
+  };
+};
+const CKDPriv = ({ key, chainCode }, index) => {
+  const indexBuffer = new ArrayBuffer(4);
+  const cv = new DataView(indexBuffer);
+  cv.setUint32(0, index);
+  const data = new Uint8Array(1 + key.length + indexBuffer.byteLength);
+  data.set(new Uint8Array(1).fill(0));
+  data.set(key, 1);
+  data.set(new Uint8Array(indexBuffer, 0, indexBuffer.byteLength), key.length + 1);
+  const I = hmac.create(sha512, chainCode).update(data).digest();
+  const IL = I.slice(0, 32);
+  const IR = I.slice(32);
+  return {
+    key: IL,
+    chainCode: IR
+  };
+};
+const isValidPath = (path) => {
+  if (!pathRegex.test(path)) {
+    return false;
+  }
+  return !path.split("/").slice(1).map(replaceDerive).some(
+    isNaN
+    /* ts T_T*/
+  );
+};
+const derivePath = (path, seed, offset = HARDENED_OFFSET) => {
+  if (!isValidPath(path)) {
+    throw new Error("Invalid derivation path");
+  }
+  const { key, chainCode } = getMasterKeyFromSeed(seed);
+  const segments = path.split("/").slice(1).map(replaceDerive).map((el) => parseInt(el, 10));
+  return segments.reduce((parentKeys, segment) => CKDPriv(parentKeys, segment + offset), {
+    key,
+    chainCode
+  });
+};
+export {
+  derivePath
+};
+//# sourceMappingURL=ed25519-hd-key.js.map

package/dist/esm/keypairs/ed25519/ed25519-hd-key.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/keypairs/ed25519/ed25519-hd-key.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// This is adapted from https://github.com/alepop/ed25519-hd-key replacing create-hmac\n// with @noble/hashes to be browser compatible.\n\nimport { fromHex } from '@haneullabs/bcs';\nimport { hmac } from '@noble/hashes/hmac';\nimport { sha512 } from '@noble/hashes/sha512';\n\ntype Hex = string;\ntype Path = string;\n\ntype Keys = {\n\tkey: Uint8Array;\n\tchainCode: Uint8Array;\n};\n\nconst ED25519_CURVE = 'ed25519 seed';\nconst HARDENED_OFFSET = 0x80000000;\n\nconst pathRegex = new RegExp(\"^m(\\\\/[0-9]+')+$\");\n\nconst replaceDerive = (val: string): string => val.replace(\"'\", '');\n\nconst getMasterKeyFromSeed = (seed: Hex): Keys => {\n\tconst h = hmac.create(sha512, ED25519_CURVE);\n\tconst I = h.update(fromHex(seed)).digest();\n\tconst IL = I.slice(0, 32);\n\tconst IR = I.slice(32);\n\treturn {\n\t\tkey: IL,\n\t\tchainCode: IR,\n\t};\n};\n\nconst CKDPriv = ({ key, chainCode }: Keys, index: number): Keys => {\n\tconst indexBuffer = new ArrayBuffer(4);\n\tconst cv = new DataView(indexBuffer);\n\tcv.setUint32(0, index);\n\n\tconst data = new Uint8Array(1 + key.length + indexBuffer.byteLength);\n\tdata.set(new Uint8Array(1).fill(0));\n\tdata.set(key, 1);\n\tdata.set(new Uint8Array(indexBuffer, 0, indexBuffer.byteLength), key.length + 1);\n\n\tconst I = hmac.create(sha512, chainCode).update(data).digest();\n\tconst IL = I.slice(0, 32);\n\tconst IR = I.slice(32);\n\treturn {\n\t\tkey: IL,\n\t\tchainCode: IR,\n\t};\n};\n\nconst isValidPath = (path: string): boolean => {\n\tif (!pathRegex.test(path)) {\n\t\treturn false;\n\t}\n\treturn !path\n\t\t.split('/')\n\t\t.slice(1)\n\t\t.map(replaceDerive)\n\t\t.some(isNaN as any /* ts T_T*/);\n};\n\nexport const derivePath = (path: Path, seed: Hex, offset = HARDENED_OFFSET): Keys => {\n\tif (!isValidPath(path)) {\n\t\tthrow new Error('Invalid derivation path');\n\t}\n\n\tconst { key, chainCode } = getMasterKeyFromSeed(seed);\n\tconst segments = path\n\t\t.split('/')\n\t\t.slice(1)\n\t\t.map(replaceDerive)\n\t\t.map((el) => parseInt(el, 10));\n\n\treturn segments.reduce((parentKeys, segment) => CKDPriv(parentKeys, segment + offset), {\n\t\tkey,\n\t\tchainCode,\n\t});\n};\n"],
+  "mappings": "AAMA,SAAS,eAAe;AACxB,SAAS,YAAY;AACrB,SAAS,cAAc;AAUvB,MAAM,gBAAgB;AACtB,MAAM,kBAAkB;AAExB,MAAM,YAAY,IAAI,OAAO,kBAAkB;AAE/C,MAAM,gBAAgB,CAAC,QAAwB,IAAI,QAAQ,KAAK,EAAE;AAElE,MAAM,uBAAuB,CAAC,SAAoB;AACjD,QAAM,IAAI,KAAK,OAAO,QAAQ,aAAa;AAC3C,QAAM,IAAI,EAAE,OAAO,QAAQ,IAAI,CAAC,EAAE,OAAO;AACzC,QAAM,KAAK,EAAE,MAAM,GAAG,EAAE;AACxB,QAAM,KAAK,EAAE,MAAM,EAAE;AACrB,SAAO;AAAA,IACN,KAAK;AAAA,IACL,WAAW;AAAA,EACZ;AACD;AAEA,MAAM,UAAU,CAAC,EAAE,KAAK,UAAU,GAAS,UAAwB;AAClE,QAAM,cAAc,IAAI,YAAY,CAAC;AACrC,QAAM,KAAK,IAAI,SAAS,WAAW;AACnC,KAAG,UAAU,GAAG,KAAK;AAErB,QAAM,OAAO,IAAI,WAAW,IAAI,IAAI,SAAS,YAAY,UAAU;AACnE,OAAK,IAAI,IAAI,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;AAClC,OAAK,IAAI,KAAK,CAAC;AACf,OAAK,IAAI,IAAI,WAAW,aAAa,GAAG,YAAY,UAAU,GAAG,IAAI,SAAS,CAAC;AAE/E,QAAM,IAAI,KAAK,OAAO,QAAQ,SAAS,EAAE,OAAO,IAAI,EAAE,OAAO;AAC7D,QAAM,KAAK,EAAE,MAAM,GAAG,EAAE;AACxB,QAAM,KAAK,EAAE,MAAM,EAAE;AACrB,SAAO;AAAA,IACN,KAAK;AAAA,IACL,WAAW;AAAA,EACZ;AACD;AAEA,MAAM,cAAc,CAAC,SAA0B;AAC9C,MAAI,CAAC,UAAU,KAAK,IAAI,GAAG;AAC1B,WAAO;AAAA,EACR;AACA,SAAO,CAAC,KACN,MAAM,GAAG,EACT,MAAM,CAAC,EACP,IAAI,aAAa,EACjB;AAAA,IAAK;AAAA;AAAA,EAAwB;AAChC;AAEO,MAAM,aAAa,CAAC,MAAY,MAAW,SAAS,oBAA0B;AACpF,MAAI,CAAC,YAAY,IAAI,GAAG;AACvB,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC1C;AAEA,QAAM,EAAE,KAAK,UAAU,IAAI,qBAAqB,IAAI;AACpD,QAAM,WAAW,KACf,MAAM,GAAG,EACT,MAAM,CAAC,EACP,IAAI,aAAa,EACjB,IAAI,CAAC,OAAO,SAAS,IAAI,EAAE,CAAC;AAE9B,SAAO,SAAS,OAAO,CAAC,YAAY,YAAY,QAAQ,YAAY,UAAU,MAAM,GAAG;AAAA,IACtF;AAAA,IACA;AAAA,EACD,CAAC;AACF;",
+  "names": []
+}

package/dist/esm/keypairs/ed25519/index.d.ts

@@ -0,0 +1,2 @@
+export { DEFAULT_ED25519_DERIVATION_PATH, Ed25519Keypair, type Ed25519KeypairData, } from './keypair.js';
+export { Ed25519PublicKey } from './publickey.js';

package/dist/esm/keypairs/ed25519/index.js

@@ -0,0 +1,11 @@
+import {
+  DEFAULT_ED25519_DERIVATION_PATH,
+  Ed25519Keypair
+} from "./keypair.js";
+import { Ed25519PublicKey } from "./publickey.js";
+export {
+  DEFAULT_ED25519_DERIVATION_PATH,
+  Ed25519Keypair,
+  Ed25519PublicKey
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/keypairs/ed25519/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/keypairs/ed25519/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nexport {\n\tDEFAULT_ED25519_DERIVATION_PATH,\n\tEd25519Keypair,\n\ttype Ed25519KeypairData,\n} from './keypair.js';\nexport { Ed25519PublicKey } from './publickey.js';\n"],
+  "mappings": "AAGA;AAAA,EACC;AAAA,EACA;AAAA,OAEM;AACP,SAAS,wBAAwB;",
+  "names": []
+}

package/dist/esm/keypairs/ed25519/keypair.d.ts

@@ -0,0 +1,74 @@
+import { Keypair } from '../../cryptography/keypair.js';
+import type { SignatureScheme } from '../../cryptography/signature-scheme.js';
+import { Ed25519PublicKey } from './publickey.js';
+export declare const DEFAULT_ED25519_DERIVATION_PATH = "m/44'/784'/0'/0'/0'";
+/**
+ * Ed25519 Keypair data. The publickey is the 32-byte public key and
+ * the secretkey is 64-byte, where the first 32 bytes is the secret
+ * key and the last 32 bytes is the public key.
+ */
+export interface Ed25519KeypairData {
+    publicKey: Uint8Array;
+    secretKey: Uint8Array;
+}
+/**
+ * An Ed25519 Keypair used for signing transactions.
+ */
+export declare class Ed25519Keypair extends Keypair {
+    private keypair;
+    /**
+     * Create a new Ed25519 keypair instance.
+     * Generate random keypair if no {@link Ed25519Keypair} is provided.
+     *
+     * @param keypair Ed25519 keypair
+     */
+    constructor(keypair?: Ed25519KeypairData);
+    /**
+     * Get the key scheme of the keypair ED25519
+     */
+    getKeyScheme(): SignatureScheme;
+    /**
+     * Generate a new random Ed25519 keypair
+     */
+    static generate(): Ed25519Keypair;
+    /**
+     * Create a Ed25519 keypair from a raw secret key byte array, also known as seed.
+     * This is NOT the private scalar which is result of hashing and bit clamping of
+     * the raw secret key.
+     *
+     * @throws error if the provided secret key is invalid and validation is not skipped.
+     *
+     * @param secretKey secret key as a byte array or Bech32 secret key string
+     * @param options: skip secret key validation
+     */
+    static fromSecretKey(secretKey: Uint8Array | string, options?: {
+        skipValidation?: boolean;
+    }): Ed25519Keypair;
+    /**
+     * The public key for this Ed25519 keypair
+     */
+    getPublicKey(): Ed25519PublicKey;
+    /**
+     * The Bech32 secret key string for this Ed25519 keypair
+     */
+    getSecretKey(): string;
+    /**
+     * Return the signature for the provided data using Ed25519.
+     */
+    sign(data: Uint8Array): Promise<Uint8Array<ArrayBuffer>>;
+    /**
+     * Derive Ed25519 keypair from mnemonics and path. The mnemonics must be normalized
+     * and validated against the english wordlist.
+     *
+     * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must
+     * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.
+     */
+    static deriveKeypair(mnemonics: string, path?: string): Ed25519Keypair;
+    /**
+     * Derive Ed25519 keypair from mnemonicSeed and path.
+     *
+     * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must
+     * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.
+     */
+    static deriveKeypairFromSeed(seedHex: string, path?: string): Ed25519Keypair;
+}

package/dist/esm/keypairs/ed25519/keypair.js

@@ -0,0 +1,147 @@
+import { ed25519 } from "@noble/curves/ed25519";
+import {
+  decodeHaneulPrivateKey,
+  encodeHaneulPrivateKey,
+  Keypair,
+  PRIVATE_KEY_SIZE
+} from "../../cryptography/keypair.js";
+import { isValidHardenedPath, mnemonicToSeedHex } from "../../cryptography/mnemonics.js";
+import { derivePath } from "./ed25519-hd-key.js";
+import { Ed25519PublicKey } from "./publickey.js";
+const DEFAULT_ED25519_DERIVATION_PATH = "m/44'/784'/0'/0'/0'";
+class Ed25519Keypair extends Keypair {
+  /**
+   * Create a new Ed25519 keypair instance.
+   * Generate random keypair if no {@link Ed25519Keypair} is provided.
+   *
+   * @param keypair Ed25519 keypair
+   */
+  constructor(keypair) {
+    super();
+    if (keypair) {
+      this.keypair = {
+        publicKey: keypair.publicKey,
+        secretKey: keypair.secretKey.slice(0, 32)
+      };
+    } else {
+      const privateKey = ed25519.utils.randomPrivateKey();
+      this.keypair = {
+        publicKey: ed25519.getPublicKey(privateKey),
+        secretKey: privateKey
+      };
+    }
+  }
+  /**
+   * Get the key scheme of the keypair ED25519
+   */
+  getKeyScheme() {
+    return "ED25519";
+  }
+  /**
+   * Generate a new random Ed25519 keypair
+   */
+  static generate() {
+    const secretKey = ed25519.utils.randomPrivateKey();
+    return new Ed25519Keypair({
+      publicKey: ed25519.getPublicKey(secretKey),
+      secretKey
+    });
+  }
+  /**
+   * Create a Ed25519 keypair from a raw secret key byte array, also known as seed.
+   * This is NOT the private scalar which is result of hashing and bit clamping of
+   * the raw secret key.
+   *
+   * @throws error if the provided secret key is invalid and validation is not skipped.
+   *
+   * @param secretKey secret key as a byte array or Bech32 secret key string
+   * @param options: skip secret key validation
+   */
+  static fromSecretKey(secretKey, options) {
+    if (typeof secretKey === "string") {
+      const decoded = decodeHaneulPrivateKey(secretKey);
+      if (decoded.schema !== "ED25519") {
+        throw new Error(`Expected a ED25519 keypair, got ${decoded.schema}`);
+      }
+      return this.fromSecretKey(decoded.secretKey, options);
+    }
+    const secretKeyLength = secretKey.length;
+    if (secretKeyLength !== PRIVATE_KEY_SIZE) {
+      throw new Error(
+        `Wrong secretKey size. Expected ${PRIVATE_KEY_SIZE} bytes, got ${secretKeyLength}.`
+      );
+    }
+    const keypair = {
+      publicKey: ed25519.getPublicKey(secretKey),
+      secretKey
+    };
+    if (!options || !options.skipValidation) {
+      const encoder = new TextEncoder();
+      const signData = encoder.encode("sui validation");
+      const signature = ed25519.sign(signData, secretKey);
+      if (!ed25519.verify(signature, signData, keypair.publicKey)) {
+        throw new Error("provided secretKey is invalid");
+      }
+    }
+    return new Ed25519Keypair(keypair);
+  }
+  /**
+   * The public key for this Ed25519 keypair
+   */
+  getPublicKey() {
+    return new Ed25519PublicKey(this.keypair.publicKey);
+  }
+  /**
+   * The Bech32 secret key string for this Ed25519 keypair
+   */
+  getSecretKey() {
+    return encodeHaneulPrivateKey(
+      this.keypair.secretKey.slice(0, PRIVATE_KEY_SIZE),
+      this.getKeyScheme()
+    );
+  }
+  /**
+   * Return the signature for the provided data using Ed25519.
+   */
+  async sign(data) {
+    return ed25519.sign(data, this.keypair.secretKey);
+  }
+  /**
+   * Derive Ed25519 keypair from mnemonics and path. The mnemonics must be normalized
+   * and validated against the english wordlist.
+   *
+   * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must
+   * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.
+   */
+  static deriveKeypair(mnemonics, path) {
+    if (path == null) {
+      path = DEFAULT_ED25519_DERIVATION_PATH;
+    }
+    if (!isValidHardenedPath(path)) {
+      throw new Error("Invalid derivation path");
+    }
+    const { key } = derivePath(path, mnemonicToSeedHex(mnemonics));
+    return Ed25519Keypair.fromSecretKey(key);
+  }
+  /**
+   * Derive Ed25519 keypair from mnemonicSeed and path.
+   *
+   * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must
+   * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.
+   */
+  static deriveKeypairFromSeed(seedHex, path) {
+    if (path == null) {
+      path = DEFAULT_ED25519_DERIVATION_PATH;
+    }
+    if (!isValidHardenedPath(path)) {
+      throw new Error("Invalid derivation path");
+    }
+    const { key } = derivePath(path, seedHex);
+    return Ed25519Keypair.fromSecretKey(key);
+  }
+}
+export {
+  DEFAULT_ED25519_DERIVATION_PATH,
+  Ed25519Keypair
+};
+//# sourceMappingURL=keypair.js.map

package/dist/esm/keypairs/ed25519/keypair.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/keypairs/ed25519/keypair.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { ed25519 } from '@noble/curves/ed25519';\n\nimport {\n\tdecodeHaneulPrivateKey,\n\tencodeHaneulPrivateKey,\n\tKeypair,\n\tPRIVATE_KEY_SIZE,\n} from '../../cryptography/keypair.js';\nimport { isValidHardenedPath, mnemonicToSeedHex } from '../../cryptography/mnemonics.js';\nimport type { SignatureScheme } from '../../cryptography/signature-scheme.js';\nimport { derivePath } from './ed25519-hd-key.js';\nimport { Ed25519PublicKey } from './publickey.js';\n\nexport const DEFAULT_ED25519_DERIVATION_PATH = \"m/44'/784'/0'/0'/0'\";\n\n/**\n * Ed25519 Keypair data. The publickey is the 32-byte public key and\n * the secretkey is 64-byte, where the first 32 bytes is the secret\n * key and the last 32 bytes is the public key.\n */\nexport interface Ed25519KeypairData {\n\tpublicKey: Uint8Array;\n\tsecretKey: Uint8Array;\n}\n\n/**\n * An Ed25519 Keypair used for signing transactions.\n */\nexport class Ed25519Keypair extends Keypair {\n\tprivate keypair: Ed25519KeypairData;\n\n\t/**\n\t * Create a new Ed25519 keypair instance.\n\t * Generate random keypair if no {@link Ed25519Keypair} is provided.\n\t *\n\t * @param keypair Ed25519 keypair\n\t */\n\tconstructor(keypair?: Ed25519KeypairData) {\n\t\tsuper();\n\t\tif (keypair) {\n\t\t\tthis.keypair = {\n\t\t\t\tpublicKey: keypair.publicKey,\n\t\t\t\tsecretKey: keypair.secretKey.slice(0, 32),\n\t\t\t};\n\t\t} else {\n\t\t\tconst privateKey = ed25519.utils.randomPrivateKey();\n\t\t\tthis.keypair = {\n\t\t\t\tpublicKey: ed25519.getPublicKey(privateKey),\n\t\t\t\tsecretKey: privateKey,\n\t\t\t};\n\t\t}\n\t}\n\n\t/**\n\t * Get the key scheme of the keypair ED25519\n\t */\n\tgetKeyScheme(): SignatureScheme {\n\t\treturn 'ED25519';\n\t}\n\n\t/**\n\t * Generate a new random Ed25519 keypair\n\t */\n\tstatic generate(): Ed25519Keypair {\n\t\tconst secretKey = ed25519.utils.randomPrivateKey();\n\t\treturn new Ed25519Keypair({\n\t\t\tpublicKey: ed25519.getPublicKey(secretKey),\n\t\t\tsecretKey,\n\t\t});\n\t}\n\n\t/**\n\t * Create a Ed25519 keypair from a raw secret key byte array, also known as seed.\n\t * This is NOT the private scalar which is result of hashing and bit clamping of\n\t * the raw secret key.\n\t *\n\t * @throws error if the provided secret key is invalid and validation is not skipped.\n\t *\n\t * @param secretKey secret key as a byte array or Bech32 secret key string\n\t * @param options: skip secret key validation\n\t */\n\tstatic fromSecretKey(\n\t\tsecretKey: Uint8Array | string,\n\t\toptions?: { skipValidation?: boolean },\n\t): Ed25519Keypair {\n\t\tif (typeof secretKey === 'string') {\n\t\t\tconst decoded = decodeHaneulPrivateKey(secretKey);\n\n\t\t\tif (decoded.schema !== 'ED25519') {\n\t\t\t\tthrow new Error(`Expected a ED25519 keypair, got ${decoded.schema}`);\n\t\t\t}\n\n\t\t\treturn this.fromSecretKey(decoded.secretKey, options);\n\t\t}\n\n\t\tconst secretKeyLength = secretKey.length;\n\t\tif (secretKeyLength !== PRIVATE_KEY_SIZE) {\n\t\t\tthrow new Error(\n\t\t\t\t`Wrong secretKey size. Expected ${PRIVATE_KEY_SIZE} bytes, got ${secretKeyLength}.`,\n\t\t\t);\n\t\t}\n\t\tconst keypair = {\n\t\t\tpublicKey: ed25519.getPublicKey(secretKey),\n\t\t\tsecretKey,\n\t\t};\n\n\t\tif (!options || !options.skipValidation) {\n\t\t\tconst encoder = new TextEncoder();\n\t\t\tconst signData = encoder.encode('sui validation');\n\t\t\tconst signature = ed25519.sign(signData, secretKey);\n\t\t\tif (!ed25519.verify(signature, signData, keypair.publicKey)) {\n\t\t\t\tthrow new Error('provided secretKey is invalid');\n\t\t\t}\n\t\t}\n\t\treturn new Ed25519Keypair(keypair);\n\t}\n\n\t/**\n\t * The public key for this Ed25519 keypair\n\t */\n\tgetPublicKey(): Ed25519PublicKey {\n\t\treturn new Ed25519PublicKey(this.keypair.publicKey);\n\t}\n\n\t/**\n\t * The Bech32 secret key string for this Ed25519 keypair\n\t */\n\tgetSecretKey(): string {\n\t\treturn encodeHaneulPrivateKey(\n\t\t\tthis.keypair.secretKey.slice(0, PRIVATE_KEY_SIZE),\n\t\t\tthis.getKeyScheme(),\n\t\t);\n\t}\n\n\t/**\n\t * Return the signature for the provided data using Ed25519.\n\t */\n\tasync sign(data: Uint8Array) {\n\t\treturn ed25519.sign(data, this.keypair.secretKey) as Uint8Array<ArrayBuffer>;\n\t}\n\n\t/**\n\t * Derive Ed25519 keypair from mnemonics and path. The mnemonics must be normalized\n\t * and validated against the english wordlist.\n\t *\n\t * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must\n\t * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.\n\t */\n\tstatic deriveKeypair(mnemonics: string, path?: string): Ed25519Keypair {\n\t\tif (path == null) {\n\t\t\tpath = DEFAULT_ED25519_DERIVATION_PATH;\n\t\t}\n\t\tif (!isValidHardenedPath(path)) {\n\t\t\tthrow new Error('Invalid derivation path');\n\t\t}\n\t\tconst { key } = derivePath(path, mnemonicToSeedHex(mnemonics));\n\n\t\treturn Ed25519Keypair.fromSecretKey(key);\n\t}\n\n\t/**\n\t * Derive Ed25519 keypair from mnemonicSeed and path.\n\t *\n\t * If path is none, it will default to m/44'/784'/0'/0'/0', otherwise the path must\n\t * be compliant to SLIP-0010 in form m/44'/784'/{account_index}'/{change_index}'/{address_index}'.\n\t */\n\tstatic deriveKeypairFromSeed(seedHex: string, path?: string): Ed25519Keypair {\n\t\tif (path == null) {\n\t\t\tpath = DEFAULT_ED25519_DERIVATION_PATH;\n\t\t}\n\t\tif (!isValidHardenedPath(path)) {\n\t\t\tthrow new Error('Invalid derivation path');\n\t\t}\n\t\tconst { key } = derivePath(path, seedHex);\n\n\t\treturn Ed25519Keypair.fromSecretKey(key);\n\t}\n}\n"],
+  "mappings": "AAGA,SAAS,eAAe;AAExB;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACM;AACP,SAAS,qBAAqB,yBAAyB;AAEvD,SAAS,kBAAkB;AAC3B,SAAS,wBAAwB;AAE1B,MAAM,kCAAkC;AAexC,MAAM,uBAAuB,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAS3C,YAAY,SAA8B;AACzC,UAAM;AACN,QAAI,SAAS;AACZ,WAAK,UAAU;AAAA,QACd,WAAW,QAAQ;AAAA,QACnB,WAAW,QAAQ,UAAU,MAAM,GAAG,EAAE;AAAA,MACzC;AAAA,IACD,OAAO;AACN,YAAM,aAAa,QAAQ,MAAM,iBAAiB;AAClD,WAAK,UAAU;AAAA,QACd,WAAW,QAAQ,aAAa,UAAU;AAAA,QAC1C,WAAW;AAAA,MACZ;AAAA,IACD;AAAA,EACD;AAAA;AAAA;AAAA;AAAA,EAKA,eAAgC;AAC/B,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,WAA2B;AACjC,UAAM,YAAY,QAAQ,MAAM,iBAAiB;AACjD,WAAO,IAAI,eAAe;AAAA,MACzB,WAAW,QAAQ,aAAa,SAAS;AAAA,MACzC;AAAA,IACD,CAAC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAO,cACN,WACA,SACiB;AACjB,QAAI,OAAO,cAAc,UAAU;AAClC,YAAM,UAAU,uBAAuB,SAAS;AAEhD,UAAI,QAAQ,WAAW,WAAW;AACjC,cAAM,IAAI,MAAM,mCAAmC,QAAQ,MAAM,EAAE;AAAA,MACpE;AAEA,aAAO,KAAK,cAAc,QAAQ,WAAW,OAAO;AAAA,IACrD;AAEA,UAAM,kBAAkB,UAAU;AAClC,QAAI,oBAAoB,kBAAkB;AACzC,YAAM,IAAI;AAAA,QACT,kCAAkC,gBAAgB,eAAe,eAAe;AAAA,MACjF;AAAA,IACD;AACA,UAAM,UAAU;AAAA,MACf,WAAW,QAAQ,aAAa,SAAS;AAAA,MACzC;AAAA,IACD;AAEA,QAAI,CAAC,WAAW,CAAC,QAAQ,gBAAgB;AACxC,YAAM,UAAU,IAAI,YAAY;AAChC,YAAM,WAAW,QAAQ,OAAO,gBAAgB;AAChD,YAAM,YAAY,QAAQ,KAAK,UAAU,SAAS;AAClD,UAAI,CAAC,QAAQ,OAAO,WAAW,UAAU,QAAQ,SAAS,GAAG;AAC5D,cAAM,IAAI,MAAM,+BAA+B;AAAA,MAChD;AAAA,IACD;AACA,WAAO,IAAI,eAAe,OAAO;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAKA,eAAiC;AAChC,WAAO,IAAI,iBAAiB,KAAK,QAAQ,SAAS;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA,EAKA,eAAuB;AACtB,WAAO;AAAA,MACN,KAAK,QAAQ,UAAU,MAAM,GAAG,gBAAgB;AAAA,MAChD,KAAK,aAAa;AAAA,IACnB;AAAA,EACD;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,MAAkB;AAC5B,WAAO,QAAQ,KAAK,MAAM,KAAK,QAAQ,SAAS;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAO,cAAc,WAAmB,MAA+B;AACtE,QAAI,QAAQ,MAAM;AACjB,aAAO;AAAA,IACR;AACA,QAAI,CAAC,oBAAoB,IAAI,GAAG;AAC/B,YAAM,IAAI,MAAM,yBAAyB;AAAA,IAC1C;AACA,UAAM,EAAE,IAAI,IAAI,WAAW,MAAM,kBAAkB,SAAS,CAAC;AAE7D,WAAO,eAAe,cAAc,GAAG;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,sBAAsB,SAAiB,MAA+B;AAC5E,QAAI,QAAQ,MAAM;AACjB,aAAO;AAAA,IACR;AACA,QAAI,CAAC,oBAAoB,IAAI,GAAG;AAC/B,YAAM,IAAI,MAAM,yBAAyB;AAAA,IAC1C;AACA,UAAM,EAAE,IAAI,IAAI,WAAW,MAAM,OAAO;AAExC,WAAO,eAAe,cAAc,GAAG;AAAA,EACxC;AACD;",
+  "names": []
+}

package/dist/esm/keypairs/ed25519/publickey.d.ts

@@ -0,0 +1,30 @@
+import { PublicKey } from '../../cryptography/publickey.js';
+import type { PublicKeyInitData } from '../../cryptography/publickey.js';
+/**
+ * An Ed25519 public key
+ */
+export declare class Ed25519PublicKey extends PublicKey {
+    static SIZE: number;
+    private data;
+    /**
+     * Create a new Ed25519PublicKey object
+     * @param value ed25519 public key as buffer or base-64 encoded string
+     */
+    constructor(value: PublicKeyInitData);
+    /**
+     * Checks if two Ed25519 public keys are equal
+     */
+    equals(publicKey: Ed25519PublicKey): boolean;
+    /**
+     * Return the byte array representation of the Ed25519 public key
+     */
+    toRawBytes(): Uint8Array<ArrayBuffer>;
+    /**
+     * Return the Haneul address associated with this Ed25519 public key
+     */
+    flag(): number;
+    /**
+     * Verifies that the signature is valid for for the provided message
+     */
+    verify(message: Uint8Array, signature: Uint8Array | string): Promise<boolean>;
+}

package/dist/esm/keypairs/ed25519/publickey.js

@@ -0,0 +1,72 @@
+import { fromBase64 } from "@haneullabs/bcs";
+import { ed25519 } from "@noble/curves/ed25519";
+import {
+  bytesEqual,
+  parseSerializedKeypairSignature,
+  PublicKey
+} from "../../cryptography/publickey.js";
+import { SIGNATURE_SCHEME_TO_FLAG } from "../../cryptography/signature-scheme.js";
+const PUBLIC_KEY_SIZE = 32;
+class Ed25519PublicKey extends PublicKey {
+  /**
+   * Create a new Ed25519PublicKey object
+   * @param value ed25519 public key as buffer or base-64 encoded string
+   */
+  constructor(value) {
+    super();
+    if (typeof value === "string") {
+      this.data = fromBase64(value);
+    } else if (value instanceof Uint8Array) {
+      this.data = value;
+    } else {
+      this.data = Uint8Array.from(value);
+    }
+    if (this.data.length !== PUBLIC_KEY_SIZE) {
+      throw new Error(
+        `Invalid public key input. Expected ${PUBLIC_KEY_SIZE} bytes, got ${this.data.length}`
+      );
+    }
+  }
+  /**
+   * Checks if two Ed25519 public keys are equal
+   */
+  equals(publicKey) {
+    return super.equals(publicKey);
+  }
+  /**
+   * Return the byte array representation of the Ed25519 public key
+   */
+  toRawBytes() {
+    return this.data;
+  }
+  /**
+   * Return the Haneul address associated with this Ed25519 public key
+   */
+  flag() {
+    return SIGNATURE_SCHEME_TO_FLAG["ED25519"];
+  }
+  /**
+   * Verifies that the signature is valid for for the provided message
+   */
+  async verify(message, signature) {
+    let bytes;
+    if (typeof signature === "string") {
+      const parsed = parseSerializedKeypairSignature(signature);
+      if (parsed.signatureScheme !== "ED25519") {
+        throw new Error("Invalid signature scheme");
+      }
+      if (!bytesEqual(this.toRawBytes(), parsed.publicKey)) {
+        throw new Error("Signature does not match public key");
+      }
+      bytes = parsed.signature;
+    } else {
+      bytes = signature;
+    }
+    return ed25519.verify(bytes, message, this.toRawBytes());
+  }
+}
+Ed25519PublicKey.SIZE = PUBLIC_KEY_SIZE;
+export {
+  Ed25519PublicKey
+};
+//# sourceMappingURL=publickey.js.map

package/dist/esm/keypairs/ed25519/publickey.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/keypairs/ed25519/publickey.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { fromBase64 } from '@haneullabs/bcs';\nimport { ed25519 } from '@noble/curves/ed25519';\n\nimport {\n\tbytesEqual,\n\tparseSerializedKeypairSignature,\n\tPublicKey,\n} from '../../cryptography/publickey.js';\nimport type { PublicKeyInitData } from '../../cryptography/publickey.js';\nimport { SIGNATURE_SCHEME_TO_FLAG } from '../../cryptography/signature-scheme.js';\n\nconst PUBLIC_KEY_SIZE = 32;\n\n/**\n * An Ed25519 public key\n */\nexport class Ed25519PublicKey extends PublicKey {\n\tstatic SIZE = PUBLIC_KEY_SIZE;\n\tprivate data: Uint8Array<ArrayBuffer>;\n\n\t/**\n\t * Create a new Ed25519PublicKey object\n\t * @param value ed25519 public key as buffer or base-64 encoded string\n\t */\n\tconstructor(value: PublicKeyInitData) {\n\t\tsuper();\n\n\t\tif (typeof value === 'string') {\n\t\t\tthis.data = fromBase64(value);\n\t\t} else if (value instanceof Uint8Array) {\n\t\t\tthis.data = value as Uint8Array<ArrayBuffer>;\n\t\t} else {\n\t\t\tthis.data = Uint8Array.from(value);\n\t\t}\n\n\t\tif (this.data.length !== PUBLIC_KEY_SIZE) {\n\t\t\tthrow new Error(\n\t\t\t\t`Invalid public key input. Expected ${PUBLIC_KEY_SIZE} bytes, got ${this.data.length}`,\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if two Ed25519 public keys are equal\n\t */\n\toverride equals(publicKey: Ed25519PublicKey): boolean {\n\t\treturn super.equals(publicKey);\n\t}\n\n\t/**\n\t * Return the byte array representation of the Ed25519 public key\n\t */\n\ttoRawBytes(): Uint8Array<ArrayBuffer> {\n\t\treturn this.data;\n\t}\n\n\t/**\n\t * Return the Haneul address associated with this Ed25519 public key\n\t */\n\tflag(): number {\n\t\treturn SIGNATURE_SCHEME_TO_FLAG['ED25519'];\n\t}\n\n\t/**\n\t * Verifies that the signature is valid for for the provided message\n\t */\n\tasync verify(message: Uint8Array, signature: Uint8Array | string): Promise<boolean> {\n\t\tlet bytes;\n\t\tif (typeof signature === 'string') {\n\t\t\tconst parsed = parseSerializedKeypairSignature(signature);\n\t\t\tif (parsed.signatureScheme !== 'ED25519') {\n\t\t\t\tthrow new Error('Invalid signature scheme');\n\t\t\t}\n\n\t\t\tif (!bytesEqual(this.toRawBytes(), parsed.publicKey)) {\n\t\t\t\tthrow new Error('Signature does not match public key');\n\t\t\t}\n\n\t\t\tbytes = parsed.signature;\n\t\t} else {\n\t\t\tbytes = signature;\n\t\t}\n\n\t\treturn ed25519.verify(bytes, message, this.toRawBytes());\n\t}\n}\n"],
+  "mappings": "AAGA,SAAS,kBAAkB;AAC3B,SAAS,eAAe;AAExB;AAAA,EACC;AAAA,EACA;AAAA,EACA;AAAA,OACM;AAEP,SAAS,gCAAgC;AAEzC,MAAM,kBAAkB;AAKjB,MAAM,yBAAyB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,YAAY,OAA0B;AACrC,UAAM;AAEN,QAAI,OAAO,UAAU,UAAU;AAC9B,WAAK,OAAO,WAAW,KAAK;AAAA,IAC7B,WAAW,iBAAiB,YAAY;AACvC,WAAK,OAAO;AAAA,IACb,OAAO;AACN,WAAK,OAAO,WAAW,KAAK,KAAK;AAAA,IAClC;AAEA,QAAI,KAAK,KAAK,WAAW,iBAAiB;AACzC,YAAM,IAAI;AAAA,QACT,sCAAsC,eAAe,eAAe,KAAK,KAAK,MAAM;AAAA,MACrF;AAAA,IACD;AAAA,EACD;AAAA;AAAA;AAAA;AAAA,EAKS,OAAO,WAAsC;AACrD,WAAO,MAAM,OAAO,SAAS;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKA,aAAsC;AACrC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,OAAe;AACd,WAAO,yBAAyB,SAAS;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,SAAqB,WAAkD;AACnF,QAAI;AACJ,QAAI,OAAO,cAAc,UAAU;AAClC,YAAM,SAAS,gCAAgC,SAAS;AACxD,UAAI,OAAO,oBAAoB,WAAW;AACzC,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC3C;AAEA,UAAI,CAAC,WAAW,KAAK,WAAW,GAAG,OAAO,SAAS,GAAG;AACrD,cAAM,IAAI,MAAM,qCAAqC;AAAA,MACtD;AAEA,cAAQ,OAAO;AAAA,IAChB,OAAO;AACN,cAAQ;AAAA,IACT;AAEA,WAAO,QAAQ,OAAO,OAAO,SAAS,KAAK,WAAW,CAAC;AAAA,EACxD;AACD;AArEa,iBACL,OAAO;",
+  "names": []
+}

package/dist/esm/keypairs/passkey/index.d.ts

@@ -0,0 +1,3 @@
+export { PasskeyKeypair, BrowserPasskeyProvider, findCommonPublicKey } from './keypair.js';
+export type { PasskeyProvider, BrowserPasswordProviderOptions } from './keypair.js';
+export { PasskeyPublicKey } from './publickey.js';

package/dist/esm/keypairs/passkey/index.js

@@ -0,0 +1,9 @@
+import { PasskeyKeypair, BrowserPasskeyProvider, findCommonPublicKey } from "./keypair.js";
+import { PasskeyPublicKey } from "./publickey.js";
+export {
+  BrowserPasskeyProvider,
+  PasskeyKeypair,
+  PasskeyPublicKey,
+  findCommonPublicKey
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/keypairs/passkey/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/keypairs/passkey/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\nexport { PasskeyKeypair, BrowserPasskeyProvider, findCommonPublicKey } from './keypair.js';\nexport type { PasskeyProvider, BrowserPasswordProviderOptions } from './keypair.js';\nexport { PasskeyPublicKey } from './publickey.js';\n"],
+  "mappings": "AAEA,SAAS,gBAAgB,wBAAwB,2BAA2B;AAE5E,SAAS,wBAAwB;",
+  "names": []
+}

package/dist/esm/keypairs/passkey/keypair.d.ts

@@ -0,0 +1,113 @@
+import type { IntentScope, SignatureWithBytes } from '../../cryptography/index.js';
+import { Signer } from '../../cryptography/index.js';
+import type { PublicKey } from '../../cryptography/publickey.js';
+import type { SignatureScheme } from '../../cryptography/signature-scheme.js';
+import type { AuthenticationCredential, RegistrationCredential } from './types.js';
+type DeepPartialConfigKeys = 'rp' | 'user' | 'authenticatorSelection';
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+export type BrowserPasswordProviderOptions = Pick<DeepPartial<PublicKeyCredentialCreationOptions>, DeepPartialConfigKeys> & Omit<Partial<PublicKeyCredentialCreationOptions>, DeepPartialConfigKeys | 'pubKeyCredParams' | 'challenge'>;
+export interface PasskeyProvider {
+    create(): Promise<RegistrationCredential>;
+    get(challenge: Uint8Array): Promise<AuthenticationCredential>;
+}
+export declare class BrowserPasskeyProvider implements PasskeyProvider {
+    #private;
+    constructor(name: string, options: BrowserPasswordProviderOptions);
+    create(): Promise<RegistrationCredential>;
+    get(challenge: Uint8Array): Promise<AuthenticationCredential>;
+}
+/**
+ * @experimental
+ * A passkey signer used for signing transactions. This is a client side implementation for [SIP-9](https://github.com/sui-foundation/sips/blob/main/sips/sip-9.md).
+ */
+export declare class PasskeyKeypair extends Signer {
+    private publicKey;
+    private provider;
+    /**
+     * Get the key scheme of passkey,
+     */
+    getKeyScheme(): SignatureScheme;
+    /**
+     * Creates an instance of Passkey signer. If no passkey wallet had created before,
+     * use `getPasskeyInstance`. For example:
+     * ```
+     * let provider = new BrowserPasskeyProvider('Sui Passkey Example',{
+     * 	  rpName: 'Sui Passkey Example',
+     * 	  rpId: window.location.hostname,
+     * } as BrowserPasswordProviderOptions);
+     * const signer = await PasskeyKeypair.getPasskeyInstance(provider);
+     * ```
+     *
+     * If there are existing passkey wallet, use `signAndRecover` to identify the correct
+     * public key and then initialize the instance. See usage in `signAndRecover`.
+     */
+    constructor(publicKey: Uint8Array, provider: PasskeyProvider);
+    /**
+     * Creates an instance of Passkey signer invoking the passkey from navigator.
+     * Note that this will invoke the passkey device to create a fresh credential.
+     * Should only be called if passkey wallet is created for the first time.
+     *
+     * @param provider - the passkey provider.
+     * @returns the passkey instance.
+     */
+    static getPasskeyInstance(provider: PasskeyProvider): Promise<PasskeyKeypair>;
+    /**
+     * Return the public key for this passkey.
+     */
+    getPublicKey(): PublicKey;
+    /**
+     * Return the signature for the provided data (i.e. blake2b(intent_message)).
+     * This is sent to passkey as the challenge field.
+     */
+    sign(data: Uint8Array): Promise<Uint8Array<ArrayBuffer>>;
+    /**
+     * This overrides the base class implementation that accepts the raw bytes and signs its
+     * digest of the intent message, then serialize it with the passkey flag.
+     */
+    signWithIntent(bytes: Uint8Array, intent: IntentScope): Promise<SignatureWithBytes>;
+    /**
+     * Given a message, asks the passkey device to sign it and return all (up to 4) possible public keys.
+     * See: https://bitcoin.stackexchange.com/questions/81232/how-is-public-key-extracted-from-message-digital-signature-address
+     *
+     * This is useful if the user previously created passkey wallet with the origin, but the wallet session
+     * does not have the public key / address. By calling this method twice with two different messages, the
+     * wallet can compare the returned public keys and uniquely identify the previously created passkey wallet
+     * using `findCommonPublicKey`.
+     *
+     * Alternatively, one call can be made and all possible public keys should be checked onchain to see if
+     * there is any assets.
+     *
+     * Once the correct public key is identified, a passkey instance can then be initialized with this public key.
+     *
+     * Example usage to recover wallet with two signing calls:
+     * ```
+     * let provider = new BrowserPasskeyProvider('Sui Passkey Example',{
+     *     rpName: 'Sui Passkey Example',
+     * 	   rpId: window.location.hostname,
+     * } as BrowserPasswordProviderOptions);
+     * const testMessage = new TextEncoder().encode('Hello world!');
+     * const possiblePks = await PasskeyKeypair.signAndRecover(provider, testMessage);
+     * const testMessage2 = new TextEncoder().encode('Hello world 2!');
+     * const possiblePks2 = await PasskeyKeypair.signAndRecover(provider, testMessage2);
+     * const commonPk = findCommonPublicKey(possiblePks, possiblePks2);
+     * const signer = new PasskeyKeypair(provider, commonPk.toRawBytes());
+     * ```
+     *
+     * @param provider - the passkey provider.
+     * @param message - the message to sign.
+     * @returns all possible public keys.
+     */
+    static signAndRecover(provider: PasskeyProvider, message: Uint8Array): Promise<PublicKey[]>;
+}
+/**
+ * Finds the unique public key that exists in both arrays, throws error if the common
+ * pubkey does not equal to one.
+ *
+ * @param arr1 - The first pubkeys array.
+ * @param arr2 - The second pubkeys array.
+ * @returns The only common pubkey in both arrays.
+ */
+export declare function findCommonPublicKey(arr1: PublicKey[], arr2: PublicKey[]): PublicKey;
+export {};