|
| 1 | +# Polkadot Signer Kit |
| 2 | + |
| 3 | +This module provides the implementation of the Ledger polkadot signer of the Device Management Kit. It enables interaction with the polkadot application on a Ledger device including: |
| 4 | + |
| 5 | +- Retrieving the polkadot address using a given derivation path |
| 6 | +- Signing a polkadot transaction |
| 7 | + |
| 8 | +## 🔹 Index |
| 9 | + |
| 10 | +1. [How it works](#-how-it-works) |
| 11 | +2. [Installation](#-installation) |
| 12 | +3. [Initialisation](#-initialisation) |
| 13 | +4. [Use Cases](#-use-cases) |
| 14 | + - [Get Address](#use-case-1-get-address) |
| 15 | + - [Sign Transaction](#use-case-2-sign-transaction) |
| 16 | +5. [Observable Behavior](#-observable-behavior) |
| 17 | +6. [Example](#-example) |
| 18 | + |
| 19 | +## 🔹 How it works |
| 20 | + |
| 21 | +The Ledger Polkadot Signer utilizes the advanced capabilities of the Ledger device to provide secure operations for end users. It takes advantage of the interface provided by the Device Management Kit to establish communication with the Ledger device and execute various operations. The communication with the Ledger device is performed using [APDU](https://en.wikipedia.org/wiki/Smart_card_application_protocol_data_unit)s (Application Protocol Data Units), which are encapsulated within the `Command` object. These commands are then organized into tasks, allowing for the execution of complex operations with one or more APDUs. The tasks are further encapsulated within `DeviceAction` objects to handle different real-world scenarios. Finally, the Signer exposes dedicated and independent use cases that can be directly utilized by end users. |
| 22 | + |
| 23 | +## 🔹 Installation |
| 24 | + |
| 25 | +> **Note:** This module is not standalone; it depends on the [@ledgerhq/device-management-kit](https://github.com/LedgerHQ/device-sdk-ts/tree/develop/packages/device-management-kit) package, so you need to install it first. |
| 26 | +
|
| 27 | +To install the `device-signer-kit-polkadot` package, run the following command: |
| 28 | + |
| 29 | +```sh |
| 30 | +npm install @ledgerhq/device-signer-kit-polkadot |
| 31 | +``` |
| 32 | + |
| 33 | +## 🔹 Initialisation |
| 34 | + |
| 35 | +To initialise a Polkadot signer instance, you need a Ledger Device Management Kit instance and the ID of the session of the connected device. Use the `SignerPolkadotBuilder`: |
| 36 | + |
| 37 | +```typescript |
| 38 | +const signerPolkadot = new SignerPolkadotBuilder({ dmk, sessionId }).build(); |
| 39 | +``` |
| 40 | + |
| 41 | +## 🔹 Use Cases |
| 42 | + |
| 43 | +The `SignerPolkadotBuilder.build()` method will return a `SignerPolkadot` instance that exposes 2 dedicated methods, each of which calls an independent use case. Each use case will return an object that contains an observable and a method called `cancel`. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +### Use Case 1: Get Address |
| 48 | + |
| 49 | +This method allows users to retrieve the polkadot address based on a given `derivationPath`. |
| 50 | + |
| 51 | +```typescript |
| 52 | +const { observable, cancel } = signerPolkadot.getAddress( |
| 53 | + derivationPath, |
| 54 | + ss58Prefix, |
| 55 | + options, |
| 56 | +); |
| 57 | +``` |
| 58 | + |
| 59 | +#### **Parameters** |
| 60 | + |
| 61 | +- `derivationPath` |
| 62 | + |
| 63 | + - **Required** |
| 64 | + - **Type:** `string` (e.g., `"m/44'/0'/0'/0/0"`) |
| 65 | + - The derivation path used for the polkadot address. See [here](https://www.ledger.com/blog/understanding-crypto-addresses-and-derivation-paths) for more information. |
| 66 | + |
| 67 | +- `ss58Prefix` |
| 68 | + |
| 69 | + - **Required** |
| 70 | + - **Type:** `number` (e.g., `0` for Polkadot, `42` for Bittensor) |
| 71 | + - The SS58 address format prefix for the target network. |
| 72 | + |
| 73 | +- `options` |
| 74 | + |
| 75 | + - Optional |
| 76 | + - Type: `AddressOptions` |
| 77 | + |
| 78 | + ```typescript |
| 79 | + type AddressOptions = { |
| 80 | + checkOnDevice?: boolean; |
| 81 | + skipOpenApp?: boolean; |
| 82 | + }; |
| 83 | + ``` |
| 84 | + |
| 85 | + - `checkOnDevice`: An optional boolean indicating whether user confirmation on the device is required (`true`) or not (`false`). |
| 86 | + - `skipOpenApp`: An optional boolean indicating whether to skip opening the polkadot app automatically (`true`) or not (`false`). |
| 87 | + |
| 88 | +#### **Returns** |
| 89 | + |
| 90 | +- `observable` Emits DeviceActionState updates, including the following details: |
| 91 | + |
| 92 | +```typescript |
| 93 | +type GetAddressCommandResponse = { |
| 94 | + publicKey: Uint8Array; |
| 95 | + chainCode?: Uint8Array; |
| 96 | +}; |
| 97 | +``` |
| 98 | + |
| 99 | +- `cancel` A function to cancel the action on the Ledger device. |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +### Use Case 2: Sign Transaction |
| 104 | + |
| 105 | +This method allows users to sign a polkadot transaction. |
| 106 | + |
| 107 | +```typescript |
| 108 | +const { observable, cancel } = signerPolkadot.signTransaction( |
| 109 | + derivationPath, |
| 110 | + blob, |
| 111 | + metadata, |
| 112 | + options, |
| 113 | +); |
| 114 | +``` |
| 115 | + |
| 116 | +#### **Parameters** |
| 117 | + |
| 118 | +- `derivationPath` |
| 119 | + |
| 120 | + - **Required** |
| 121 | + - **Type:** `string` (e.g., `"m/44'/0'/0'/0/0"`) |
| 122 | + - The derivation path used for the polkadot transaction. See [here](https://www.ledger.com/blog/understanding-crypto-addresses-and-derivation-paths) for more information. |
| 123 | + |
| 124 | +- `blob` |
| 125 | + |
| 126 | + - **Required** |
| 127 | + - **Type:** `Uint8Array` |
| 128 | + - The SCALE-encoded transaction payload to be signed. |
| 129 | + |
| 130 | +- `metadata` |
| 131 | + |
| 132 | + - **Required** |
| 133 | + - **Type:** `Uint8Array` |
| 134 | + - The metadata proof used for transaction clear signing (Ledger Polkadot generic app). |
| 135 | + |
| 136 | +- `options` |
| 137 | + |
| 138 | + - Optional |
| 139 | + - Type: `TransactionOptions` |
| 140 | + |
| 141 | + ```typescript |
| 142 | + type TransactionOptions = { |
| 143 | + skipOpenApp?: boolean; |
| 144 | + }; |
| 145 | + ``` |
| 146 | + |
| 147 | + - `skipOpenApp`: An optional boolean indicating whether to skip opening the polkadot app automatically (`true`) or not (`false`). |
| 148 | + |
| 149 | +#### **Returns** |
| 150 | + |
| 151 | +- `observable` Emits DeviceActionState updates, including the following details: |
| 152 | + |
| 153 | +```typescript |
| 154 | +type Signature = Uint8Array; |
| 155 | +``` |
| 156 | + |
| 157 | +- `cancel` A function to cancel the action on the Ledger device. |
| 158 | + |
| 159 | +--- |
| 160 | + |
| 161 | +## 🔹 Observable Behavior |
| 162 | + |
| 163 | +Each method returns an [Observable](https://rxjs.dev/guide/observable) emitting updates structured as [`DeviceActionState`](https://github.com/LedgerHQ/device-sdk-ts/blob/develop/packages/device-management-kit/src/api/device-action/model/DeviceActionState.ts). These updates reflect the operation's progress and status: |
| 164 | + |
| 165 | +- **NotStarted**: The operation hasn't started. |
| 166 | +- **Pending**: The operation is in progress and may require user interaction. |
| 167 | +- **Stopped**: The operation was canceled or stopped. |
| 168 | +- **Completed**: The operation completed successfully, with results available. |
| 169 | +- **Error**: An error occurred. |
| 170 | + |
| 171 | +**Example Observable Subscription:** |
| 172 | + |
| 173 | +```typescript |
| 174 | +observable.subscribe({ |
| 175 | + next: (state: DeviceActionState) => { |
| 176 | + switch (state.status) { |
| 177 | + case DeviceActionStatus.NotStarted: { |
| 178 | + console.log("The action is not started yet."); |
| 179 | + break; |
| 180 | + } |
| 181 | + case DeviceActionStatus.Pending: { |
| 182 | + const { |
| 183 | + intermediateValue: { requiredUserInteraction }, |
| 184 | + } = state; |
| 185 | + // Access the intermediate value here, explained below |
| 186 | + console.log( |
| 187 | + "The action is pending and the intermediate value is: ", |
| 188 | + intermediateValue, |
| 189 | + ); |
| 190 | + break; |
| 191 | + } |
| 192 | + case DeviceActionStatus.Stopped: { |
| 193 | + console.log("The action has been stopped."); |
| 194 | + break; |
| 195 | + } |
| 196 | + case DeviceActionStatus.Completed: { |
| 197 | + const { output } = state; |
| 198 | + // Access the output of the completed action here |
| 199 | + console.log("The action has been completed: ", output); |
| 200 | + break; |
| 201 | + } |
| 202 | + case DeviceActionStatus.Error: { |
| 203 | + const { error } = state; |
| 204 | + // Access the error here if occurred |
| 205 | + console.log("An error occurred during the action: ", error); |
| 206 | + break; |
| 207 | + } |
| 208 | + } |
| 209 | + }, |
| 210 | +}); |
| 211 | +``` |
| 212 | + |
| 213 | +**Intermediate Values in Pending Status:** |
| 214 | + |
| 215 | +When the status is DeviceActionStatus.Pending, the state will include an `intermediateValue` object that provides useful information for interaction: |
| 216 | + |
| 217 | +```typescript |
| 218 | +const { requiredUserInteraction } = intermediateValue; |
| 219 | + |
| 220 | +switch (requiredUserInteraction) { |
| 221 | + case UserInteractionRequired.VerifyAddress: { |
| 222 | + // User needs to verify the address displayed on the device |
| 223 | + console.log("User needs to verify the address displayed on the device."); |
| 224 | + break; |
| 225 | + } |
| 226 | + case UserInteractionRequired.SignTransaction: { |
| 227 | + // User needs to sign the transaction displayed on the device |
| 228 | + console.log("User needs to sign the transaction displayed on the device."); |
| 229 | + break; |
| 230 | + } |
| 231 | + case UserInteractionRequired.SignPersonalMessage: { |
| 232 | + // User needs to sign the message displayed on the device |
| 233 | + console.log("User needs to sign the message displayed on the device."); |
| 234 | + break; |
| 235 | + } |
| 236 | + case UserInteractionRequired.None: { |
| 237 | + // No user action required |
| 238 | + console.log("No user action needed."); |
| 239 | + break; |
| 240 | + } |
| 241 | + case UserInteractionRequired.UnlockDevice: { |
| 242 | + // User needs to unlock the device |
| 243 | + console.log("The user needs to unlock the device."); |
| 244 | + break; |
| 245 | + } |
| 246 | + case UserInteractionRequired.ConfirmOpenApp: { |
| 247 | + // User needs to confirm on the device to open the app |
| 248 | + console.log("The user needs to confirm on the device to open the app."); |
| 249 | + break; |
| 250 | + } |
| 251 | + default: |
| 252 | + // Type guard to ensure all cases are handled |
| 253 | + const uncaughtUserInteraction: never = requiredUserInteraction; |
| 254 | + console.error("Unhandled user interaction case:", uncaughtUserInteraction); |
| 255 | +} |
| 256 | +``` |
| 257 | + |
| 258 | +## 🔹 Example |
| 259 | + |
| 260 | +We encourage you to explore the Polkadot Signer by trying it out in our online [sample application](https://app.devicesdk.ledger-test.com/). Experience how it works and see its capabilities in action. Of course, you will need a Ledger device connected. |
0 commit comments