@mysten/signers 0.1.17 → 0.2.1

package/dist/esm/ledger/index.d.ts

@@ -0,0 +1,63 @@
+import type SuiLedgerClient from '@mysten/ledgerjs-hw-app-sui';
+import type { SuiClient } from '@mysten/sui/client';
+import type { SignatureWithBytes } from '@mysten/sui/cryptography';
+import { Signer } from '@mysten/sui/cryptography';
+import { Ed25519PublicKey } from '@mysten/sui/keypairs/ed25519';
+/**
+ * Configuration options for initializing the LedgerSigner.
+ */
+export interface LedgerSignerOptions {
+    publicKey: Ed25519PublicKey;
+    derivationPath: string;
+    ledgerClient: SuiLedgerClient;
+    suiClient: SuiClient;
+}
+/**
+ * Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.
+ */
+export declare class LedgerSigner extends Signer {
+    #private;
+    /**
+     * Creates an instance of LedgerSigner. It's expected to call the static `fromDerivationPath` method to create an instance.
+     * @example
+     * ```
+     * const signer = await LedgerSigner.fromDerivationPath(derivationPath, options);
+     * ```
+     */
+    constructor({ publicKey, derivationPath, ledgerClient, suiClient }: LedgerSignerOptions);
+    /**
+     * Retrieves the key scheme used by this signer.
+     */
+    getKeyScheme(): "ED25519";
+    /**
+     * Retrieves the public key associated with this signer.
+     * @returns The Ed25519PublicKey instance.
+     */
+    getPublicKey(): Ed25519PublicKey;
+    /**
+     * Signs the provided transaction bytes.
+     * @returns The signed transaction bytes and signature.
+     */
+    signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>;
+    /**
+     * Signs the provided personal message.
+     * @returns The signed message bytes and signature.
+     */
+    signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes>;
+    /**
+     * Prepares the signer by fetching and setting the public key from a Ledger device.
+     * It is recommended to initialize an `LedgerSigner` instance using this function.
+     * @returns A promise that resolves once a `LedgerSigner` instance is prepared (public key is set).
+     */
+    static fromDerivationPath(derivationPath: string, ledgerClient: SuiLedgerClient, suiClient: SuiClient): Promise<LedgerSigner>;
+    /**
+     * Generic signing is not supported by Ledger.
+     * @throws Always throws an error indicating generic signing is unsupported.
+     */
+    sign(): never;
+    /**
+     * Generic signing is not supported by Ledger.
+     * @throws Always throws an error indicating generic signing is unsupported.
+     */
+    signWithIntent(): never;
+}

package/dist/esm/ledger/index.js

@@ -0,0 +1,168 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
+var _derivationPath, _publicKey, _ledgerClient, _suiClient, _LedgerSigner_instances, getClearSigningOptions_fn;
+import { messageWithIntent, Signer, toSerializedSignature } from "@mysten/sui/cryptography";
+import { Ed25519PublicKey } from "@mysten/sui/keypairs/ed25519";
+import { Transaction } from "@mysten/sui/transactions";
+import { toBase64 } from "@mysten/sui/utils";
+import { SuiMoveObject } from "./bcs.js";
+const _LedgerSigner = class _LedgerSigner extends Signer {
+  /**
+   * Creates an instance of LedgerSigner. It's expected to call the static `fromDerivationPath` method to create an instance.
+   * @example
+   * ```
+   * const signer = await LedgerSigner.fromDerivationPath(derivationPath, options);
+   * ```
+   */
+  constructor({ publicKey, derivationPath, ledgerClient, suiClient }) {
+    super();
+    __privateAdd(this, _LedgerSigner_instances);
+    __privateAdd(this, _derivationPath);
+    __privateAdd(this, _publicKey);
+    __privateAdd(this, _ledgerClient);
+    __privateAdd(this, _suiClient);
+    __privateSet(this, _publicKey, publicKey);
+    __privateSet(this, _derivationPath, derivationPath);
+    __privateSet(this, _ledgerClient, ledgerClient);
+    __privateSet(this, _suiClient, suiClient);
+  }
+  /**
+   * Retrieves the key scheme used by this signer.
+   */
+  getKeyScheme() {
+    return "ED25519";
+  }
+  /**
+   * Retrieves the public key associated with this signer.
+   * @returns The Ed25519PublicKey instance.
+   */
+  getPublicKey() {
+    return __privateGet(this, _publicKey);
+  }
+  /**
+   * Signs the provided transaction bytes.
+   * @returns The signed transaction bytes and signature.
+   */
+  async signTransaction(bytes) {
+    const transactionOptions = await __privateMethod(this, _LedgerSigner_instances, getClearSigningOptions_fn).call(this, bytes).catch(() => ({
+      // Fail gracefully so network errors or serialization issues don't break transaction signing:
+      bcsObjects: []
+    }));
+    const intentMessage = messageWithIntent("TransactionData", bytes);
+    const { signature } = await __privateGet(this, _ledgerClient).signTransaction(
+      __privateGet(this, _derivationPath),
+      intentMessage,
+      transactionOptions
+    );
+    return {
+      bytes: toBase64(bytes),
+      signature: toSerializedSignature({
+        signature,
+        signatureScheme: this.getKeyScheme(),
+        publicKey: __privateGet(this, _publicKey)
+      })
+    };
+  }
+  /**
+   * Signs the provided personal message.
+   * @returns The signed message bytes and signature.
+   */
+  async signPersonalMessage(bytes) {
+    const intentMessage = messageWithIntent("PersonalMessage", bytes);
+    const { signature } = await __privateGet(this, _ledgerClient).signTransaction(
+      __privateGet(this, _derivationPath),
+      intentMessage
+    );
+    return {
+      bytes: toBase64(bytes),
+      signature: toSerializedSignature({
+        signature,
+        signatureScheme: this.getKeyScheme(),
+        publicKey: __privateGet(this, _publicKey)
+      })
+    };
+  }
+  /**
+   * Prepares the signer by fetching and setting the public key from a Ledger device.
+   * It is recommended to initialize an `LedgerSigner` instance using this function.
+   * @returns A promise that resolves once a `LedgerSigner` instance is prepared (public key is set).
+   */
+  static async fromDerivationPath(derivationPath, ledgerClient, suiClient) {
+    const { publicKey } = await ledgerClient.getPublicKey(derivationPath);
+    if (!publicKey) {
+      throw new Error("Failed to get public key from Ledger.");
+    }
+    return new _LedgerSigner({
+      derivationPath,
+      publicKey: new Ed25519PublicKey(publicKey),
+      ledgerClient,
+      suiClient
+    });
+  }
+  /**
+   * Generic signing is not supported by Ledger.
+   * @throws Always throws an error indicating generic signing is unsupported.
+   */
+  sign() {
+    throw new Error("Ledger Signer does not support generic signing.");
+  }
+  /**
+   * Generic signing is not supported by Ledger.
+   * @throws Always throws an error indicating generic signing is unsupported.
+   */
+  signWithIntent() {
+    throw new Error("Ledger Signer does not support generic signing.");
+  }
+};
+_derivationPath = new WeakMap();
+_publicKey = new WeakMap();
+_ledgerClient = new WeakMap();
+_suiClient = new WeakMap();
+_LedgerSigner_instances = new WeakSet();
+getClearSigningOptions_fn = async function(transactionBytes) {
+  const transaction = Transaction.from(transactionBytes);
+  const data = transaction.getData();
+  const gasObjectIds = data.gasData.payment?.map((object) => object.objectId) ?? [];
+  const inputObjectIds = data.inputs.map((input) => {
+    return input.$kind === "Object" && input.Object.$kind === "ImmOrOwnedObject" ? input.Object.ImmOrOwnedObject.objectId : null;
+  }).filter((objectId) => !!objectId);
+  const objects = await __privateGet(this, _suiClient).multiGetObjects({
+    ids: [...gasObjectIds, ...inputObjectIds],
+    options: {
+      showBcs: true,
+      showPreviousTransaction: true,
+      showStorageRebate: true,
+      showOwner: true
+    }
+  });
+  const bcsObjects = objects.map((object) => {
+    if (object.error || !object.data || object.data.bcs?.dataType !== "moveObject") {
+      return null;
+    }
+    return SuiMoveObject.serialize({
+      data: {
+        MoveObject: {
+          type: object.data.bcs.type,
+          hasPublicTransfer: object.data.bcs.hasPublicTransfer,
+          version: object.data.bcs.version,
+          contents: object.data.bcs.bcsBytes
+        }
+      },
+      owner: object.data.owner,
+      previousTransaction: object.data.previousTransaction,
+      storageRebate: object.data.storageRebate
+    }).toBytes();
+  }).filter((bcsBytes) => !!bcsBytes);
+  return { bcsObjects };
+};
+let LedgerSigner = _LedgerSigner;
+export {
+  LedgerSigner
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/ledger/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/ledger/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type SuiLedgerClient from '@mysten/ledgerjs-hw-app-sui';\nimport type { SuiClient } from '@mysten/sui/client';\nimport type { SignatureWithBytes } from '@mysten/sui/cryptography';\nimport { messageWithIntent, Signer, toSerializedSignature } from '@mysten/sui/cryptography';\nimport { Ed25519PublicKey } from '@mysten/sui/keypairs/ed25519';\nimport { Transaction } from '@mysten/sui/transactions';\nimport { toBase64 } from '@mysten/sui/utils';\n\nimport { SuiMoveObject } from './bcs.js';\n\n/**\n * Configuration options for initializing the LedgerSigner.\n */\nexport interface LedgerSignerOptions {\n\tpublicKey: Ed25519PublicKey;\n\tderivationPath: string;\n\tledgerClient: SuiLedgerClient;\n\tsuiClient: SuiClient;\n}\n\n/**\n * Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.\n */\nexport class LedgerSigner extends Signer {\n\t#derivationPath: string;\n\t#publicKey: Ed25519PublicKey;\n\t#ledgerClient: SuiLedgerClient;\n\t#suiClient: SuiClient;\n\n\t/**\n\t * Creates an instance of LedgerSigner. It's expected to call the static `fromDerivationPath` method to create an instance.\n\t * @example\n\t * ```\n\t * const signer = await LedgerSigner.fromDerivationPath(derivationPath, options);\n\t * ```\n\t */\n\tconstructor({ publicKey, derivationPath, ledgerClient, suiClient }: LedgerSignerOptions) {\n\t\tsuper();\n\t\tthis.#publicKey = publicKey;\n\t\tthis.#derivationPath = derivationPath;\n\t\tthis.#ledgerClient = ledgerClient;\n\t\tthis.#suiClient = suiClient;\n\t}\n\n\t/**\n\t * Retrieves the key scheme used by this signer.\n\t */\n\toverride getKeyScheme() {\n\t\treturn 'ED25519' as const;\n\t}\n\n\t/**\n\t * Retrieves the public key associated with this signer.\n\t * @returns The Ed25519PublicKey instance.\n\t */\n\toverride getPublicKey() {\n\t\treturn this.#publicKey;\n\t}\n\n\t/**\n\t * Signs the provided transaction bytes.\n\t * @returns The signed transaction bytes and signature.\n\t */\n\toverride async signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes> {\n\t\tconst transactionOptions = await this.#getClearSigningOptions(bytes).catch(() => ({\n\t\t\t// Fail gracefully so network errors or serialization issues don't break transaction signing:\n\t\t\tbcsObjects: [],\n\t\t}));\n\n\t\tconst intentMessage = messageWithIntent('TransactionData', bytes);\n\t\tconst { signature } = await this.#ledgerClient.signTransaction(\n\t\t\tthis.#derivationPath,\n\t\t\tintentMessage,\n\t\t\ttransactionOptions,\n\t\t);\n\n\t\treturn {\n\t\t\tbytes: toBase64(bytes),\n\t\t\tsignature: toSerializedSignature({\n\t\t\t\tsignature,\n\t\t\t\tsignatureScheme: this.getKeyScheme(),\n\t\t\t\tpublicKey: this.#publicKey,\n\t\t\t}),\n\t\t};\n\t}\n\n\t/**\n\t * Signs the provided personal message.\n\t * @returns The signed message bytes and signature.\n\t */\n\toverride async signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes> {\n\t\tconst intentMessage = messageWithIntent('PersonalMessage', bytes);\n\t\tconst { signature } = await this.#ledgerClient.signTransaction(\n\t\t\tthis.#derivationPath,\n\t\t\tintentMessage,\n\t\t);\n\n\t\treturn {\n\t\t\tbytes: toBase64(bytes),\n\t\t\tsignature: toSerializedSignature({\n\t\t\t\tsignature,\n\t\t\t\tsignatureScheme: this.getKeyScheme(),\n\t\t\t\tpublicKey: this.#publicKey,\n\t\t\t}),\n\t\t};\n\t}\n\n\t/**\n\t * Prepares the signer by fetching and setting the public key from a Ledger device.\n\t * It is recommended to initialize an `LedgerSigner` instance using this function.\n\t * @returns A promise that resolves once a `LedgerSigner` instance is prepared (public key is set).\n\t */\n\tstatic async fromDerivationPath(\n\t\tderivationPath: string,\n\t\tledgerClient: SuiLedgerClient,\n\t\tsuiClient: SuiClient,\n\t) {\n\t\tconst { publicKey } = await ledgerClient.getPublicKey(derivationPath);\n\t\tif (!publicKey) {\n\t\t\tthrow new Error('Failed to get public key from Ledger.');\n\t\t}\n\n\t\treturn new LedgerSigner({\n\t\t\tderivationPath,\n\t\t\tpublicKey: new Ed25519PublicKey(publicKey),\n\t\t\tledgerClient,\n\t\t\tsuiClient,\n\t\t});\n\t}\n\n\tasync #getClearSigningOptions(transactionBytes: Uint8Array) {\n\t\tconst transaction = Transaction.from(transactionBytes);\n\t\tconst data = transaction.getData();\n\n\t\tconst gasObjectIds = data.gasData.payment?.map((object) => object.objectId) ?? [];\n\t\tconst inputObjectIds = data.inputs\n\t\t\t.map((input) => {\n\t\t\t\treturn input.$kind === 'Object' && input.Object.$kind === 'ImmOrOwnedObject'\n\t\t\t\t\t? input.Object.ImmOrOwnedObject.objectId\n\t\t\t\t\t: null;\n\t\t\t})\n\t\t\t.filter((objectId): objectId is string => !!objectId);\n\n\t\tconst objects = await this.#suiClient.multiGetObjects({\n\t\t\tids: [...gasObjectIds, ...inputObjectIds],\n\t\t\toptions: {\n\t\t\t\tshowBcs: true,\n\t\t\t\tshowPreviousTransaction: true,\n\t\t\t\tshowStorageRebate: true,\n\t\t\t\tshowOwner: true,\n\t\t\t},\n\t\t});\n\n\t\t// NOTE: We should probably get rid of this manual serialization logic in favor of using the\n\t\t// already serialized object bytes from the GraphQL API once there is more mainstream support\n\t\t// for it + we can enforce the transport type on the Sui client.\n\t\tconst bcsObjects = objects\n\t\t\t.map((object) => {\n\t\t\t\tif (object.error || !object.data || object.data.bcs?.dataType !== 'moveObject') {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\treturn SuiMoveObject.serialize({\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tMoveObject: {\n\t\t\t\t\t\t\ttype: object.data.bcs.type,\n\t\t\t\t\t\t\thasPublicTransfer: object.data.bcs.hasPublicTransfer,\n\t\t\t\t\t\t\tversion: object.data.bcs.version,\n\t\t\t\t\t\t\tcontents: object.data.bcs.bcsBytes,\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\towner: object.data.owner!,\n\t\t\t\t\tpreviousTransaction: object.data.previousTransaction!,\n\t\t\t\t\tstorageRebate: object.data.storageRebate!,\n\t\t\t\t}).toBytes();\n\t\t\t})\n\t\t\t.filter((bcsBytes): bcsBytes is Uint8Array => !!bcsBytes);\n\n\t\treturn { bcsObjects };\n\t}\n\n\t/**\n\t * Generic signing is not supported by Ledger.\n\t * @throws Always throws an error indicating generic signing is unsupported.\n\t */\n\toverride sign(): never {\n\t\tthrow new Error('Ledger Signer does not support generic signing.');\n\t}\n\n\t/**\n\t * Generic signing is not supported by Ledger.\n\t * @throws Always throws an error indicating generic signing is unsupported.\n\t */\n\toverride signWithIntent(): never {\n\t\tthrow new Error('Ledger Signer does not support generic signing.');\n\t}\n}\n"],
+  "mappings": ";;;;;;;;AAAA;AAMA,SAAS,mBAAmB,QAAQ,6BAA6B;AACjE,SAAS,wBAAwB;AACjC,SAAS,mBAAmB;AAC5B,SAAS,gBAAgB;AAEzB,SAAS,qBAAqB;AAevB,MAAM,gBAAN,MAAM,sBAAqB,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaxC,YAAY,EAAE,WAAW,gBAAgB,cAAc,UAAU,GAAwB;AACxF,UAAM;AAdD;AACN;AACA;AACA;AACA;AAWC,uBAAK,YAAa;AAClB,uBAAK,iBAAkB;AACvB,uBAAK,eAAgB;AACrB,uBAAK,YAAa;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA,EAKS,eAAe;AACvB,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA,EAMS,eAAe;AACvB,WAAO,mBAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAe,gBAAgB,OAAgD;AAC9E,UAAM,qBAAqB,MAAM,sBAAK,oDAAL,WAA6B,OAAO,MAAM,OAAO;AAAA;AAAA,MAEjF,YAAY,CAAC;AAAA,IACd,EAAE;AAEF,UAAM,gBAAgB,kBAAkB,mBAAmB,KAAK;AAChE,UAAM,EAAE,UAAU,IAAI,MAAM,mBAAK,eAAc;AAAA,MAC9C,mBAAK;AAAA,MACL;AAAA,MACA;AAAA,IACD;AAEA,WAAO;AAAA,MACN,OAAO,SAAS,KAAK;AAAA,MACrB,WAAW,sBAAsB;AAAA,QAChC;AAAA,QACA,iBAAiB,KAAK,aAAa;AAAA,QACnC,WAAW,mBAAK;AAAA,MACjB,CAAC;AAAA,IACF;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAe,oBAAoB,OAAgD;AAClF,UAAM,gBAAgB,kBAAkB,mBAAmB,KAAK;AAChE,UAAM,EAAE,UAAU,IAAI,MAAM,mBAAK,eAAc;AAAA,MAC9C,mBAAK;AAAA,MACL;AAAA,IACD;AAEA,WAAO;AAAA,MACN,OAAO,SAAS,KAAK;AAAA,MACrB,WAAW,sBAAsB;AAAA,QAChC;AAAA,QACA,iBAAiB,KAAK,aAAa;AAAA,QACnC,WAAW,mBAAK;AAAA,MACjB,CAAC;AAAA,IACF;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,mBACZ,gBACA,cACA,WACC;AACD,UAAM,EAAE,UAAU,IAAI,MAAM,aAAa,aAAa,cAAc;AACpE,QAAI,CAAC,WAAW;AACf,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACxD;AAEA,WAAO,IAAI,cAAa;AAAA,MACvB;AAAA,MACA,WAAW,IAAI,iBAAiB,SAAS;AAAA,MACzC;AAAA,MACA;AAAA,IACD,CAAC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAyDS,OAAc;AACtB,UAAM,IAAI,MAAM,iDAAiD;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMS,iBAAwB;AAChC,UAAM,IAAI,MAAM,iDAAiD;AAAA,EAClE;AACD;AA5KC;AACA;AACA;AACA;AAJM;AA2GA,4BAAuB,eAAC,kBAA8B;AAC3D,QAAM,cAAc,YAAY,KAAK,gBAAgB;AACrD,QAAM,OAAO,YAAY,QAAQ;AAEjC,QAAM,eAAe,KAAK,QAAQ,SAAS,IAAI,CAAC,WAAW,OAAO,QAAQ,KAAK,CAAC;AAChF,QAAM,iBAAiB,KAAK,OAC1B,IAAI,CAAC,UAAU;AACf,WAAO,MAAM,UAAU,YAAY,MAAM,OAAO,UAAU,qBACvD,MAAM,OAAO,iBAAiB,WAC9B;AAAA,EACJ,CAAC,EACA,OAAO,CAAC,aAAiC,CAAC,CAAC,QAAQ;AAErD,QAAM,UAAU,MAAM,mBAAK,YAAW,gBAAgB;AAAA,IACrD,KAAK,CAAC,GAAG,cAAc,GAAG,cAAc;AAAA,IACxC,SAAS;AAAA,MACR,SAAS;AAAA,MACT,yBAAyB;AAAA,MACzB,mBAAmB;AAAA,MACnB,WAAW;AAAA,IACZ;AAAA,EACD,CAAC;AAKD,QAAM,aAAa,QACjB,IAAI,CAAC,WAAW;AAChB,QAAI,OAAO,SAAS,CAAC,OAAO,QAAQ,OAAO,KAAK,KAAK,aAAa,cAAc;AAC/E,aAAO;AAAA,IACR;AAEA,WAAO,cAAc,UAAU;AAAA,MAC9B,MAAM;AAAA,QACL,YAAY;AAAA,UACX,MAAM,OAAO,KAAK,IAAI;AAAA,UACtB,mBAAmB,OAAO,KAAK,IAAI;AAAA,UACnC,SAAS,OAAO,KAAK,IAAI;AAAA,UACzB,UAAU,OAAO,KAAK,IAAI;AAAA,QAC3B;AAAA,MACD;AAAA,MACA,OAAO,OAAO,KAAK;AAAA,MACnB,qBAAqB,OAAO,KAAK;AAAA,MACjC,eAAe,OAAO,KAAK;AAAA,IAC5B,CAAC,EAAE,QAAQ;AAAA,EACZ,CAAC,EACA,OAAO,CAAC,aAAqC,CAAC,CAAC,QAAQ;AAEzD,SAAO,EAAE,WAAW;AACrB;AA5JM,IAAM,eAAN;",
+  "names": []
+}