Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kristoferlund/ic-use-internet-identity

Hook that makes it easy to integrate IC Internet Identity into your React application
https://github.com/kristoferlund/ic-use-internet-identity

dfinity hook internetcomputer react

Last synced: 1 day ago
JSON representation

Hook that makes it easy to integrate IC Internet Identity into your React application

Awesome Lists containing this project

README 

        
# ic-use-internet-identity



[Internet Identity](https://internetcomputer.org/how-it-works/web-authentication-identity) is an authentication service running on the [Internet Computer](https://internetcomputer.org). It allows users to create an identity that can be used to authenticate with canisters (smart contracts) running on the Internet Computer.



`ic-use-internet-identity` is a hook that makes it easy to integrate Internet Identity into your React application. It provides a simple interface for logging in and out with the Internet Identity service.



[![version][version-image]][npm-link]

[![downloads][dl-image]][npm-link]



## Features



- **Cached Identity**: The identity is cached in local storage and restored on page load. This allows the user to stay logged in even if the page is refreshed.

- **Login progress**: State varibles are provided to indicate whether the user is logged in, logging in, or logged out.

- **Works with ic-use-actor**: Plays nicely with [ic-use-actor](https://www.npmjs.com/package/ic-use-actor) that provides easy access to canister methods.



## Table of Contents



- [ic-use-internet-identity](#ic-use-internet-identity)

  - [Features](#features)

  - [Table of Contents](#table-of-contents)

  - [Installation](#installation)

  - [Usage](#usage)

    - [1. Setup the `InternetIdentityProvider` component](#1-setup-the-internetidentityprovider-component)

    - [2. Connect the `login()` function to a button](#2-connect-the-login-function-to-a-button)

    - [3. Use the `identity` context variable to access the identity](#3-use-the-identity-context-variable-to-access-the-identity)

  - [InternetIdentityProvider props](#internetidentityprovider-props)

  - [useInternetIdentity interface](#useinternetidentity-interface)

  - [Contributing](#contributing)

  - [License](#license)



## Installation



```bash

pnpm install ic-use-internet-identity

```



The hook also requires the following `@dfinity/x` packages to be installed with a version of at least `2.1.2`:



```bash

pnpm install @dfinity/agent @dfinity/auth-client @dfinity/identity

```



## Usage



> [!TIP]

> For a complete example, see the [ic-use-internet-identity-demo](https://github.com/kristoferlund/ic-use-internet-identity-demo) demo project.



To use `ic-use-internet-identity` in your React application, follow these steps:



### 1. Setup the `InternetIdentityProvider` component



Wrap your application's root component with `InternetIdentityProvider` to provide all child components access to the identity context.



```jsx

// main.tsx



import { InternetIdentityProvider } from "ic-use-internet-identity";

import React from "react";

import ReactDOM from "react-dom/client";



ReactDOM.createRoot(document.getElementById("root")!).render(

  

    

      

    

  

);

```



> [!TIP] > `InternetIdentityProvider` defaults to using the main Internet Identity instance running on `https://identity.ic0.app`. If you want to use a local instance of the Internet Identity, override the `II_URL` environment variable with the URL of the local instance.

>

> Example for Vite, using the [vite-plugin-environment](https://www.npmjs.com/package/vite-plugin-environment) plugin:

>

> ```javascript

> // vite.config.js

> import environment from "vite-plugin-environment";

>

> process.env.II_URL =

>   process.env.DFX_NETWORK === "local"

>     ? `http://${process.env.CANISTER_ID_INTERNET_IDENTIY}.localhost:4943`

>     : `https://identity.ic0.app`;

>

> export default defineConfig({

>   // ...

>   plugins: [

>     // ...

>     environment(["II_URL"]),

>   ],

>   // ...

> });

> ```



### 2. Connect the `login()` function to a button



Calling `login()` opens up the Internet Identity service in a new window where the user is asked to sign in. Once signed in, the window closes and the identity is stored in local storage. The identity is then available in the `identity` context variable.



Use the `loginStatus` state variable to track the status of the login process. The `loginStatus` can be one of the following values: `idle`, `logging-in`, `success`, or `error`.



```jsx

// LoginButton.tsx



import { useInternetIdentity } from "ic-use-internet-identity";



export function LoginButton() {

  const { login, loginStatus } = useInternetIdentity();



  const disabled = loginStatus === "logging-in" || loginStatus === "success";

  const text = loginStatus === "logging-in" ? "Logging in..." : "Login";



  return (

    

      {text}

    

  );

}

```



### 3. Use the `identity` context variable to access the identity



The `identity` context variable contains the identity of the currently logged in user. The identity is available after successfully loading the identity from local storage or completing the login process.



The preferred way to use the identity is to connect it to the [ic-use-actor](https://www.npmjs.com/package/ic-use-actor) hook. The hook provides a typed interface to the canister methods as well as interceptor functions for handling errors etc.



```jsx

// Actors.tsx



import { ReactNode } from "react";

import {

  ActorProvider,

  createActorContext,

  createUseActorHook,

} from "ic-use-actor";

import {

  canisterId,

  idlFactory,

} from "path-to/your-service/index";

import { _SERVICE } from "path-to/your-service.did";

import { useInternetIdentity } from "ic-use-internet-identity";



const actorContext = createActorContext<_SERVICE>();

export const useActor = createUseActorHook<_SERVICE>(actorContext);



 eexport default function Actors({ children }: { children: ReactNode }) {

  const { identity } = useInternetIdentity();



  return (

    

      canisterId={canisterId}

      context={actorContext}

      identity={identity}

      idlFactory={idlFactory}

    >

      {children}

    

  );

}

```



## InternetIdentityProvider props



````ts

{

  /** Options for creating the {@link AuthClient}. See AuthClient documentation for list of options

   *

   *`ic-use-internet-identity` defaults to disabling the AuthClient idle handling (clearing identities

   * from store and reloading the window on identity expiry). If that behaviour is preferred, set these settings:

   *

   * ```

   * const options = {

   *   idleOptions: {

   *     disableDefaultIdleCallback: false,

   *     disableIdle: false,

   *   },

   * }

   * ```

   */

  createOptions?: AuthClientCreateOptions;



  /** Options that determine the behaviour of the {@link AuthClient} login call. These options are a subset of

   * the {@link AuthClientLoginOptions}. */

  loginOptions?: LoginOptions;



  /** The child components that the InternetIdentityProvider will wrap. This allows any child

   * component to access the authentication context provided by the InternetIdentityProvider. */

  children: ReactNode;

}

````



## LoginOptions



```ts

export type LoginOptions = {

  /**

   * Expiration of the authentication in nanoseconds

   * @default  BigInt(8) hours * BigInt(3_600_000_000_000) nanoseconds

   */

  maxTimeToLive?: bigint;

  /**

   * If present, indicates whether or not the Identity Provider should allow the user to authenticate and/or register using a temporary key/PIN identity. Authenticating dapps may want to prevent users from using Temporary keys/PIN identities because Temporary keys/PIN identities are less secure than Passkeys (webauthn credentials) and because Temporary keys/PIN identities generally only live in a browser database (which may get cleared by the browser/OS).

   */

  allowPinAuthentication?: boolean;

  /**

   * Origin for Identity Provider to use while generating the delegated identity. For II, the derivation origin must authorize this origin by setting a record at `/.well-known/ii-alternative-origins`.

   * @see https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc

   */

  derivationOrigin?: string | URL;

  /**

   * Auth Window feature config string

   * @example "toolbar=0,location=0,menubar=0,width=500,height=500,left=100,top=100"

   */

  windowOpenerFeatures?: string;

  /**

   * Extra values to be passed in the login request during the authorize-ready phase

   */

  customValues?: Record;

};

```



## useInternetIdentity interface



```ts

export type InternetIdentityContextType = {

  /** Is set to `true` on mount until a stored identity is loaded from local storage or

   * none is found. */

  isInitializing: boolean;



  /** Connect to Internet Identity to login the user. */

  login: () => Promise;



  /** The status of the login process. Note: The login status is not affected when a stored

   * identity is loaded on mount. */

  loginStatus: LoginStatus;



  /** `loginStatus === "logging-in"` */

  isLoggingIn: boolean;



  /** `loginStatus === "error"` */

  isLoginError: boolean;



  /** `loginStatus === "success"` */

  isLoginSuccess: boolean;



  /** `loginStatus === "idle"` */

  isLoginIdle: boolean;



  /** Login error. Unsurprisingly. */

  loginError?: Error;



  /** Clears the identity from the state and local storage. Effectively "logs the user out". */

  clear: () => Promise;



  /** The identity is available after successfully loading the identity from local storage

   * or completing the login process. */

  identity?: Identity;

};

```



## Updates



See the [CHANGELOG](CHANGELOG.md) for details on updates.



## Author



- [[email protected]](mailto:[email protected])

- Twitter: [@kristoferlund](https://twitter.com/kristoferlund)

- Discord: kristoferkristofer

- Telegram: [@kristoferkristofer](https://t.me/kristoferkristofer)



## Contributing



Contributions are welcome. Please submit your pull requests or open issues to propose changes or report bugs.



## License



This project is licensed under the MIT License. See the LICENSE file for more details.



[version-image]: https://img.shields.io/npm/v/ic-use-internet-identity

[dl-image]: https://img.shields.io/npm/dw/ic-use-internet-identity

[npm-link]: https://www.npmjs.com/package/ic-use-internet-identity