@frak-labs/nexus-sdk 0.0.10 → 0.0.12

package/dist/client-B6_BIGc3.d.ts

@@ -0,0 +1,357 @@
+import { Address, Hex, RpcSchema } from 'viem';
+import { Prettify } from 'viem/chains';
+import { SiweMessage } from 'viem/siwe';
+import { P as PreparedInteraction, a as SendInteractionReturnType } from './interaction-D3-M3nBh.js';
+
+/**
+ * Configuration for the Nexus Wallet SDK
+ */
+type NexusWalletSdkConfig = Readonly<{
+    walletUrl: string;
+    metadata: {
+        name: string;
+        css?: string;
+    };
+    domain: string;
+}>;
+
+/**
+ * Event related to the iframe lifecycle
+ */
+type IFrameLifecycleEvent = {
+    iframeLifecycle: "connected" | "show" | "hide";
+    data?: never;
+} | DoBackupEvent;
+type DoBackupEvent = {
+    iframeLifecycle: "do-backup";
+    data: {
+        backup?: string;
+    };
+};
+
+/**
+ * Event related to the iframe lifecycle
+ */
+type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
+type CustomCssEvent = {
+    clientLifecycle: "modal-css";
+    data: {
+        cssLink: string;
+    };
+};
+type RestoreBackupEvent = {
+    clientLifecycle: "restore-backup";
+    data: {
+        backup: string;
+    };
+};
+
+/**
+ * SSO Metadata
+ */
+type SsoMetadata = {
+    logoUrl: string;
+    homepageLink: string;
+    links?: {
+        confidentialityLink?: string;
+        helpLink?: string;
+        cguLink?: string;
+    };
+};
+/**
+ * Params to start a SSO
+ */
+type OpenSsoParamsType = {
+    redirectUrl?: string;
+    directExit?: boolean;
+    metadata: SsoMetadata;
+};
+
+/**
+ * Represent a generic modal step type
+ */
+type GenericModalStepType<TKey, TParams, TReturns> = {
+    key: TKey;
+    params: TParams extends never ? ModalStepMetadata : ModalStepMetadata & TParams;
+    returns: TReturns;
+};
+type ModalStepMetadata = {
+    metadata?: {
+        title?: string;
+        description?: string;
+        primaryActionText?: string;
+        secondaryActionText?: string;
+    };
+};
+
+type LoginWithSso = {
+    allowSso: true;
+    ssoMetadata: SsoMetadata;
+};
+type LoginWithoutSso = {
+    allowSso?: false;
+    ssoMetadata?: never;
+};
+/**
+ * Generic type of modal we will display to the end user
+ */
+type LoginModalStepType = GenericModalStepType<"login", LoginWithSso | LoginWithoutSso, {
+    wallet: Address;
+}>;
+
+/**
+ * Parameters of the send transaction rpc request
+ */
+type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId">;
+/**
+ * Return type of the send transaction rpc request
+ */
+type SiweAuthenticateReturnType = Readonly<{
+    signature: Hex;
+    message: string;
+}>;
+/**
+ * Generic type of modal we will display to the end user
+ */
+type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
+    siwe: SiweAuthenticationParams;
+}, SiweAuthenticateReturnType>;
+
+/**
+ * Generic format representing a tx to be sent
+ *  todo: exploit the EIP-5792 here? https://eips.ethereum.org/EIPS/eip-5792
+ */
+type SendTransactionTxType = Readonly<{
+    to: Address;
+    data?: Hex;
+    value?: Hex;
+}>;
+/**
+ * Return type of the send transaction rpc request
+ */
+type SendTransactionReturnType = Readonly<{
+    hash: Hex;
+}>;
+type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
+    tx: SendTransactionTxType | SendTransactionTxType[];
+}, SendTransactionReturnType>;
+
+/**
+ * Return type of the send transaction rpc request
+ */
+type OpenInteractionSessionReturnType = Readonly<{
+    startTimestamp: number;
+    endTimestamp: number;
+}>;
+/**
+ * Generic type of modal we will display to the end user
+ */
+type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
+
+/**
+ * Generic type of modal we will display to the end user
+ */
+type SuccessModalStepType = GenericModalStepType<"success", {
+    sharing?: {
+        popupTitle?: string;
+        text?: string;
+        link?: string;
+    };
+}, object>;
+
+/**
+ * Generic type of steps we will display in the modal to the end user
+ */
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | SuccessModalStepType;
+/**
+ * Type for the result of a modal request
+ */
+type ModalRpcStepsResultType<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]: Extract<T[number], {
+        key: K;
+    }>["returns"];
+};
+/**
+ * Type for the RPC input of a modal
+ */
+type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]?: Extract<T[number], {
+        key: K;
+    }>["params"];
+};
+/**
+ * RPC metadata for the modal
+ */
+type ModalRpcMetadata = Readonly<{
+    header?: {
+        title?: string;
+        icon?: string;
+    };
+    context?: string;
+}>;
+/**
+ * Generic params used to display modals
+ */
+type DisplayModalParamsType<T extends ModalStepTypes[]> = {
+    steps: ModalRpcStepsInput<T>;
+    metadata?: ModalRpcMetadata;
+};
+
+type WalletStatusReturnType = Readonly<WalletConnected | WalletNotConnected>;
+type WalletConnected = {
+    key: "connected";
+    wallet: Address;
+    interactionSession?: {
+        startTimestamp: number;
+        endTimestamp: number;
+    };
+};
+type WalletNotConnected = {
+    key: "not-connected";
+};
+
+/**
+ * RPC interface that's used for the iframe communication
+ */
+type IFrameRpcSchema = [
+    /**
+     * Method used to listen to the wallet status
+     */
+    {
+        Method: "frak_listenToWalletStatus";
+        Parameters?: undefined;
+        ReturnType: WalletStatusReturnType;
+    },
+    /**
+     * Method to transmit a user interaction
+     */
+    {
+        Method: "frak_displayModal";
+        Parameters: [
+            requests: ModalRpcStepsInput,
+            name: string,
+            metadata?: ModalRpcMetadata
+        ];
+        ReturnType: ModalRpcStepsResultType;
+    },
+    /**
+     * Method to transmit a user interaction
+     */
+    {
+        Method: "frak_sendInteraction";
+        Parameters: [
+            contentId: Hex,
+            interaction: PreparedInteraction,
+            signature?: Hex
+        ];
+        ReturnType: SendInteractionReturnType;
+    },
+    /**
+     * Method to start a SSO
+     */
+    {
+        Method: "frak_sso";
+        Parameters: [
+            params: OpenSsoParamsType,
+            name: string,
+            customCss?: string
+        ];
+        ReturnType: undefined;
+    }
+];
+
+/**
+ * Type that extract the possible parameters from a RPC Schema
+ */
+type ExtractedParametersFromRpc<TRpcSchema extends RpcSchema> = {
+    [K in keyof TRpcSchema]: Prettify<{
+        method: TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Method"] : string;
+    } & (TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Parameters"] extends undefined ? {
+        params?: never;
+    } : {
+        params: TRpcSchema[K]["Parameters"];
+    } : never)>;
+}[number];
+/**
+ * Type that extract the possible return type from a RPC Schema
+ */
+type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"];
+/**
+ * Type that extract the possible return type from a RPC Schema
+ */
+type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = Extract<TRpcSchema[number], {
+    Method: TMethod;
+}>;
+/**
+ * Raw response that we will receive after an rpc request
+ */
+type RpcResponse<TRpcSchema extends RpcSchema, TMethod extends TRpcSchema[number]["Method"] = TRpcSchema[number]["Method"]> = {
+    result: Extract<TRpcSchema[number], {
+        Method: TMethod;
+    }>["ReturnType"];
+    error?: never;
+} | {
+    result?: never;
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+};
+/**
+ * Type used for a one shot request function
+ */
+type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
+/**
+ * Type used for a one shot request function
+ */
+type ListenerRequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters, callback: (result: _ReturnType) => void) => Promise<void>;
+/**
+ * IFrame transport interface
+ */
+type IFrameTransport = {
+    /**
+     * Wait for the connection to be established
+     */
+    waitForConnection: Promise<boolean>;
+    /**
+     * Wait for the setup to be done
+     */
+    waitForSetup: Promise<void>;
+    /**
+     * Function used to perform a single request via the iframe transport
+     */
+    request: RequestFn<IFrameRpcSchema>;
+    /**
+     * Function used to listen to a request response via the iframe transport
+     */
+    listenerRequest: ListenerRequestFn<IFrameRpcSchema>;
+    /**
+     * Function used to destroy the iframe transport
+     */
+    destroy: () => Promise<void>;
+};
+/**
+ * Represent an iframe event
+ */
+type IFrameEvent = IFrameRpcEvent | IFrameLifecycleEvent | ClientLifecycleEvent;
+/**
+ * Represent an iframe rpc event
+ */
+type IFrameRpcEvent = {
+    id: string;
+    topic: ExtractedParametersFromRpc<IFrameRpcSchema>["method"];
+    data: {
+        compressed: string;
+        compressedHash: string;
+    };
+};
+
+/**
+ * Representing a Nexus client
+ */
+type NexusClient = {
+    config: NexusWalletSdkConfig;
+} & IFrameTransport;
+
+export type { ClientLifecycleEvent as C, DisplayModalParamsType as D, ExtractedParametersFromRpc as E, IFrameRpcSchema as I, LoginModalStepType as L, ModalRpcMetadata as M, NexusClient as N, OpenSsoParamsType as O, RpcResponse as R, SiweAuthenticationParams as S, WalletStatusReturnType as W, SiweAuthenticateReturnType as a, SendTransactionModalStepType as b, SendTransactionReturnType as c, ModalStepTypes as d, ModalRpcStepsResultType as e, NexusWalletSdkConfig as f, SuccessModalStepType as g, SsoMetadata as h, ModalRpcStepsInput as i, ModalStepMetadata as j, SiweAuthenticateModalStepType as k, SendTransactionTxType as l, OpenInteractionSessionReturnType as m, OpenInteractionSessionModalStepType as n, IFrameTransport as o, IFrameRpcEvent as p, IFrameEvent as q, IFrameLifecycleEvent as r, ExtractedReturnTypeFromRpc as s };

package/dist/client-Oily5ph8.d.cts

@@ -0,0 +1,357 @@
+import { Address, Hex, RpcSchema } from 'viem';
+import { Prettify } from 'viem/chains';
+import { SiweMessage } from 'viem/siwe';
+import { P as PreparedInteraction, a as SendInteractionReturnType } from './interaction-D3-M3nBh.cjs';
+
+/**
+ * Configuration for the Nexus Wallet SDK
+ */
+type NexusWalletSdkConfig = Readonly<{
+    walletUrl: string;
+    metadata: {
+        name: string;
+        css?: string;
+    };
+    domain: string;
+}>;
+
+/**
+ * Event related to the iframe lifecycle
+ */
+type IFrameLifecycleEvent = {
+    iframeLifecycle: "connected" | "show" | "hide";
+    data?: never;
+} | DoBackupEvent;
+type DoBackupEvent = {
+    iframeLifecycle: "do-backup";
+    data: {
+        backup?: string;
+    };
+};
+
+/**
+ * Event related to the iframe lifecycle
+ */
+type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
+type CustomCssEvent = {
+    clientLifecycle: "modal-css";
+    data: {
+        cssLink: string;
+    };
+};
+type RestoreBackupEvent = {
+    clientLifecycle: "restore-backup";
+    data: {
+        backup: string;
+    };
+};
+
+/**
+ * SSO Metadata
+ */
+type SsoMetadata = {
+    logoUrl: string;
+    homepageLink: string;
+    links?: {
+        confidentialityLink?: string;
+        helpLink?: string;
+        cguLink?: string;
+    };
+};
+/**
+ * Params to start a SSO
+ */
+type OpenSsoParamsType = {
+    redirectUrl?: string;
+    directExit?: boolean;
+    metadata: SsoMetadata;
+};
+
+/**
+ * Represent a generic modal step type
+ */
+type GenericModalStepType<TKey, TParams, TReturns> = {
+    key: TKey;
+    params: TParams extends never ? ModalStepMetadata : ModalStepMetadata & TParams;
+    returns: TReturns;
+};
+type ModalStepMetadata = {
+    metadata?: {
+        title?: string;
+        description?: string;
+        primaryActionText?: string;
+        secondaryActionText?: string;
+    };
+};
+
+type LoginWithSso = {
+    allowSso: true;
+    ssoMetadata: SsoMetadata;
+};
+type LoginWithoutSso = {
+    allowSso?: false;
+    ssoMetadata?: never;
+};
+/**
+ * Generic type of modal we will display to the end user
+ */
+type LoginModalStepType = GenericModalStepType<"login", LoginWithSso | LoginWithoutSso, {
+    wallet: Address;
+}>;
+
+/**
+ * Parameters of the send transaction rpc request
+ */
+type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId">;
+/**
+ * Return type of the send transaction rpc request
+ */
+type SiweAuthenticateReturnType = Readonly<{
+    signature: Hex;
+    message: string;
+}>;
+/**
+ * Generic type of modal we will display to the end user
+ */
+type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
+    siwe: SiweAuthenticationParams;
+}, SiweAuthenticateReturnType>;
+
+/**
+ * Generic format representing a tx to be sent
+ *  todo: exploit the EIP-5792 here? https://eips.ethereum.org/EIPS/eip-5792
+ */
+type SendTransactionTxType = Readonly<{
+    to: Address;
+    data?: Hex;
+    value?: Hex;
+}>;
+/**
+ * Return type of the send transaction rpc request
+ */
+type SendTransactionReturnType = Readonly<{
+    hash: Hex;
+}>;
+type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
+    tx: SendTransactionTxType | SendTransactionTxType[];
+}, SendTransactionReturnType>;
+
+/**
+ * Return type of the send transaction rpc request
+ */
+type OpenInteractionSessionReturnType = Readonly<{
+    startTimestamp: number;
+    endTimestamp: number;
+}>;
+/**
+ * Generic type of modal we will display to the end user
+ */
+type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
+
+/**
+ * Generic type of modal we will display to the end user
+ */
+type SuccessModalStepType = GenericModalStepType<"success", {
+    sharing?: {
+        popupTitle?: string;
+        text?: string;
+        link?: string;
+    };
+}, object>;
+
+/**
+ * Generic type of steps we will display in the modal to the end user
+ */
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | SuccessModalStepType;
+/**
+ * Type for the result of a modal request
+ */
+type ModalRpcStepsResultType<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]: Extract<T[number], {
+        key: K;
+    }>["returns"];
+};
+/**
+ * Type for the RPC input of a modal
+ */
+type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]?: Extract<T[number], {
+        key: K;
+    }>["params"];
+};
+/**
+ * RPC metadata for the modal
+ */
+type ModalRpcMetadata = Readonly<{
+    header?: {
+        title?: string;
+        icon?: string;
+    };
+    context?: string;
+}>;
+/**
+ * Generic params used to display modals
+ */
+type DisplayModalParamsType<T extends ModalStepTypes[]> = {
+    steps: ModalRpcStepsInput<T>;
+    metadata?: ModalRpcMetadata;
+};
+
+type WalletStatusReturnType = Readonly<WalletConnected | WalletNotConnected>;
+type WalletConnected = {
+    key: "connected";
+    wallet: Address;
+    interactionSession?: {
+        startTimestamp: number;
+        endTimestamp: number;
+    };
+};
+type WalletNotConnected = {
+    key: "not-connected";
+};
+
+/**
+ * RPC interface that's used for the iframe communication
+ */
+type IFrameRpcSchema = [
+    /**
+     * Method used to listen to the wallet status
+     */
+    {
+        Method: "frak_listenToWalletStatus";
+        Parameters?: undefined;
+        ReturnType: WalletStatusReturnType;
+    },
+    /**
+     * Method to transmit a user interaction
+     */
+    {
+        Method: "frak_displayModal";
+        Parameters: [
+            requests: ModalRpcStepsInput,
+            name: string,
+            metadata?: ModalRpcMetadata
+        ];
+        ReturnType: ModalRpcStepsResultType;
+    },
+    /**
+     * Method to transmit a user interaction
+     */
+    {
+        Method: "frak_sendInteraction";
+        Parameters: [
+            contentId: Hex,
+            interaction: PreparedInteraction,
+            signature?: Hex
+        ];
+        ReturnType: SendInteractionReturnType;
+    },
+    /**
+     * Method to start a SSO
+     */
+    {
+        Method: "frak_sso";
+        Parameters: [
+            params: OpenSsoParamsType,
+            name: string,
+            customCss?: string
+        ];
+        ReturnType: undefined;
+    }
+];
+
+/**
+ * Type that extract the possible parameters from a RPC Schema
+ */
+type ExtractedParametersFromRpc<TRpcSchema extends RpcSchema> = {
+    [K in keyof TRpcSchema]: Prettify<{
+        method: TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Method"] : string;
+    } & (TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Parameters"] extends undefined ? {
+        params?: never;
+    } : {
+        params: TRpcSchema[K]["Parameters"];
+    } : never)>;
+}[number];
+/**
+ * Type that extract the possible return type from a RPC Schema
+ */
+type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"];
+/**
+ * Type that extract the possible return type from a RPC Schema
+ */
+type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = Extract<TRpcSchema[number], {
+    Method: TMethod;
+}>;
+/**
+ * Raw response that we will receive after an rpc request
+ */
+type RpcResponse<TRpcSchema extends RpcSchema, TMethod extends TRpcSchema[number]["Method"] = TRpcSchema[number]["Method"]> = {
+    result: Extract<TRpcSchema[number], {
+        Method: TMethod;
+    }>["ReturnType"];
+    error?: never;
+} | {
+    result?: never;
+    error: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+};
+/**
+ * Type used for a one shot request function
+ */
+type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
+/**
+ * Type used for a one shot request function
+ */
+type ListenerRequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters, callback: (result: _ReturnType) => void) => Promise<void>;
+/**
+ * IFrame transport interface
+ */
+type IFrameTransport = {
+    /**
+     * Wait for the connection to be established
+     */
+    waitForConnection: Promise<boolean>;
+    /**
+     * Wait for the setup to be done
+     */
+    waitForSetup: Promise<void>;
+    /**
+     * Function used to perform a single request via the iframe transport
+     */
+    request: RequestFn<IFrameRpcSchema>;
+    /**
+     * Function used to listen to a request response via the iframe transport
+     */
+    listenerRequest: ListenerRequestFn<IFrameRpcSchema>;
+    /**
+     * Function used to destroy the iframe transport
+     */
+    destroy: () => Promise<void>;
+};
+/**
+ * Represent an iframe event
+ */
+type IFrameEvent = IFrameRpcEvent | IFrameLifecycleEvent | ClientLifecycleEvent;
+/**
+ * Represent an iframe rpc event
+ */
+type IFrameRpcEvent = {
+    id: string;
+    topic: ExtractedParametersFromRpc<IFrameRpcSchema>["method"];
+    data: {
+        compressed: string;
+        compressedHash: string;
+    };
+};
+
+/**
+ * Representing a Nexus client
+ */
+type NexusClient = {
+    config: NexusWalletSdkConfig;
+} & IFrameTransport;
+
+export type { ClientLifecycleEvent as C, DisplayModalParamsType as D, ExtractedParametersFromRpc as E, IFrameRpcSchema as I, LoginModalStepType as L, ModalRpcMetadata as M, NexusClient as N, OpenSsoParamsType as O, RpcResponse as R, SiweAuthenticationParams as S, WalletStatusReturnType as W, SiweAuthenticateReturnType as a, SendTransactionModalStepType as b, SendTransactionReturnType as c, ModalStepTypes as d, ModalRpcStepsResultType as e, NexusWalletSdkConfig as f, SuccessModalStepType as g, SsoMetadata as h, ModalRpcStepsInput as i, ModalStepMetadata as j, SiweAuthenticateModalStepType as k, SendTransactionTxType as l, OpenInteractionSessionReturnType as m, OpenInteractionSessionModalStepType as n, IFrameTransport as o, IFrameRpcEvent as p, IFrameEvent as q, IFrameLifecycleEvent as r, ExtractedReturnTypeFromRpc as s };