alephiumSignMessage

Use requirement

• Firmware version required
  • UKey Lite 24 / UKey Lite 25 / UKey Core 26: 4.10.0

Alephium: sign message

Sign a message using the private key derived by given BIP32 path. User needs to confirm the action on Ukey Wallet device.

// Original message
const message = "Hello Alephium";

// Convert to hex
const messageHex = Buffer.from(message).toString("hex");

const result = await HardwareSDK.alephiumSignMessage(connectId, deviceId, {
  path: "m/44'/1234'/0'/0/0",
  messageHex, // "Hello Alephium" in hex
  messageType: "alephium",
});

Params

Optional common params

• path - required string | Array<number> minimum length is 3
• messageHex - required string message to sign in hexadecimal format
• messageType - optional string type of message signing algorithm (default: "alephium")

Example

// Original message
const message = "Hello Alephium";

// Convert to hex
const messageHex = Buffer.from(message).toString("hex");

const response = await HardwareSDK.alephiumSignMessage(connectId, deviceId, {
  path: "m/44'/1234'/0'/0/0",
  messageHex,
  messageType: "alephium",
});

Result

{
    success: true,
    payload: {
        signature: string;
        address: string;
    }
}

Error

{
    success: false,
    payload: {
        error: string, // error message
        code: number // error code
    }
}