# @web3auth/core

> Multi chain wallet aggregator core for web3Auth

Latest version **4.6.0** (published 2023-02-12) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @web3auth/core
pnpm add @web3auth/core
yarn add @web3auth/core
bun add @web3auth/core
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.6.0 |
| Published | 2023-02-12 |
| First published | 2022-01-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 490 |
| Author | Torus Labs |
| Maintainers | shubhamtorus, chaitanyapotti |
| Keywords | web3Auth/core, web3Auth, multichainWallet, blockchain, ethereum, solana |

## Links

- npm: https://www.npmjs.com/package/@web3auth/core
- Repository: https://github.com/Web3Auth/Web3Auth
- Homepage: https://github.com/Web3Auth/Web3Auth/tree/main/packages/core#readme
- Issues: https://github.com/Web3Auth/Web3Auth/issues
- npm.io page: https://npm.io/package/@web3auth/core

## Dependencies (4)

- [@web3auth/base](https://npm.io/package/@web3auth/base.md) ^4.6.0
- [@toruslabs/openlogin](https://npm.io/package/@toruslabs/openlogin.md) ^3.1.0
- [@web3auth/base-plugin](https://npm.io/package/@web3auth/base-plugin.md) ^4.6.0
- [@toruslabs/openlogin-jrpc](https://npm.io/package/@toruslabs/openlogin-jrpc.md) ^3.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 4.6.0 (latest) — 2023-02-12
- 4.4.0 — 2023-02-07
- 4.3.2 — 2023-02-03
- 4.3.0 — 2023-01-31
- 4.2.4 — 2023-01-26
- 4.2.2 — 2023-01-10
- 4.0.0 — 2022-12-16
- 4.5.0-beta.0 — 2022-12-16
- 4.3.2-beta.0 — 2022-12-16
- 4.2.3-beta.0 — 2022-12-14
- 4.0.0-alpha.0 — 2022-12-07
- 3.3.0 — 2022-12-06
- 3.2.0 — 2022-11-29
- 3.1.0 — 2022-11-24
- 3.0.4 — 2022-11-08
- … 35 more at https://npm.io/package/@web3auth/core/versions

## README

# Web3Auth Plug and Play Core

[![npm version](https://img.shields.io/npm/v/@web3auth/core?label=%22%22)](https://www.npmjs.com/package/@web3auth/core/v/latest)
[![minzip](https://img.shields.io/bundlephobia/minzip/@web3auth/core?label=%22%22)](https://bundlephobia.com/result?p=@web3auth/core@latest)

> Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.

Web3Auth Plug and Play Core is the main SDK that consists of the core module of Web3Auth Plug and Play. This SDK gives you all the needed modules for implementing the Web3Auth features, giving you the flexibility of implementing your own UI to use all the functionalities. 

## 📖 Documentation

Checkout the official [Web3Auth Documentation](https://web3auth.io/docs/sdk/web/core/) to get started.

## 💡 Features
- Plug and Play, OAuth based Web3 Authentication Service
- Fully decentralized, non-custodial key infrastructure
- End to end Whitelabelable solution
- Threshold Cryptography based Key Reconstruction
- Multi Factor Authentication Setup & Recovery (Includes password, backup phrase, device factor editing/deletion etc)
- Support for WebAuthn & Passwordless Login
- Support for connecting to multiple wallets
- DApp Active Session Management

...and a lot more

## 🔗 Installation

```shell
npm install --save @web3auth/core
```
## ⚡ Quick Start

### Get your Client ID from Web3Auth Dashboard

Hop on to the [Web3Auth Dashboard](https://dashboard.web3auth.io/) and create a new project. Use the Client ID of the project to start your integration.

![Web3Auth Dashboard](https://web3auth.io/docs/assets/images/project_plug_n_play-89c39ec42ad993107bb2485b1ce64b89.png)

### Initialize Web3Auth for your preferred blockchain

Web3Auth needs to initialise as soon as your app loads up to enable the user to log in. Preferably done within a constructor, initialisation is the step where you can pass on all the configurations for Web3Auth you want. A simple integration for Ethereum blockchain will look like this:

```js
import { Web3AuthCore } from "@web3auth/core";

//Initialize within your constructor
const web3auth = new Web3AuthCore({
  clientId: "", // Get your Client ID from Web3Auth Dashboard
  chainConfig: {
    chainNamespace: "eip155",
    chainId: "0x1",
  },
});

await web3auth.init();
```
### Login your User

Once you're done initialising, just create a button that triggers login for your preferred social channel for the user on their request. You can further use the returned provider for making RPC calls to the blockchain.

```js
const web3authProvider = await web3auth.connectTo(
    "openlogin",
    {
        loginProvider: 'google',
    },
)
```

## 🩹 Examples

Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/examples/tree/main/web-core-sdk)

## 🌐 Demo

Checkout the [Web3Auth Demo](https://demo-app.web3auth.io/) to see how Web3Auth can be used in your application.

## 💬 Troubleshooting and Discussions

- Have a look at our [GitHub Discussions](https://github.com/Web3Auth/Web3Auth/discussions?discussions_q=sort%3Atop) to see if anyone has any questions or issues you might be having.
- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions
- Join our [Discord](https://discord.gg/web3auth) to join our community and get private integration support or help with your integration.

---
_Source: https://npm.io/package/@web3auth/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._