Ledger Signer

[PhilippeR26]

Motivation and Resolution

Solves #1168

As Starknet is now handled by the Ledger Nano S+ / X, we can create a signer that handle the private keys of this hardware wallet.

Usage related changes

After installing the Starknet Ledger DAPP in your Ledger, you can use the Ledger as signer.
The way to proceed depends of the type of connection, and of the framework used (see the guide for more details).
For example, in a Node script, using a Ledger Nano + :

import TransportNodeHid from '@ledgerhq/hw-transport-node-hid';
const myLedgerTransport: Transport = await TransportNodeHid.create();
const myLedgerSigner = new LedgerSigner(myLedgerTransport, 0);
const pubK = await myLedgerSigner.getPubKey();
const fullPubK = await myLedgerSigner.getFullPubKey();
// ...
// deploy here an account related to this public key
// ...
const ledgerAccount = new Account(myProvider, ledger0addr, myLedgerSigner);

Then you can use all usual methods of the Account class. When a signature is necessary, a message is displayed on the Ledger screen, and a manual validation is requested.
By this way, the private key of the account is never exposed.

The signature guide has been amended to include the Ledger Signer.

Development related changes

• A new class has been added in the signer directory.
• As the transport library to use depends of the framework, its creation has to be outside of Starknet.js (impossible to build using the native libs or the node libs).
• tests : of course automated tests are impossible. Just the new utils functions are tested. Nevertheless, the Nodes and Web USB connections have been tested in separated repos :
  Nodes USB : https://github.com/PhilippeR26/starknet.js-workshop-typescript/blob/main/src/scripts/ledgerNano/5.testLedgerAccount.ts
  Web USB : https://github.com/PhilippeR26/Starknet-Ledger-Wallet (the 3 types of signatures are tested)

Checklist:

• Performed a self-review of the code
• Rebased to the last commit of the target branch (or merged it into my branch)
• Linked the issues which this PR resolves
• Documented the changes in code (API docs will be generated automatically)
• Updated the tests
• All tests are passing

[tabaktoni]

🥇 LFG
LGTM!

[github-actions]

🎉 This issue has been resolved in version 6.12.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀