JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 23
  • Score
    100M100P100Q16365F
  • License MIT

Direct login with torus to get user private key

Package Exports

  • @toruslabs/torus-direct-web-sdk

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-direct-web-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

torus-direct-web-sdk

This repo allows web applications to directly retrieve keys stored on the Torus Network. The attestation layer for the Torus Network is generalizable, below is an example of how to access keys via the SDK via Google.

To allow your web app to retrieve keys:

  1. Install the package npm i @toruslabs/torus-direct-web-sdk

  2. Serve service worker from baseUrl where baseUrl is the one passed while instantiating TorusSdk for specific login (example http://localhost:3000/serviceworker/). If you're already using a sw, pls ensure to port over the fetch override from our service worker

  3. For browsers where service workers are not supported or if you wish to not use service workers, create and serve redirect page from baseUrl/redirect where baseUrl is the one passed while instantiating TorusSdk for specific login ( example http://localhost:3000/serviceworker/)

  4. At verifier's interface (where you obtain client id), please use baseUrl/redirect (eg: http://localhost:3000/serviceworker/redirect) as the redirect_uri where baseUrl is the one passed while instantiating TorusSdk

  5. Instantiate the package with your own specific client-id

const torus = new TorusSdk({
  baseUrl: "http://localhost:3000/serviceworker/",
  GOOGLE_CLIENT_ID: "MY CLIENT ID GOOGLE",
  proxyContractAddress: "0x4023d2a0D330bF11426B12C6144Cfb96B7fa6183", // details for test net
  network: "ropsten", // details for test net
});
await torus.init();
  1. Trigger the login
const userInfo = await torus.triggerLogin("google", "google-MY SPECIFIC VERIFIER");

Reach out to hello@tor.us to get your verifier spun up on the testnet today!