@getsafle/safle-keyless-js

safle-keyless-js

This package allows a dapp to enable "Sign In With Safle" as a mechanism to enable their users to interact with the dapp using a custom safle widget and perform transactions using their safle password and pin in a non custodial manner.

safle-keyless-js

Talking about user adoption, the bottleneck faced by most of the dApps is the user onboarding flow. The user needs to have a wallet, generating and operating a wallet is cumbersome for a new crypto user.

safle-keyless-js abstracts the private key from the user and allows the user to sign transaction in an easy way while having the same level of security as before.

safle-keyless-js allow users to sign transactions via,

1. Password
2. Biometrics A. Fingerprint B. FaceID
3. Device based virtual Hardware Security Module

We have made password based transaction signing available for anyone to use, build upon and replicate.

This documentation focuses more on that, more coming soon. If you want to know more and enagage with development, you can email at the address in footnotes.

Happy #BUIDLing

Design Principles

1. Private Key Abstraction - SafleID infrastructure never have the visibility of the private key, it's encrypted on the client with the user password(unsalted & unencrypted) and sent to the virtual Hardware Security Module for safe storage.
2. Password Invisibility - User password is never exposed in plain text to any of the systems apart from the client.
3. Non-Custodial Relationship - User Private Key is always exportable and encrypted version can be deleted (redundant) from the Safle infrastructure.
4. App Agnostic - Any application without getting an API key can access SafleID service, password based transaction signing requires special access which can be requested for. (In Alpha Testing).

Check out the extensive documentation on how to integrate and use Keyless here

Installation and Usage

Installation

Install the package by running the command,

npm install --save @getsafle/safle-keyless-js

Import the package into your project using,

import Keyless from "@getsafle/safle-keyless-js";

Functions

Initialising

Initialise the constructor using,

let keyless = new Keyless("mumbaitestnet");

mumbaitestnet - The name of the network supported in keyless. Default is ethereum mainnet with the name mainnet

Once the constructor is intialized, call init() to initialize login.

    await keyless.init(true);

Use onLogin() to manage the state of the dApp when the user is loggedIn from Keyless.

    keyless.onLogin((userAddress, chainDetails) => {
        // Any function you want to call to manage the state
    });

Once the user is loggedIn, update the chain details in Keyless object

      keyless = await keyless.updateWeb3(chainDetails);

Initialize web3 instance

import Web3  from 'web3';

const w3 = new Web3(keyless.provider);

Check the Keyless class connection to a dApp

The following function disconnects Web3 from Keyless. It returns true/false if disconnected:

keyless.disconnect();

Chain/Account Selection

The selectChain()command opens the modal for selecting the active chains. The following code triggers chain/address selection

keyless.selectChain();

During the chain selection process, Keyless will send chainChanged and accountsChangedevents.

To get the selected account, you can use the web3 functions

const accounts = await w3.eth.getAccounts();

Open Dashboard

To open the dashboard, you have to make sure that you are logged in. In order for you to do that, you have to use the following command

keyless.isLoggedIn();

If the returned result is true, it means that you are logged in, and you can open the dashboard by using the following command

keyless.openDashboard();

Check Balance

You can check the balance using the standard web3 function like

const balance = await w3.eth.getBalance(address);

Perform Transactions

To open the transaction review modal, use the below code,

const resp = await w3.eth.sendTransaction(rawTransactionObject);

The rawTransactionObject is an object containing the transaction details like the sender, recipient, value, etc.

Event handler for transaction success/failure

w3.currentProvider.on('transactionSuccess', ( receipt ) => {
    console.log('transaction success', receipt );            
});
        
w3.currentProvider.on('transactionFailed', ( receipt ) => {
    console.log('transaction failed', receipt );
});

Sign Messages

To open the sign message modal, use the below code

const signedMessage = await w3.eth.sign( 'Any message', activeAddress );

WIP

Want to contribute, we would ❤️ that!

We are a Global 🌏🌍🌎 team! 💪

Write to [e-mail], or follow us on twitter, https://twitter.com/getsafle