@frak-labs/core-sdk 0.0.2

package/dist/context-B0trlYGx.d.ts

@@ -0,0 +1,626 @@
+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-CTQ5-kqe.js';
+
+/**
+ * Configuration for the Nexus Wallet SDK
+ */
+type FrakWalletSdkConfig = {
+    /**
+     * The Frak wallet url
+     * @defaultValue "https://wallet.frak.id"
+     */
+    walletUrl?: string;
+    /**
+     * Some metadata about your implementation of the Frak SDK
+     */
+    metadata: {
+        /**
+         * Your application name (will be displayed in a few modals and in SSO)
+         */
+        name: string;
+        /**
+         * Custom CSS styles to apply to the modals and components
+         */
+        css?: string;
+    };
+    /**
+     * The domain name of your application
+     * @defaultValue window.location.host
+     */
+    domain?: string;
+};
+
+/**
+ * Event related to the iframe lifecycle
+ * @ignore
+ */
+type IFrameLifecycleEvent = {
+    iframeLifecycle: "connected" | "heartbeat" | "show" | "hide";
+    data?: never;
+} | DoBackupEvent | RemoveBackupEvent;
+type DoBackupEvent = {
+    iframeLifecycle: "do-backup";
+    data: {
+        backup?: string;
+    };
+};
+type RemoveBackupEvent = {
+    iframeLifecycle: "remove-backup";
+};
+
+/**
+ * Event related to the iframe lifecycle
+ * @ignore
+ */
+type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
+type CustomCssEvent = {
+    clientLifecycle: "modal-css";
+    data: {
+        cssLink: string;
+    };
+};
+type RestoreBackupEvent = {
+    clientLifecycle: "restore-backup";
+    data: {
+        backup: string;
+    };
+};
+
+/**
+ * SSO Metadata
+ */
+type SsoMetadata = {
+    /**
+     * URL to your client, if provided will be displayed in the SSO header
+     */
+    logoUrl?: string;
+    /**
+     * Link to your homepage, if referenced your app name will contain a link on the sso page
+     */
+    homepageLink?: string;
+    /**
+     * A few links that will be displayed in the footer
+     */
+    links?: {
+        /**
+         * URL to your confidentiality page
+         */
+        confidentialityLink?: string;
+        /**
+         * URL to your help page
+         */
+        helpLink?: string;
+        /**
+         * URL to your CGU page
+         */
+        cguLink?: string;
+    };
+};
+/**
+ * Params to start a SSO
+ * @group RPC Schema
+ */
+type OpenSsoParamsType = {
+    /**
+     * Redirect URL after the SSO (optional)
+     */
+    redirectUrl?: string;
+    /**
+     * If the SSO should directly exit after completion
+     * @defaultValue true
+     */
+    directExit?: boolean;
+    /**
+     * Language of the SSO page (optional)
+     * It will default to the current user language (or "en" if unsupported language)
+     */
+    lang?: "en" | "fr";
+    /**
+     * Custom SSO metadata
+     */
+    metadata: SsoMetadata;
+};
+
+/**
+ * Represent a generic modal step type
+ * @ignore
+ * @inline
+ */
+type GenericModalStepType<TKey, TParams, TReturns> = {
+    key: TKey;
+    params: TParams extends never ? ModalStepMetadata : ModalStepMetadata & TParams;
+    returns: TReturns;
+};
+/**
+ * Metadata that can be used to customise a modal step
+ * @group Modal Display
+ */
+type ModalStepMetadata = {
+    metadata?: {
+        /**
+         * Custom title for the step
+         * If none provided, it will use an internationalised text
+         */
+        title?: string;
+        /**
+         * Custom description for the step
+         * If none provided, it will use an internationalised text
+         */
+        description?: string;
+        /**
+         * Custom text for the primary action of the step
+         * If none provided, it will use an internationalised text
+         */
+        primaryActionText?: string;
+        /**
+         * Custom text for the secondary action of the step
+         * If none provided, it will use an internationalised text
+         */
+        secondaryActionText?: string;
+    };
+};
+
+/** @inline */
+type LoginWithSso = {
+    allowSso: true;
+    ssoMetadata: SsoMetadata;
+};
+/** @inline */
+type LoginWithoutSso = {
+    allowSso?: false;
+    ssoMetadata?: never;
+};
+/**
+ * The login step for a Modal
+ *
+ * **Input**: Do we allow SSO or not? Is yes then the SSO metadata
+ * **Output**: The logged in wallet address
+ *
+ * @group Modal Display
+ */
+type LoginModalStepType = GenericModalStepType<"login", LoginWithSso | LoginWithoutSso, {
+    wallet: Address;
+}>;
+
+/**
+ * Parameters used send a SIWE rpc request
+ */
+type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId" | "expirationTime" | "issuedAt" | "notBefore"> & {
+    expirationTimeTimestamp?: number;
+    notBeforeTimestamp?: number;
+};
+/**
+ * Return type of the Siwe transaction rpc request
+ * @inline
+ */
+type SiweAuthenticateReturnType = {
+    signature: Hex;
+    message: string;
+};
+/**
+ * The SIWE authentication step for a Modal
+ *
+ * **Input**: SIWE message parameters
+ * **Output**: SIWE result (message signed and wallet signature)
+ *
+ * @group Modal Display
+ */
+type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
+    siwe: SiweAuthenticationParams;
+}, SiweAuthenticateReturnType>;
+
+/**
+ * Generic format representing a tx to be sent
+ */
+type SendTransactionTxType = {
+    to: Address;
+    data?: Hex;
+    value?: Hex;
+};
+/**
+ * Return type of the send transaction rpc request
+ * @inline
+ */
+type SendTransactionReturnType = {
+    hash: Hex;
+};
+/**
+ * The send transaction step for a Modal
+ *
+ * **Input**: Either a single tx or an array of tx to be sent
+ * **Output**: The hash of the tx(s) hash (in case of multiple tx, still returns a single hash because it's bundled on the wallet level)
+ *
+ * @group Modal Display
+ */
+type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
+    tx: SendTransactionTxType | SendTransactionTxType[];
+}, SendTransactionReturnType>;
+
+/**
+ * Return type of the open session modal step
+ * @inline
+ * @ignore
+ */
+type OpenInteractionSessionReturnType = {
+    startTimestamp: number;
+    endTimestamp: number;
+};
+/**
+ * The open interaction session step for a Modal
+ *
+ * **Input**: None
+ * **Output**: The interactions session period (start and end timestamp)
+ *
+ * @group Modal Display
+ */
+type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
+
+/**
+ * The final modal step type, could be used to display sharing options or a success reward screen.
+ *
+ * **Input**: What type final step to display?
+ * **Output**: None
+ *
+ * @group Modal Display
+ */
+type FinalModalStepType = GenericModalStepType<"final", {
+    dismissedMetadata?: ModalStepMetadata["metadata"];
+    action: FinalActionType;
+    autoSkip?: boolean;
+}, object>;
+/**
+ * The different types of final actions we can display in the final step
+ * @group Modal Display
+ */
+type FinalActionType = {
+    key: "sharing";
+    options?: {
+        popupTitle?: string;
+        text?: string;
+        link?: string;
+    };
+} | {
+    key: "reward";
+    options?: never;
+};
+
+/**
+ * Generic type of steps we will display in the modal to the end user
+ * @group Modal Display
+ */
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | FinalModalStepType;
+/**
+ * Type for the result of a modal request
+ * Just the `returns` type of each `ModalStepTypes`
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ * @group RPC Schema
+ */
+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
+ * Just the `params` type of each `ModalStepTypes`
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ * @group RPC Schema
+ */
+type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]?: Extract<T[number], {
+        key: K;
+    }>["params"];
+};
+/**
+ * RPC metadata for the modal, used on top level modal configuration
+ * @group Modal Display
+ * @group RPC Schema
+ */
+type ModalRpcMetadata = {
+    header?: {
+        title?: string;
+        icon?: string;
+    };
+    context?: string;
+    lang?: "en" | "fr";
+} & ({
+    isDismissible: true;
+    dismissActionTxt?: string;
+} | {
+    isDismissible?: false;
+    dismissActionTxt?: never;
+});
+/**
+ * Params used to display a modal
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ */
+type DisplayModalParamsType<T extends ModalStepTypes[]> = {
+    steps: ModalRpcStepsInput<T>;
+    metadata?: ModalRpcMetadata;
+};
+
+/**
+ * The keys for each product types
+ * @inline
+ */
+type ProductTypesKey = keyof typeof productTypes;
+/**
+ * List of the product types per denominator
+ */
+declare const productTypes: {
+    dapp: number;
+    press: number;
+    webshop: number;
+    referral: number;
+    purchase: number;
+};
+/**
+ * Bitmask for each product types
+ */
+declare const productTypesMask: Record<ProductTypesKey, bigint>;
+
+/**
+ * Response of the `frak_getProductInformation` RPC method
+ * @group RPC Schema
+ */
+type GetProductInformationReturnType = {
+    /**
+     * Current product id
+     */
+    id: Hex;
+    /**
+     * Some metadata
+     */
+    onChainMetadata: {
+        /**
+         * Name of the product on-chain
+         */
+        name: string;
+        /**
+         * Domain of the product on-chain
+         */
+        domain: string;
+        /**
+         * The supported product types
+         */
+        productTypes: ProductTypesKey[];
+    };
+    /**
+     * Current the current estimated product reward
+     */
+    estimatedEurReward?: string;
+};
+
+/**
+ * RPC Response for the method `frak_listenToWalletStatus`
+ * @group RPC Schema
+ */
+type WalletStatusReturnType = WalletConnected | WalletNotConnected;
+/**
+ * @ignore
+ * @inline
+ */
+type WalletConnected = {
+    key: "connected";
+    wallet: Address;
+    interactionToken?: string;
+    interactionSession?: {
+        startTimestamp: number;
+        endTimestamp: number;
+    };
+};
+/**
+ * @ignore
+ * @inline
+ */
+type WalletNotConnected = {
+    key: "not-connected";
+    wallet?: never;
+    interactionToken?: never;
+    interactionSession?: never;
+};
+
+/**
+ * RPC interface that's used for the iframe communication
+ *
+ * Define all the methods available within the iFrame RPC client
+ *
+ * @group RPC Schema
+ *
+ * @remarks
+ * Here is the list of methods available:
+ *
+ * ### frak_listenToWalletStatus
+ *  - Params: None
+ *  - Returns: {@link WalletStatusReturnType}
+ *
+ * ### frak_displayModal
+ * - Params: [{@link ModalRpcStepsInput}, name: string, metadata?: {@link ModalRpcMetadata}]
+ * - Returns: {@link ModalRpcStepsResultType}
+ *
+ * ### frak_sendInteraction
+ *  - Params: [productId: Hex, interaction: {@link PreparedInteraction}, signature?: Hex]
+ *  - Returns: {@link SendInteractionReturnType}
+ *
+ * ### frak_sso
+ *  - Params [params: {@link OpenSsoParamsType}, name: string, customCss?: string]
+ *  - Returns: undefined
+ *
+ *  ### frak_getProductInformation
+ *  - Params: None
+ *  - Returns: {@link GetProductInformationReturnType}
+ */
+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: [
+            productId: Hex,
+            interaction: PreparedInteraction,
+            signature?: Hex
+        ];
+        ReturnType: SendInteractionReturnType;
+    },
+    /**
+     * Method to start a SSO
+     *  todo: Should also support direct tracking via a consumeKey
+     */
+    {
+        Method: "frak_sso";
+        Parameters: [
+            params: OpenSsoParamsType,
+            name: string,
+            customCss?: string
+        ];
+        ReturnType: undefined;
+    },
+    /**
+     * Method to get current product information's
+     *  - Is product minted?
+     *  - Does it have running campaign?
+     *  - Estimated reward on actions
+     */
+    {
+        Method: "frak_getProductInformation";
+        Parameters?: undefined;
+        ReturnType: GetProductInformationReturnType;
+    }
+];
+
+/**
+ * Type that extract the possible parameters from a RPC Schema
+ * @ignore
+ */
+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
+ * @ignore
+ */
+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
+ * @ignore
+ */
+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
+ * @ignore
+ */
+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
+ * @inline
+ */
+type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
+/**
+ * Type used for a listening request
+ * @inline
+ */
+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 Frak client, used to interact with the Frak Wallet
+ */
+type FrakClient = {
+    config: FrakWalletSdkConfig;
+} & IFrameTransport;
+
+/**
+ * The current Frak Context
+ *
+ * For now, only contain a referrer address.
+ */
+type FrakContext = {
+    r: Address;
+};
+
+export { type ClientLifecycleEvent as C, type DisplayModalParamsType as D, type ExtractedParametersFromRpc as E, type FrakWalletSdkConfig as F, type GetProductInformationReturnType as G, type IFrameRpcSchema as I, type LoginModalStepType as L, type ModalStepTypes as M, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type FrakClient as a, type FrakContext as b, productTypesMask as c, type ModalRpcMetadata as d, type ModalRpcStepsInput as e, type ModalRpcStepsResultType as f, type ModalStepMetadata as g, type SiweAuthenticateModalStepType as h, type SiweAuthenticationParams as i, type SiweAuthenticateReturnType as j, type SendTransactionTxType as k, type SendTransactionModalStepType as l, type SendTransactionReturnType as m, type OpenInteractionSessionReturnType as n, type OpenInteractionSessionModalStepType as o, productTypes as p, type FinalModalStepType as q, type FinalActionType as r, type IFrameTransport as s, type IFrameRpcEvent as t, type IFrameEvent as u, type IFrameLifecycleEvent as v, type ExtractedReturnTypeFromRpc as w };