@mysten/ledger-signer 0.0.0

package/dist/index.d.mts

@@ -0,0 +1,73 @@
+import { getInputObjects } from "./objects.mjs";
+import { SignatureWithBytes, Signer } from "@mysten/sui/cryptography";
+import { Ed25519PublicKey } from "@mysten/sui/keypairs/ed25519";
+import SuiLedgerClient, { Resolution } from "@mysten/ledgerjs-hw-app-sui";
+import { ClientWithCoreApi } from "@mysten/sui/client";
+
+//#region src/index.d.ts
+/**
+ * Configuration options for initializing the LedgerSigner.
+ */
+interface LedgerSignerOptions {
+  publicKey: Ed25519PublicKey;
+  derivationPath: string;
+  ledgerClient: SuiLedgerClient;
+  suiClient: ClientWithCoreApi;
+}
+/**
+ * Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.
+ */
+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, bcsObjects?: Uint8Array[], resolution?: Resolution): 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: ClientWithCoreApi): 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;
+}
+//#endregion
+export { LedgerSigner, LedgerSignerOptions, getInputObjects };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;AAoBA;;;AAAA,UAAiB,mBAAA;EAChB,SAAA,EAAW,gBAAA;EACX,cAAA;EACA,YAAA,EAAc,eAAA;EACd,SAAA,EAAW,iBAAA;AAAA;;;;cAMC,YAAA,SAAqB,MAAA;EAAA;EANtB;;;AAMZ;;;;;IAae,SAAA;IAAW,cAAA;IAAgB,YAAA;IAAc;EAAA,GAAa,mBAAA;EAA3B;;;EAWhC,YAAA,CAAA;EAiBD;;;;EATC,YAAA,CAAA,GAAY,gBAAA;EA0CqB;;;;EAlC3B,eAAA,CACd,KAAA,EAAO,UAAA,EACP,UAAA,GAAa,UAAA,IACb,UAAA,GAAa,UAAA,GACX,OAAA,CAAQ,kBAAA;EA0DkB;;;;EA5Bd,mBAAA,CAAoB,KAAA,EAAO,UAAA,GAAa,OAAA,CAAQ,kBAAA;EA1E9B;;;;;EAAA,OAmGpB,kBAAA,CACZ,cAAA,UACA,YAAA,EAAc,eAAA,EACd,SAAA,EAAW,iBAAA,GAAiB,OAAA,CAAA,YAAA;EAzFJ;;;;EA4GhB,IAAA,CAAA;EA5G2D;;;;EAoH3D,cAAA,CAAA;AAAA"}

package/dist/index.mjs

@@ -0,0 +1,110 @@
+import { getInputObjects } from "./objects.mjs";
+import { Signer, messageWithIntent, 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 { bcs } from "@mysten/sui/bcs";
+
+//#region src/index.ts
+/**
+* Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.
+*/
+var LedgerSigner = class LedgerSigner extends Signer {
+	#derivationPath;
+	#publicKey;
+	#ledgerClient;
+	#suiClient;
+	/**
+	* 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();
+		this.#publicKey = publicKey;
+		this.#derivationPath = derivationPath;
+		this.#ledgerClient = ledgerClient;
+		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 this.#publicKey;
+	}
+	/**
+	* Signs the provided transaction bytes.
+	* @returns The signed transaction bytes and signature.
+	*/
+	async signTransaction(bytes, bcsObjects, resolution) {
+		const transactionOptions = bcsObjects ? { bcsObjects } : await getInputObjects(Transaction.from(bytes), this.#suiClient).catch(() => ({ bcsObjects: [] }));
+		const intentMessage = messageWithIntent("TransactionData", bytes);
+		const { signature } = await this.#ledgerClient.signTransaction(this.#derivationPath, intentMessage, transactionOptions, resolution);
+		return {
+			bytes: toBase64(bytes),
+			signature: toSerializedSignature({
+				signature,
+				signatureScheme: this.getKeyScheme(),
+				publicKey: this.#publicKey
+			})
+		};
+	}
+	/**
+	* Signs the provided personal message.
+	* @returns The signed message bytes and signature.
+	*/
+	async signPersonalMessage(bytes) {
+		const intentMessage = messageWithIntent("PersonalMessage", bcs.byteVector().serialize(bytes).toBytes());
+		const { signature } = await this.#ledgerClient.signTransaction(this.#derivationPath, intentMessage);
+		return {
+			bytes: toBase64(bytes),
+			signature: toSerializedSignature({
+				signature,
+				signatureScheme: this.getKeyScheme(),
+				publicKey: 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.");
+	}
+};
+
+//#endregion
+export { LedgerSigner, getInputObjects };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["#publicKey","#derivationPath","#ledgerClient","#suiClient"],"sources":["../src/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 { ClientWithCoreApi } 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 { bcs } from '@mysten/sui/bcs';\nimport { getInputObjects } from './objects.js';\nimport type { Resolution } from '@mysten/ledgerjs-hw-app-sui';\n\nexport { getInputObjects } from './objects.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: ClientWithCoreApi;\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: ClientWithCoreApi;\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(\n\t\tbytes: Uint8Array,\n\t\tbcsObjects?: Uint8Array[],\n\t\tresolution?: Resolution,\n\t): Promise<SignatureWithBytes> {\n\t\tconst transactionOptions = bcsObjects\n\t\t\t? { bcsObjects }\n\t\t\t: await getInputObjects(Transaction.from(bytes), this.#suiClient).catch(() => ({\n\t\t\t\t\t// Fail gracefully so network errors or serialization issues don't break transaction signing:\n\t\t\t\t\tbcsObjects: [],\n\t\t\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\tresolution,\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(\n\t\t\t'PersonalMessage',\n\t\t\tbcs.byteVector().serialize(bytes).toBytes(),\n\t\t);\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: ClientWithCoreApi,\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\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":";;;;;;;;;;;AA8BA,IAAa,eAAb,MAAa,qBAAqB,OAAO;CACxC;CACA;CACA;CACA;;;;;;;;CASA,YAAY,EAAE,WAAW,gBAAgB,cAAc,aAAkC;AACxF,SAAO;AACP,QAAKA,YAAa;AAClB,QAAKC,iBAAkB;AACvB,QAAKC,eAAgB;AACrB,QAAKC,YAAa;;;;;CAMnB,AAAS,eAAe;AACvB,SAAO;;;;;;CAOR,AAAS,eAAe;AACvB,SAAO,MAAKH;;;;;;CAOb,MAAe,gBACd,OACA,YACA,YAC8B;EAC9B,MAAM,qBAAqB,aACxB,EAAE,YAAY,GACd,MAAM,gBAAgB,YAAY,KAAK,MAAM,EAAE,MAAKG,UAAW,CAAC,aAAa,EAE7E,YAAY,EAAE,EACd,EAAE;EAEL,MAAM,gBAAgB,kBAAkB,mBAAmB,MAAM;EACjE,MAAM,EAAE,cAAc,MAAM,MAAKD,aAAc,gBAC9C,MAAKD,gBACL,eACA,oBACA,WACA;AAED,SAAO;GACN,OAAO,SAAS,MAAM;GACtB,WAAW,sBAAsB;IAChC;IACA,iBAAiB,KAAK,cAAc;IACpC,WAAW,MAAKD;IAChB,CAAC;GACF;;;;;;CAOF,MAAe,oBAAoB,OAAgD;EAClF,MAAM,gBAAgB,kBACrB,mBACA,IAAI,YAAY,CAAC,UAAU,MAAM,CAAC,SAAS,CAC3C;EACD,MAAM,EAAE,cAAc,MAAM,MAAKE,aAAc,gBAC9C,MAAKD,gBACL,cACA;AAED,SAAO;GACN,OAAO,SAAS,MAAM;GACtB,WAAW,sBAAsB;IAChC;IACA,iBAAiB,KAAK,cAAc;IACpC,WAAW,MAAKD;IAChB,CAAC;GACF;;;;;;;CAQF,aAAa,mBACZ,gBACA,cACA,WACC;EACD,MAAM,EAAE,cAAc,MAAM,aAAa,aAAa,eAAe;AACrE,MAAI,CAAC,UACJ,OAAM,IAAI,MAAM,wCAAwC;AAGzD,SAAO,IAAI,aAAa;GACvB;GACA,WAAW,IAAI,iBAAiB,UAAU;GAC1C;GACA;GACA,CAAC;;;;;;CAOH,AAAS,OAAc;AACtB,QAAM,IAAI,MAAM,kDAAkD;;;;;;CAOnE,AAAS,iBAAwB;AAChC,QAAM,IAAI,MAAM,kDAAkD"}

package/dist/objects.d.mts

@@ -0,0 +1,10 @@
+import { Transaction } from "@mysten/sui/transactions";
+import { ClientWithCoreApi } from "@mysten/sui/client";
+
+//#region src/objects.d.ts
+declare const getInputObjects: (transaction: Transaction, client: ClientWithCoreApi) => Promise<{
+  bcsObjects: Uint8Array<ArrayBuffer>[];
+}>;
+//#endregion
+export { getInputObjects };
+//# sourceMappingURL=objects.d.mts.map

package/dist/objects.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.mts","names":[],"sources":["../src/objects.ts"],"mappings":";;;;cAMa,eAAA,GAAyB,WAAA,EAAa,WAAA,EAAa,MAAA,EAAQ,iBAAA,KAAiB,OAAA"}

package/dist/objects.mjs

@@ -0,0 +1,16 @@
+//#region src/objects.ts
+const getInputObjects = async (transaction, client) => {
+	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);
+	return { bcsObjects: (await client.core.getObjects({
+		objectIds: [...gasObjectIds, ...inputObjectIds],
+		include: { objectBcs: true }
+	})).objects.filter((obj) => !(obj instanceof Error)).map((object) => object.objectBcs).filter((bytes) => !!bytes) };
+};
+
+//#endregion
+export { getInputObjects };
+//# sourceMappingURL=objects.mjs.map

package/dist/objects.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.mjs","names":[],"sources":["../src/objects.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Transaction } from '@mysten/sui/transactions';\nimport type { ClientWithCoreApi } from '@mysten/sui/client';\n\nexport const getInputObjects = async (transaction: Transaction, client: ClientWithCoreApi) => {\n\tconst data = transaction.getData();\n\n\tconst gasObjectIds = data.gasData.payment?.map((object) => object.objectId) ?? [];\n\tconst inputObjectIds = data.inputs\n\t\t.map((input) => {\n\t\t\treturn input.$kind === 'Object' && input.Object.$kind === 'ImmOrOwnedObject'\n\t\t\t\t? input.Object.ImmOrOwnedObject.objectId\n\t\t\t\t: null;\n\t\t})\n\t\t.filter((objectId): objectId is string => !!objectId);\n\n\tconst response = await client.core.getObjects({\n\t\tobjectIds: [...gasObjectIds, ...inputObjectIds],\n\t\tinclude: {\n\t\t\tobjectBcs: true,\n\t\t},\n\t});\n\n\tconst bcsObjects = response.objects\n\t\t.filter((obj): obj is Exclude<typeof obj, Error> => !(obj instanceof Error))\n\t\t.map((object) => object.objectBcs)\n\t\t.filter((bytes): bytes is Uint8Array<ArrayBuffer> => !!bytes);\n\n\treturn { bcsObjects };\n};\n"],"mappings":";AAMA,MAAa,kBAAkB,OAAO,aAA0B,WAA8B;CAC7F,MAAM,OAAO,YAAY,SAAS;CAElC,MAAM,eAAe,KAAK,QAAQ,SAAS,KAAK,WAAW,OAAO,SAAS,IAAI,EAAE;CACjF,MAAM,iBAAiB,KAAK,OAC1B,KAAK,UAAU;AACf,SAAO,MAAM,UAAU,YAAY,MAAM,OAAO,UAAU,qBACvD,MAAM,OAAO,iBAAiB,WAC9B;GACF,CACD,QAAQ,aAAiC,CAAC,CAAC,SAAS;AActD,QAAO,EAAE,aAZQ,MAAM,OAAO,KAAK,WAAW;EAC7C,WAAW,CAAC,GAAG,cAAc,GAAG,eAAe;EAC/C,SAAS,EACR,WAAW,MACX;EACD,CAAC,EAE0B,QAC1B,QAAQ,QAA2C,EAAE,eAAe,OAAO,CAC3E,KAAK,WAAW,OAAO,UAAU,CACjC,QAAQ,UAA4C,CAAC,CAAC,MAAM,EAEzC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@mysten/ledger-signer",
+  "author": "Mysten Labs <build@mystenlabs.com>",
+  "description": "Sui signer for Ledger hardware wallets",
+  "homepage": "https://sdk.mystenlabs.com",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "dist",
+    "src"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MystenLabs/ts-sdks.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mystenlabs/ts-sdks/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@mysten/ledgerjs-hw-app-sui": "^0.8.1"
+  },
+  "peerDependencies": {
+    "@mysten/sui": "^2.16.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.8",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17",
+    "@mysten/sui": "^2.16.0"
+  },
+  "scripts": {
+    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "build": "rm -rf dist && tsc --noEmit && tsdown",
+    "prettier:check": "prettier -c --ignore-unknown .",
+    "prettier:fix": "prettier -w --ignore-unknown .",
+    "oxlint:check": "oxlint  .",
+    "oxlint:fix": "oxlint --fix",
+    "lint": "pnpm run oxlint:check && pnpm run prettier:check",
+    "lint:fix": "pnpm run oxlint:fix && pnpm run prettier:fix",
+    "test": "vitest run --passWithNoTests"
+  }
+}

package/src/index.ts

@@ -0,0 +1,163 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type SuiLedgerClient from '@mysten/ledgerjs-hw-app-sui';
+import type { ClientWithCoreApi } from '@mysten/sui/client';
+import type { SignatureWithBytes } from '@mysten/sui/cryptography';
+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 { bcs } from '@mysten/sui/bcs';
+import { getInputObjects } from './objects.js';
+import type { Resolution } from '@mysten/ledgerjs-hw-app-sui';
+
+export { getInputObjects } from './objects.js';
+
+/**
+ * Configuration options for initializing the LedgerSigner.
+ */
+export interface LedgerSignerOptions {
+	publicKey: Ed25519PublicKey;
+	derivationPath: string;
+	ledgerClient: SuiLedgerClient;
+	suiClient: ClientWithCoreApi;
+}
+
+/**
+ * Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.
+ */
+export class LedgerSigner extends Signer {
+	#derivationPath: string;
+	#publicKey: Ed25519PublicKey;
+	#ledgerClient: SuiLedgerClient;
+	#suiClient: ClientWithCoreApi;
+
+	/**
+	 * 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) {
+		super();
+		this.#publicKey = publicKey;
+		this.#derivationPath = derivationPath;
+		this.#ledgerClient = ledgerClient;
+		this.#suiClient = suiClient;
+	}
+
+	/**
+	 * Retrieves the key scheme used by this signer.
+	 */
+	override getKeyScheme() {
+		return 'ED25519' as const;
+	}
+
+	/**
+	 * Retrieves the public key associated with this signer.
+	 * @returns The Ed25519PublicKey instance.
+	 */
+	override getPublicKey() {
+		return this.#publicKey;
+	}
+
+	/**
+	 * Signs the provided transaction bytes.
+	 * @returns The signed transaction bytes and signature.
+	 */
+	override async signTransaction(
+		bytes: Uint8Array,
+		bcsObjects?: Uint8Array[],
+		resolution?: Resolution,
+	): Promise<SignatureWithBytes> {
+		const transactionOptions = bcsObjects
+			? { bcsObjects }
+			: await getInputObjects(Transaction.from(bytes), this.#suiClient).catch(() => ({
+					// Fail gracefully so network errors or serialization issues don't break transaction signing:
+					bcsObjects: [],
+				}));
+
+		const intentMessage = messageWithIntent('TransactionData', bytes);
+		const { signature } = await this.#ledgerClient.signTransaction(
+			this.#derivationPath,
+			intentMessage,
+			transactionOptions,
+			resolution,
+		);
+
+		return {
+			bytes: toBase64(bytes),
+			signature: toSerializedSignature({
+				signature,
+				signatureScheme: this.getKeyScheme(),
+				publicKey: this.#publicKey,
+			}),
+		};
+	}
+
+	/**
+	 * Signs the provided personal message.
+	 * @returns The signed message bytes and signature.
+	 */
+	override async signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes> {
+		const intentMessage = messageWithIntent(
+			'PersonalMessage',
+			bcs.byteVector().serialize(bytes).toBytes(),
+		);
+		const { signature } = await this.#ledgerClient.signTransaction(
+			this.#derivationPath,
+			intentMessage,
+		);
+
+		return {
+			bytes: toBase64(bytes),
+			signature: toSerializedSignature({
+				signature,
+				signatureScheme: this.getKeyScheme(),
+				publicKey: 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: string,
+		ledgerClient: SuiLedgerClient,
+		suiClient: ClientWithCoreApi,
+	) {
+		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.
+	 */
+	override sign(): never {
+		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.
+	 */
+	override signWithIntent(): never {
+		throw new Error('Ledger Signer does not support generic signing.');
+	}
+}

package/src/objects.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Transaction } from '@mysten/sui/transactions';
+import type { ClientWithCoreApi } from '@mysten/sui/client';
+
+export const getInputObjects = async (transaction: Transaction, client: ClientWithCoreApi) => {
+	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 is string => !!objectId);
+
+	const response = await client.core.getObjects({
+		objectIds: [...gasObjectIds, ...inputObjectIds],
+		include: {
+			objectBcs: true,
+		},
+	});
+
+	const bcsObjects = response.objects
+		.filter((obj): obj is Exclude<typeof obj, Error> => !(obj instanceof Error))
+		.map((object) => object.objectBcs)
+		.filter((bytes): bytes is Uint8Array<ArrayBuffer> => !!bytes);
+
+	return { bcsObjects };
+};