It is strongly recommended to take a few minutes to read this document. You need to make sure to fully understand how the Ledger hardware wallet works in combination with the Shimmer network.
- Shimmer App for Ledger Hardware Wallets
Shimmer is an unique cryptocurrency with specific design considerations that must be taken into account. This document explains how the Ledger hardware wallet works and how to stay safe when using a Ledger to store Shimmer funds.
Seed: A single secret key from which all private keys are derived (aka "24 words", BIP39).
Private Key: Private keys are derived from the seed (BIP32 with ED25519 curve, SLIP10. The private key is used to generate a public key. The private key is also used to prove that you own said public key by means of creating a signature for a specific transaction.
Public Key: The public part of a private/public key pair.
Address: A hashed representation of the public key that is used to receive funds.
Input: The unspent transaction output (UTXO) from which funds are transfered.
Output: The address to which funds are transfered.
Change/Remainder: After sending funds to a 3rd party, all remaining funds on the account must be transferred to a new address - this is called the change or remainder address.
A block is mainly just a group of inputs and outputs. If Bob has 10SMR and he wants to send 3SMR to Alice then the block could look like this:
input: Bob -10SMR
output: Alice +3SMR
output: Bob +7SMR (change output / remainder)
This example highlights how the Shimmer network handles blocks. First an input of 10SMR from Bob's address is used. After this 3SMR are sent to Alice and the remaining funds are sent to a new address belonging to Bob's seed.
All inputs require the private key to generate signatures which prove that you own the funds.
Because blocks are atomic units, the network will never accept Bob's input of -10SMR without accepting sending 3SMR to Alice and 7SMR to a new address owned by Bob (in this example). This new address where the remaining funds are sent to is called remainder address.
A Shimmer block is split into different parts. The first part is to create a block and signatures for this block.
The second part is to attach this block to the tangle. Therefore the block needs between one and eight tip messages which are requested from a node of the Shimmer network.
The Ledger hardware wallet is only responsible for generating signatures for a specific block. After that the host machine (or anybody else for that matter) can take the signatures and broadcast it to the network (however the signatures are only valid for the specific block).
The Ledger hardware wallet works by deterministically generating Shimmer keys based on your 24 word mnemonic (created when setting up the device).
Instead of storing the seed on your computer (which could be stolen by an attacker) the seed is only stored on the Ledger device itself. This ensures that the seed is never sent to the host machine it is connected to.
Instead the host machine needs to ask the Ledger device to provide the information (such as public keys or signatures). When blocks are created the host generates an unsigned block and sends it to the Ledger device for signing. The Ledger uses the private keys associated with the inputs to generate unique signatures and transmits only the signatures to the host machine.
The host is then able to use these signatures (which are only valid for that specific block) to broadcast the block to the network. However, as you can see, neither the seed nor any of the private keys ever leave the Ledger device.
See Ledger's documentation to get more info about the inner workings of the Ledger hardware wallets.
-
Display Address: The wallet is able to ask the Ledger device to display the address for a specific index of the seed. It only accepts the index and subsequently generates the address itself. It thus verifies that the address belongs to the corresponding Ledger.
Note: Only the remainder address (shown as "Remainder") will be verified as belonging to the Ledger. Outputs shown as "Send To" are not.
-
Sign Transaction: The wallet will generate a block for the user to approve before the Ledger signs it. Ensure all amounts and addresses are correct before signing. These signatures are then sent back to the host machine.
-
Blindsigning: There are outputs or features that are only supported in blindsigning mode. In this case the Ledger Nano will display an hash to accept or reject.
Blindsigning has to be enabled first in the settings menu. In case it is not enabled, it will show this screen with the only option to reject the signing:
-
Internal Transfer: In case there is only one output address and it matches any of the input addresses, the Ledger Nano will show "Internal Transfer" on the display with the info that no funds will leave the hardware wallet. This will be the case for voting or staking or for sweeping transactions that move the funds from a number of addresses to a single one.
-
Shimmer Claiming: There is a special mode that allows to claim SMR coins from IOTA addresses. In Claiming mode the app will warn about signing a transaction for the Shimmer network with IOTA private keys:
... IOTA private keys instead of SMR private keys. Are you really sure you want to proceed?
All warnings on the Ledger are there for a reason. MAKE SURE TO READ THEM and refer to this document if there is any confusion.
-
Don't rush through signing a block. Before a block is signed all outputs of a block are shown on the display. The user can scroll through the individual outputs and finally choose whether to sign the block ("Accept") or not ("Reject").
Outputs that go to 3rd party addresses are shown on the display with "Send To". The address to which the rest is sent is shown as "remainder".
In addition to the amount the remainder also shows the BIP32 path. This address is calculated on the Ledger and ensures that the rest of the SMR funds are sent to an address owned by the Ledger device.
If the input amount perfectly matches the output amount then there will be no remainder. If there is no remainder, double check that you are sending the proper amount to the proper address because there is no remainder being sent back to your seed.
Due to the memory limitations of the Ledger Nano S/X, the blocks have certain restrictions. The Ledger Nano S can only accept blocks with about 17 inputs/outputs (e.g. 4 inputs, 13 outputs). The Ledger Nano X has the ability to accept blocks with approximately 180 inputs/outputs.
Hopefully you wrote down your 24 recovery words and your optional passphrase in a safe place. If not, all your funds are lost.
If you did, the best solution is to buy a new Ledger and enter your 24 recovery words and your optional passphrase in the new device.
After installation of the Shimmer Ledger app, all your funds are restored. Take care to reinitialize your seed index correctly.
You either can
- run the app in a Ledger Nano S/X/S+ simulator or
- load the app on your read Ledger Nano S/S+
- Clone this repository
- Ensure that all git submodules are initialized
git submodule update --init --recursive
Using the build.sh script is highly recommended because it uses official Docker images for building the app and running the Speculos simulator.
./build.sh -m (nanos*|nanox|nanosplus)
The app can be built by:
./build.sh -m (nanos*|nanox|nanosplus) -s
The simulator will open the port 9999 for APDU commands and provide a web-interface on port 5000.
The app can be built and installed in the following way:
- Connect your Ledger to the computer and unlock it
- To load the app, be sure that the dashboard is opened on the Ledger
- Run the following command to compile the app from source and load it
./build.sh -m (nanos*|nanox|nanosplus) -l - Accept all the messages on the Ledger
*: Default is nanos if parameter is not specified