JSPM – @toruslabs/torus-embed@0.0.17

Package Exports

@toruslabs/torus-embed

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@toruslabs/torus-embed) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

This module generates the javascript to be included 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.

Installation

Torus has been designed for gradual adoption from the start. You can use Torus as a web3 provider dynamically (on demand) or by default

Usage:

As a script tag

Include the script tag into the body of your index.html This would include torus by default into the page and will override if other web3 providers are present
As a package on npm
```
npm install @toruslabs/torus-embed
```
This approach would ensure that you can
- use torus only if user agrees to (selecting from a choice of providers)
- use torus as default if no other web3 providers are present
Please refer to examples folder for details on usage using dynamic import

Documentation

Torus uses window.sessionStorage to store user details So, if user reloads the page, all his data would be rehydrated and the user doesn't need to login

These cases are demonstrated in the samples provided in the examples folder

What you need to build your own

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

Entrypoint: index.js

License

Torus Embed is MIT Licensed

@toruslabs/torus-embed