Initializing MPC Core Kit JS SDK for Web

After installation, the next step to use Web3Auth MPC Core Kit is to configure & initialize the SDK.

1. Configure Web3AuthMPCCoreKit instance
2. Initialize Web3AuthMPCCoreKit

Configure Instance

Please note that these are the most critical steps where you need to pass on different parameters according to the preference of your project.

Parameters

The Web3AuthMPCCoreKit constructor takes an object with Web3AuthOptions as input which helps you configure the SDK.

Table

Parameter	Description
web3AuthClientId	The Web3Auth Client ID for your application. Find one at https://dashboard.web3auth.io
manualSync?	Enables you to manually sync with the Web3Auth Metadata Server, helping you manage the API calls to the server. We recommend using this approach. Default value is false.
baseUrl?	URL of the service worker handling the authentication in popup flow. For general usecases, you don't need to change this value. Default value is ${window.location.origin}/serviceworker.
web3AuthNetwork?	Web3Auth Network used for MPC Wallet Management. Use WEB3AUTH_NETWORK.DEVNET in testing environment and WEB3AUTH_NETWORK.Mainnet in production environment. Default value is WEB3AUTH_NETWORK.Mainnet.
sessionTime?	Determine the session length in seconds. By default the value is set at 86400 seconds, ie. 1 day.
uxMode?	Four uxModes are supported: 'popup': In this uxMode, a popup will be shown to user for login. 'redirect': In this uxMode, user will be redirected to a new window tab for login. 'nodejs': Use this for Node.js projects. 'react-native': Use this for React Native apps. Use of 'redirect' mode is recommended in browsers where popups might get blocked.
enableLogging?	Enables Logs for the SDK. Default value is false.
redirectPathName?	Specifies the url path where user will be redirected after login. Redirect Uri for OAuth is baseUrl/redirectPathName.
disableHashedFactorKey?	Disables the Hashed Key, making the sure user logs in always in a non-custodial mode. Recommended only if you have proper MFA flow setup for the user while creating the account. Default value is false.
tssLib	The threshold signing library to use: For secp256k1 keyType, you can use the @toruslabs/tss-dkls-lib For ed25519 keyType you can use @toruslabs/tss-frost-lib
hashedFactorNonce?	Nonce for the hashed factor. Default value is web3AuthClientId. Learn more about hashed factor.
storage	Defines the storage for MPC Core Kit's state.
useDKG?	Specifies whether to use DKG or not. If set to false, the key would be securely generated on the client side, and imported to Web3Auth network. If set to true, the key would be generated using a distributed network.Setting the flag to false, and generating a key on the client side significantly improves the speed of first-time login. The default value secp256k1 is true. Please note, it is not supported for ed25519, and is always false.
useClientGeneratedTSSKey?	Specifies whether to use client generated TSS key or not. The default value is set to false for secp256k1 and true for ed25519. The default value is set to true for ed25519 as it allows users to export the ed25519 key.
disableSessionManager?	Specifies whether to disable the session manager or not. The default value is false. Please note, the session will still expire after the defined session time.

Interface

export interface Web3AuthOptions {
  /**
   * The Web3Auth Client ID for your application. Find one at https://dashboard.web3auth.io
   */
  web3AuthClientId: string;

  /**
   * The threshold signing library to use.
   */
  tssLib: TssLib;

  /**
   * @defaultValue `false`
   */
  manualSync?: boolean;

  /**
   * @defaultValue `${window.location.origin}/serviceworker`
   */
  baseUrl?: string;

  /**
   *
   * @defaultValue `'sapphire_mainnet'`
   */
  web3AuthNetwork?: WEB3AUTH_NETWORK_TYPE;

  /**
   *  storage for mpc-core-kit's local state.
   *  storage replaces previous' storageKey and asyncStorage options.
   *
   *  Migration from storageKey and asyncStorage to storage guide.
   *
   *  For StorageKey, please replace
   *  - undefined with localStorage
   *  - "local" with localStorage
   *  - "session" with sessionStorage
   *  - "memory" with new MemoryStorage()
   *
   *  For asyncStorage, provide instance of IAsyncStorage.
   *
   */
  storage: IAsyncStorage | IStorage;

  /**
   * @defaultValue 86400
   */
  sessionTime?: number;

  /**
   * @defaultValue `'POPUP'`
   */
  uxMode?: CoreKitMode;

  /**
   * @defaultValue `false`
   * enables logging of the internal packages.
   */
  enableLogging?: boolean;

  /**
   * This option is used to specify the url path where user will be
   * redirected after login. Redirect Uri for OAuth is baseUrl/redirectPathName.
   *
   *
   * @defaultValue `"redirect"`
   *
   * @remarks
   * At verifier's interface (where you obtain client id), please use baseUrl/redirectPathName
   * as the redirect_uri
   *
   * Torus Direct SDK installs a service worker relative to baseUrl to capture
   * the auth redirect at `redirectPathName` path.
   *
   * For ex: While using serviceworker if `baseUrl` is "http://localhost:3000/serviceworker" and
   * `redirectPathName` is 'redirect' (which is default)
   * then user will be redirected to http://localhost:3000/serviceworker/redirect page after login
   * where service worker will capture the results and send it back to original window where login
   * was initiated.
   *
   * For browsers where service workers are not supported or if you wish to not use
   * service workers,create and serve redirect page (i.e redirect.html file which is
   * available in serviceworker folder of this package)
   *
   * If you are using redirect uxMode, you can get the results directly on your `redirectPathName`
   * path using `getRedirectResult` function.
   *
   * For ex: if baseUrl is "http://localhost:3000" and `redirectPathName` is 'auth'
   * then user will be redirected to http://localhost:3000/auth page after login
   * where you can get login result by calling `getRedirectResult` on redirected page mount.
   *
   * Please refer to examples https://github.com/torusresearch/customauth/tree/master/examples
   * for more understanding.
   *
   */
  redirectPathName?: string;

  /**
   * @defaultValue `false`
   * Disables the cloud factor key, enabling the one key semi custodial flow.
   * Recommended for Non Custodial Flow.
   */
  disableHashedFactorKey?: boolean;

  /**
   * @defaultValue `Web3AuthOptions.web3AuthClientId`
   * Overwrites the default value ( clientId ) used as nonce for hashing the hash factor key.
   *
   * If you want to aggregate the mfa status of client id 1 and client id 2  apps
   * set hashedFactorNonce to some common clientID, which can be either client id 1 or client id 2 or any other unique string
   * #PR 72
   * Do not use this unless you know what you are doing.
   */
  hashedFactorNonce?: string;

  serverTimeOffset?: number;
}

export type WEB3AUTH_NETWORK_TYPE = (typeof WEB3AUTH_NETWORK)[keyof typeof WEB3AUTH_NETWORK];
export declare const WEB3AUTH_NETWORK: {
  readonly MAINNET: "sapphire_mainnet";
  readonly DEVNET: "sapphire_devnet";
};

export type CoreKitMode = UX_MODE_TYPE | "nodejs" | "react-native";
export type UX_MODE_TYPE = (typeof UX_MODE)[keyof typeof UX_MODE];
export declare const UX_MODE: {
  readonly POPUP: "popup";
  readonly REDIRECT: "redirect";
};

Usage

Secp256k1

import { Web3AuthMPCCoreKit, WEB3AUTH_NETWORK } from "@web3auth/mpc-core-kit";
import { tssLib } from "@toruslabs/tss-dkls-lib";

const coreKitInstance = new Web3AuthMPCCoreKit({
  web3AuthClientId: "YOUR_CLIENT_ID",
  web3AuthNetwork: WEB3AUTH_NETWORK.MAINNET,
  manualSync: true, // This is the recommended approach
  tssLib: tssLib,
  storage: window.storage,
});

Ed25519

import { Web3AuthMPCCoreKit, WEB3AUTH_NETWORK } from "@web3auth/mpc-core-kit";
import { tssLib } from "@toruslabs/tss-frost-lib";

const coreKitInstance = new Web3AuthMPCCoreKit({
  web3AuthClientId: "YOUR_CLIENT_ID",
  web3AuthNetwork: WEB3AUTH_NETWORK.MAINNET,
  manualSync: true, // This is the recommended approach
  tssLib: tssLib,
  storage: window.storage,
});

Initialize Web3AuthMPCCoreKit

To initialize the instance, you need to call the init method. The method also takes the InitParams as an input.

Parameters

Table

Parameter	Description
handleRedirectResult	Handles the redirect result during initialization. Default value is true.
rehydrate	Rehydrates the session during initialization. Default value is true.

Interface

export interface InitParams {
  /**
   * @defaultValue `true`
   * handle the redirect result during init()
   */
  handleRedirectResult: boolean;
  /**
   * @defaultValue `true`
   * rehydrate the session during init()
   */
  rehydrate?: boolean;
}

Usage

// Web3AuthMPCCoreKit instance from previous steps
await coreKitInstance.init();