@tainguyentt/test-embed
v0.0.2
Published
Embed script
Downloads
3
Maintainers
Readme
Casper Embed (by Web3Auth)
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.
🔗 Installation
npm install --save @toruslabs/casper-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.
Initialize & Login
import Torus from "@toruslabs/casper-embed";
const torus = new Torus();
await torus.init({
buttonPosition: "top-left", // default: bottom-left
buildEnv: "production", // default: production
enableLogging: true, // default: false
showTorusButton: false, // default: true
whitelabel: {
theme: { isDark: true, colors: { torusBrand1: "#00a8ff" } },
logoDark: "https://web3auth.io/images/w3a-L-Favicon-1.svg",
logoLight: "https://web3auth.io/images/w3a-D-Favicon-1.svg",
topupHide: true,
},
});
await torus.login();
🩹 Examples
Checkout the example of Casper Embed
in our example directory.
🌐 Demo
Checkout the Casper Embed Demo to see how Casper 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.
Features
- Typescript compatible. Includes Type definitions
Installation
Bundling
This module is distributed in 3 formats
esm
builddist/torus.esm.js
is es6 formatcommonjs
builddist/torus.cjs.js
in es5 formatumd
builddist/torus.umd.min.js
in es5 format without 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/casper-embed"></script>
unpkg
<script src="https://unpkg.com/@toruslabs/casper-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/casper-embed.git
cd casper-embed
npm install
npm run build
To run tests:
npm run test:e2e:headful
npm run test:build-embed
entry-point: index.ts
Requirements
- This package requires a peer dependency of
@babel/runtime
- Node 14+
License
casper-embed
is MIT Licensed