Hyperliquid Signer Kit

This module provides the implementation of the Ledger hyperliquid signer of the Device Management Kit. It enables interaction with the hyperliquid application on a Ledger device including:

Signing a hyperliquid actions

🔹 Index

How it works
Installation
Initialisation
Use Cases
- Sign Actions
Observable Behavior
Example

🔹 How it works

The Ledger Hyperliquid 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 APDUs (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.

🔹 Installation

Note: This module is not standalone; it depends on the @ledgerhq/device-management-kit package, so you need to install it first.

To install the device-signer-kit-hyperliquid package, run the following command:

npm install @ledgerhq/device-signer-kit-hyperliquid

🔹 Initialisation

To initialise a Hyperliquid signer instance, you need a Ledger Device Management Kit instance and the ID of the session of the connected device. Use the SignerHyperliquidBuilder:

const signerHyperliquid = new SignerHyperliquidBuilder({
  dmk,
  sessionId,
}).build();

🔹 Use Cases

The SignerHyperliquidBuilder.build() method will return a SignerHyperliquid 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.

Use Case 1: Sign Actions

This method allows users to sign hyperliquid actions.

const { observable, cancel } = signerHyperliquid.signActions(
  derivationPath,
  transaction,
  options,
);

Parameters

derivationPath
- Required
- Type: string (e.g., "m/44'/0'/0'/0/0")
- The derivation path used for the hyperliquid transaction. See here for more information.
transaction
- Required
- Type: Uint8Array
- The serialized transaction to be signed.
options
- Optional
- Type: TransactionOptions
```
type TransactionOptions = {
  skipOpenApp?: boolean;
};
```
- skipOpenApp: An optional boolean indicating whether to skip opening the hyperliquid app automatically (true) or not (false).

Returns

observable Emits DeviceActionState updates, including the following details:

type Signature = {
  r: string;
  s: string;
  v?: number;
};

cancel A function to cancel the action on the Ledger device.

🔹 Observable Behavior

Each method returns an Observable emitting updates structured as DeviceActionState. These updates reflect the operation’s progress and status:

NotStarted: The operation hasn’t started.
Pending: The operation is in progress and may require user interaction.
Stopped: The operation was canceled or stopped.
Completed: The operation completed successfully, with results available.
Error: An error occurred.

Example Observable Subscription:

observable.subscribe({
  next: (state: DeviceActionState) => {
    switch (state.status) {
      case DeviceActionStatus.NotStarted: {
        console.log("The action is not started yet.");
        break;
      }
      case DeviceActionStatus.Pending: {
        const {
          intermediateValue: { requiredUserInteraction },
        } = state;
        // Access the intermediate value here, explained below
        console.log(
          "The action is pending and the intermediate value is: ",
          intermediateValue,
        );
        break;
      }
      case DeviceActionStatus.Stopped: {
        console.log("The action has been stopped.");
        break;
      }
      case DeviceActionStatus.Completed: {
        const { output } = state;
        // Access the output of the completed action here
        console.log("The action has been completed: ", output);
        break;
      }
      case DeviceActionStatus.Error: {
        const { error } = state;
        // Access the error here if occurred
        console.log("An error occurred during the action: ", error);
        break;
      }
    }
  },
});

Intermediate Values in Pending Status:

When the status is DeviceActionStatus.Pending, the state will include an intermediateValue object that provides useful information for interaction:

const { requiredUserInteraction } = intermediateValue;
 
switch (requiredUserInteraction) {
  case UserInteractionRequired.SignTransaction: {
    // User needs to sign the transaction displayed on the device
    console.log("User needs to sign the transaction displayed on the device.");
    break;
  }
  case UserInteractionRequired.SignPersonalMessage: {
    // User needs to sign the message displayed on the device
    console.log("User needs to sign the message displayed on the device.");
    break;
  }
  case UserInteractionRequired.None: {
    // No user action required
    console.log("No user action needed.");
    break;
  }
  case UserInteractionRequired.UnlockDevice: {
    // User needs to unlock the device
    console.log("The user needs to unlock the device.");
    break;
  }
  case UserInteractionRequired.ConfirmOpenApp: {
    // User needs to confirm on the device to open the app
    console.log("The user needs to confirm on the device to open the app.");
    break;
  }
  default:
    // Type guard to ensure all cases are handled
    const uncaughtUserInteraction: never = requiredUserInteraction;
    console.error("Unhandled user interaction case:", uncaughtUserInteraction);
}

🔹 Example

We encourage you to explore the Hyperliquid Signer by trying it out in our online sample application. Experience how it works and see its capabilities in action. Of course, you will need a Ledger device connected.

Signer Bitcoin Signer Cosmos