https://github.com/web3auth/mpc-core-kit
https://github.com/web3auth/mpc-core-kit
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/web3auth/mpc-core-kit
- Owner: Web3Auth
- Created: 2023-04-20T11:49:42.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T09:22:35.000Z (about 1 year ago)
- Last Synced: 2025-04-28T12:02:55.632Z (about 1 year ago)
- Language: TypeScript
- Size: 23 MB
- Stars: 20
- Watchers: 5
- Forks: 6
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Web3Auth MPC Core Kit
[](https://www.npmjs.com/package/@web3auth/mpc-core-kit/v/latest)
[](https://bundlephobia.com/result?p=@web3auth/mpc-core-kit@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 MPC Core Kit Beta is a wrapper SDK that gives you all the needed functionalities for implementing the Web3Auth MPC features, giving you the flexibility of implementing your own UI and UX flows end to end.
## 📖 Documentation
Checkout the official [Web3Auth Documentation](https://web3auth.io/docs/sdk/) to get started.
...and a lot more
## 🔗 Installation
```shell
npm install --save @web3auth/mpc-core-kit
```
## ⚡ 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.
### 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 { Web3AuthMPCCoreKit } from "@web3auth/mpc-core-kit";
const DEFAULT_CHAIN_CONFIG: CustomChainConfig = {
chainNamespace: CHAIN_NAMESPACES.EIP155,
chainId: "0x5",
rpcTarget: "https://rpc.ankr.com/eth_goerli",
displayName: "Goerli Testnet",
blockExplorer: "https://goerli.etherscan.io",
ticker: "ETH",
tickerName: "Ethereum",
decimals: 18,
};
//Initialize within your constructor
const web3auth = new Web3AuthMPCCoreKit({
web3AuthClientId: 'YOUR_CLIENT_ID',
web3AuthNetwork: WEB3AUTH_NETWORK.DEVNET
chainConfig: DEFAULT_CHAIN_CONFIG
});
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 verifierConfig = {
subVerifierDetails: {
typeOfLogin: 'google',
verifier: 'w3a-google-demo',
clientId:
'519228911939-cri01h55lsjbsia1k7ll6qpalrus75ps.apps.googleusercontent.com',
}
} as SubVerifierDetailsParams;
await coreKitInstance.loginWithOAuth(verifierConfig);
```
For JWT(idToken) login
```js
const idTokenLoginParams = {
verifier: "torus-test-health",
verifierId: parsedToken.email,
idToken,
} as IdTokenLoginParams;
await coreKitInstance.loginWithJWT(idTokenLoginParams);
```
## 🩹 Examples
Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/web3auth-core-kit-examples)
## 🌐 Demo
Checkout the [Web3Auth Demo](https://demo-app.web3auth.io/) to see how Web3Auth can be used in your application.
## 💬 Troubleshooting and Support
- Have a look at our [Community Portal](https://community.web3auth.io/) to see if anyone has any questions or issues you might be having. Feel free to reate new topics and we'll help you out as soon as possible.
- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions.
- For Priority Support, please have a look at our [Pricing Page](https://web3auth.io/pricing.html) for the plan that suits your needs.
### Development steps:-
#### Install dependencies:
npm i
#### Run tests:
npm run test
#### Build:
npm run build