-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #644 from Web3Auth/mpc-node-example
MPC Node quickstart
- Loading branch information
Showing
9 changed files
with
9,319 additions
and
2 deletions.
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
mpc-core-kit-web/quick-starts/mpc-core-kit-node-quick-start/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Node modules | ||
node_modules/ | ||
|
||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage/ | ||
*.lcov | ||
|
||
# Production | ||
dist/ | ||
build/ | ||
|
||
# Secret files | ||
.env | ||
.env.local | ||
.env.*.local | ||
|
||
# Dependency directories | ||
jspm_packages/ | ||
|
||
# IDE files | ||
*.sublime-project | ||
*.sublime-workspace | ||
.vscode/ | ||
.idea/ | ||
.DS_Store | ||
|
||
# Storage file (contains session details) | ||
storage.json |
48 changes: 48 additions & 0 deletions
48
mpc-core-kit-web/quick-starts/mpc-core-kit-node-quick-start/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Web3Auth MPC CoreKit Node [`@web3auth/mpc-core-kit`](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) QuickStart - Node.js | ||
|
||
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/mpc-core-kit) | ||
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io) | ||
|
||
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates. | ||
|
||
This example demonstrates how to use Web3Auth's MPC CoreKit in a Node.js environment. | ||
|
||
## How to Use | ||
|
||
### Download Manually | ||
|
||
```bash | ||
npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit-node/mpc-core-kit-node-quick-start w3a-mpc-core-kit-node-quick-start | ||
``` | ||
|
||
Install & Run: | ||
|
||
```bash | ||
cd w3a-mpc-core-kit-node-quick-start | ||
npm install | ||
npm run start | ||
# or | ||
cd w3a-mpc-core-kit-node-quick-start | ||
yarn | ||
yarn start | ||
``` | ||
|
||
### Features in this QuickStart | ||
|
||
This example demonstrates the following: | ||
|
||
- **JWT Login**: Perform authentication using JWT tokens. | ||
- **Multi-Factor Authentication (MFA)**: Enable MFA using social factor keys. | ||
- **Export Mnemonic Factor**: Create and export a recovery mnemonic phrase. | ||
- **Device Factor**: Retrieve and log device factor information. | ||
- **Key Details**: Retrieve and display key details after login. | ||
- **Blockchain Interaction**: Get Ethereum accounts, balance, and sign messages on the Ethereum Mainnet. | ||
|
||
## Important Links | ||
|
||
- [Website](https://web3auth.io) | ||
- [Docs](https://web3auth.io/docs) | ||
- [Guides](https://web3auth.io/docs/guides) | ||
- [SDK / API References](https://web3auth.io/docs/sdk) | ||
- [Pricing](https://web3auth.io/pricing.html) | ||
- [Community Portal](https://community.web3auth.io) |
Oops, something went wrong.