Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 4.75 KB

README.md

File metadata and controls

142 lines (87 loc) · 4.75 KB
Raw

Torus Embed — New Frictionless login for Dapps by Web3Auth

npm version npm minzip

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.

📖 Documentation

Checkout the official Torus Documentation for Torus Embed to get started.

🔗 Installation

npm install --save @toruslabs/torus-embed

⚡ Quick Start

Get your Client ID from Web3Auth Dashboard

Hop on to the Web3Auth Dashboard and create a new Torus Wallet project. Use the Client ID of the project to start your integration.

Web3Auth Dashboard - Torus Wallets

Initialize & Login

import Torus from "@toruslabs/torus-embed";
import Web3 from "web3";

const torus = new Torus();
await torus.init();
await torus.login(); // await torus.ethereum.enable()
const web3 = new Web3(torus.provider);

🩹 Examples

Checkout the example of Torus Embed in our example directory.

🌐 Demo

Checkout the Torus Embed Demo to see how Torus Embed can be used in your application.

💬 Troubleshooting and Discussions

  • Have a look at our GitHub Discussions to see if anyone has any questions or issues you might be having.
  • Checkout our Troubleshooting Documentation Page to know the common issues and solutions
  • Join our Discord to join our community and get private integration support or help with your integration.

Introduction

This module generates the javascript to include in a DApp via a script tag. It creates an iframe that loads the Torus page and sets up communication streams between the iframe and the DApp javascript context.

Please refer to docs for API Reference available here or change log.

Features

  • Typescript compatible. Includes Type definitions

Please refer to docs for API Reference available here or change log.

Installation

Bundling

This module is distributed in 3 formats

  • commonjs build dist/torus.cjs.js in es5 format
  • umd build dist/torus.umd.min.js in es5 format without polyfilling corejs minified
  • umd build dist/torus.polyfill.umd.min.js in es5 format with polyfilling corejs minified

By default, the appropriate format is used for your specified usecase You can use a different format (if you know what you're doing) by referencing the correct file

The cjs build is not polyfilled with core-js. It is upto the user to polyfill based on the browserlist they target

Directly in Browser

CDN's serve the non-core-js polyfilled version by default. You can use a different

jsdeliver

<script src="https://cdn.jsdelivr.net/npm/@toruslabs/torus-embed"></script>

unpkg

<script src="https://unpkg.com/@toruslabs/torus-embed"></script>

Tips for NUXT

This is a plugin that works only on the client side. So please register it as a ssr-free plugin.

Usage

Please refer to the examples folder for details on usage using dynamic import.

Rehydration

Torus uses window.sessionStorage to store user details.

So, if the user reloads the page, all his data would be rehydrated and the user doesn't need to log in.

The samples provided in the examples folder illustrate the above case.

Build

Ensure you have a Node.JS development environment setup:

git clone https://github.com/torusresearch/torus-embed.git
cd torus-embed
npm install
npm run build

To run tests:

npm run test:e2e:headful
npm run test:build-embed

entry-point: index.js

Requirements

  • This package requires a peer dependency of @babel/runtime
  • Node 16+

License

torus-embed is MIT Licensed