@ledgerhq/ledger-key-ring-protocol 0.5.1-fix-build-number-pre.0

package/lib-es/types.d.ts

@@ -0,0 +1,181 @@
+import { Observable } from "rxjs";
+import Transport from "@ledgerhq/hw-transport";
+import { TrustchainsResponse } from "./api";
+/**
+ * The JWT is a JSON Web Token that is used to authenticate the user.
+ */
+export type JWT = {
+    accessToken: string;
+    permissions: {
+        [trustchainId: string]: {
+            [path: string]: string[];
+        };
+    };
+};
+/**
+ * A function which allow all interactions with the hardware device.
+ */
+export type WithDevice = (deviceId: string, options?: {
+    openTimeoutMs?: number;
+}) => <T>(fn: (transport: Transport) => Observable<T>) => Observable<T>;
+/**
+ * A Trustchain contains the identifier and the contextual data we need to manage members and encrypt/decrypt data.
+ */
+export type Trustchain = {
+    /**
+     * The immutable id of the trustchain root
+     */
+    rootId: string;
+    /**
+     * The secret used to encrypt/decrypt the wallet sync data
+     */
+    walletSyncEncryptionKey: string;
+    /**
+     * The derivation path on which the current walletSyncEncryptionKey value is stored
+     */
+    applicationPath: string;
+};
+/**
+ * The Trustchain member credentials are stored on each client, with the privatekey only known by the current client.
+ */
+export type MemberCredentials = {
+    /**
+     * The public key of the member (in hexadecimal)
+     */
+    pubkey: string;
+    /**
+     * The private key of the member (in hexadecimal)
+     */
+    privatekey: string;
+};
+/**
+ * A member of the trustchain
+ */
+export type TrustchainMember = {
+    /**
+     * The id of the member. It corresponds to the MemberCredentials.pubkey
+     */
+    id: string;
+    /**
+     * The name of the member as displayed in the UI
+     */
+    name: string;
+    /**
+     * a technical permissions of the member. it will often just be Permissions.OWNER
+     */
+    permissions: number;
+};
+/**
+ * The TrustchainSDKContext is a context that is used to initialize the TrustchainSDK.
+ */
+export type TrustchainSDKContext = {
+    applicationId: number;
+    name: string;
+    apiBaseUrl: string;
+};
+/**
+ * provide global callbacks for specific lifecycles.
+ * this allows us to decouple trustchain with the rest of Ledger Live.
+ * For now, we only introduce very specific hooks we need.
+ */
+export type TrustchainLifecycle = {
+    /**
+     * called when a trustchain rotation is occuring
+     * the first function is called when the rotation is starting
+     * the second function is called when the rotation is done.
+     *
+     * in that case, we typically want to delete all other resources depending on it.
+     * we do this with the existing jwt token before refreshing it.
+     */
+    onTrustchainRotation: (trustchainSdk: TrustchainSDK, oldTrustchain: Trustchain, memberCredentials: MemberCredentials) => Promise<(newTrustchain: Trustchain) => Promise<void>>;
+};
+export declare enum TrustchainResultType {
+    created = "created",
+    updated = "updated",
+    restored = "restored"
+}
+/**
+ * the trustchain with a result type indicating what happened during getOrCreateTrustchain
+ */
+export type TrustchainResult = {
+    type: TrustchainResultType.created;
+    trustchain: Trustchain;
+} | {
+    type: TrustchainResultType.updated;
+    trustchain: Trustchain;
+} | {
+    type: TrustchainResultType.restored;
+    trustchain: Trustchain;
+};
+/**
+ * cache (default): the SDK will use the cached JWT if it's still valid, otherwise it will refresh it.
+ * refresh: the SDK will always refresh the JWT if possible.
+ * no-cache: the SDK will always request a new JWT.
+ */
+export type AuthCachePolicy = "no-cache" | "refresh" | "cache";
+/**
+ * The main interface for the UI to interact with the trustchain protocol.
+ *
+ * @example
+ *
+ * import { sdk } from "@ledgerhq/ledger-key-ring-protocol";
+ *
+ * sdk.getOrCreateTrustchain(deviceId, memberCredentials).then(trustchain => console.log(trustchain));
+ */
+export interface TrustchainSDK {
+    /**
+     * Generate the live credentials that represents a Live instance, member of the trustchain.
+     * This method is expected to be used the first time Ledger Live is opened (if Live never generated them before) and then persisted over the future user sessions of Ledger Live in order for the member to be able to authenticate and manage the trustchain.
+     */
+    initMemberCredentials(): Promise<MemberCredentials>;
+    /**
+     * Access a JWT from the TrustchainSDK. manage the reauthentication if needed.
+     * A trustchain must have been created and the Live instance must have been added as a member.
+     * The returned token will typically be used for regular operations like wallet sync.
+     */
+    withAuth<T>(trustchain: Trustchain, memberCredentials: MemberCredentials, f: (jwt: JWT) => Promise<T>, policy?: AuthCachePolicy, ignorePermissionsChecks?: boolean): Promise<T>;
+    /**
+     * This method will either create the required trustchains (root and application) or restore them.
+     * The returned trustchain will be initialized on the root level and also will have the branch derivation corresponding to the contextual applicationId.
+     * It will also have the wallet sync encryption key initialized.
+     * The latest jwt is also returned because it was potentially updated during the process.
+     */
+    getOrCreateTrustchain(deviceId: string, memberCredentials: MemberCredentials, callbacks?: GetOrCreateTrustchainCallbacks, topic?: Uint8Array, currentTrustchain?: Trustchain): Promise<TrustchainResult>;
+    /**
+     * Restore the current trustchain encryption key, typically due to a key rotation.
+     */
+    restoreTrustchain(trustchain: Trustchain, memberCredentials: MemberCredentials): Promise<Trustchain>;
+    /**
+     * list the current members of the application trustchain
+     */
+    getMembers(trustchain: Trustchain, memberCredentials: MemberCredentials): Promise<TrustchainMember[]>;
+    /**
+     * remove a member from the application trustchain
+     */
+    removeMember(deviceId: string, trustchain: Trustchain, memberCredentials: MemberCredentials, member: TrustchainMember, callbacks?: TrustchainDeviceCallbacks): Promise<Trustchain>;
+    /**
+     * add a member to the application trustchain
+     */
+    addMember(trustchain: Trustchain, memberCredentials: MemberCredentials, member: TrustchainMember): Promise<void>;
+    /**
+     * destroy the trustchain
+     */
+    destroyTrustchain(trustchain: Trustchain, memberCredentials: MemberCredentials): Promise<void>;
+    /**
+     * encrypt data with the trustchain encryption key
+     */
+    encryptUserData(trustchain: Trustchain, obj: object): Promise<Uint8Array>;
+    /**
+     * decrypt data with the trustchain encryption key
+     */
+    decryptUserData(trustchain: Trustchain, data: Uint8Array): Promise<Uint8Array>;
+    invalidateJwt(): void;
+}
+export interface TrustchainDeviceCallbacks {
+    onStartRequestUserInteraction?: () => void;
+    onEndRequestUserInteraction?: () => void;
+}
+export interface GetOrCreateTrustchainCallbacks extends TrustchainDeviceCallbacks {
+    onInitialResponse?: (trustchains: TrustchainsResponse) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib-es/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE;QACX,CAAC,YAAY,EAAE,MAAM,GAAG;YACtB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;SAC1B,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,KACjC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;;OAOG;IACH,oBAAoB,EAAE,CACpB,aAAa,EAAE,aAAa,EAC5B,aAAa,EAAE,UAAU,EACzB,iBAAiB,EAAE,iBAAiB,KACjC,OAAO,CAAC,CAAC,aAAa,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;CAC5D,CAAC;AAEF,oBAAY,oBAAoB;IAC9B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAEE,IAAI,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACnC,UAAU,EAAE,UAAU,CAAC;CACxB,GACD;IAEE,IAAI,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACnC,UAAU,EAAE,UAAU,CAAC;CACxB,GACD;IAEE,IAAI,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IACpC,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,qBAAqB,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEpD;;;;OAIG;IACH,QAAQ,CAAC,CAAC,EACR,UAAU,EAAE,UAAU,EACtB,iBAAiB,EAAE,iBAAiB,EACpC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,EAC3B,MAAM,CAAC,EAAE,eAAe,EACxB,uBAAuB,CAAC,EAAE,OAAO,GAChC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd;;;;;OAKG;IACH,qBAAqB,CACnB,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,iBAAiB,EACpC,SAAS,CAAC,EAAE,8BAA8B,EAC1C,KAAK,CAAC,EAAE,UAAU,EAClB,iBAAiB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CACf,UAAU,EAAE,UAAU,EACtB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,CACR,UAAU,EAAE,UAAU,EACtB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAE/B;;OAEG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,UAAU,EACtB,iBAAiB,EAAE,iBAAiB,EACpC,MAAM,EAAE,gBAAgB,EACxB,SAAS,CAAC,EAAE,yBAAyB,GACpC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;OAEG;IACH,SAAS,CACP,UAAU,EAAE,UAAU,EACtB,iBAAiB,EAAE,iBAAiB,EACpC,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/F;;OAEG;IACH,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE1E;;OAEG;IACH,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE/E,aAAa,IAAI,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,6BAA6B,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,2BAA2B,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,8BAA+B,SAAQ,yBAAyB;IAC/E,iBAAiB,CAAC,EAAE,CAAC,WAAW,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAChE"}

package/lib-es/types.js

@@ -0,0 +1,7 @@
+export var TrustchainResultType;
+(function (TrustchainResultType) {
+    TrustchainResultType["created"] = "created";
+    TrustchainResultType["updated"] = "updated";
+    TrustchainResultType["restored"] = "restored";
+})(TrustchainResultType || (TrustchainResultType = {}));
+//# sourceMappingURL=types.js.map

package/lib-es/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAwGA,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,6CAAqB,CAAA;AACvB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}