@ledgerhq/live-common
Version:
Common ground for the Ledger Live apps
23 lines • 1.24 kB
TypeScript
import type { SocketEvent } from "@ledgerhq/types-live";
import { Observable } from "rxjs";
export type GetGenuineCheckFromDeviceIdArgs = {
deviceId: string;
deviceName: string | null;
lockedDeviceTimeoutMs?: number;
};
export type GetGenuineCheckFromDeviceIdResult = {
socketEvent: SocketEvent | null;
lockedDevice: boolean;
};
export type GetGenuineCheckFromDeviceIdOutput = Observable<GetGenuineCheckFromDeviceIdResult>;
/**
* Get a genuine check for a device only from its id
* @param deviceId A device id, or an empty string if device is usb plugged
* @param lockedDeviceTimeoutMs Time of no response from device after which the device is considered locked, in ms. Default 1000ms.
* @returns An Observable pushing objects containing:
* - socketEvent: a SocketEvent giving the current status of the genuine check,
* null if the genuine check process did not reach any state yet
* - lockedDevice: a boolean set to true if the device is currently locked, false otherwise
*/
export declare const getGenuineCheckFromDeviceId: ({ deviceId, deviceName, lockedDeviceTimeoutMs, }: GetGenuineCheckFromDeviceIdArgs) => GetGenuineCheckFromDeviceIdOutput;
//# sourceMappingURL=getGenuineCheckFromDeviceId.d.ts.map