@getsafle/keyless-transactions NPM

Keyless Transactions - Safle

This package enables usage of SafleID infrastructure as a keyless signing mechanism.

Disclaimer - This is WIP, and release in beta.

Keyless Transactions

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.

Keyless transactions 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 Transactions allow users to sign transactions via,

Password
Biometrics A. Fingerprint B. FaceID
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

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.
Password Invisibility - User password is never exposed in plain text to any of the systems apart from the client.
Non-Custodial Relationship - User Private Key is always exportable and encrypted version can be deleted (redundant) from the Safle infrastructure.
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).

Installation and Usage

Installation

Install the package by running the command,

npm install @getsafle/keyless-transactions

Import the package into your project using,

const safle = require('@getsafle/keyless-transactions');

Keyless Transactions

Initialising

Initialise the constructor using,

const keyless = new safle.Keyless({ apiKey, apiSecret, rpcURL, env });

apiKey - The API Key for this SDK. apiSecret - The API Secret for this SDK. web3URL - Web3 RPC provider URL.

Get User

This method can be used to sign a transaction using the user's private key. The transaction can be done using the provider as infura by inputting the infura key or the RPC URL.

const getUser = keyless.getUser({ userName, password });

userName - The Safle username of the user. password - The Safle password of the user.

Sign Transaction

This method can be used to sign a transaction using the user's private key. The transaction can be done using the provider as infura by inputting the infura key or the RPC URL.

const signedTx = keyless.signTransaction({ to, value, gasPrice, gasLimit, data, nonce, password });

to (required) - THe address of the recepient. value (required) - The amount to be sent. password (required) - The Safle password of the user. gasPrice (optional) - The gas price. gasLimit (optional) - Gas Limit. data (optional) - Data. nonce (optional) - Nonce.

Send Transaction

This method can be used to sign a transaction using the user's private key. The transaction can be done using the provider as infura by inputting the infura key or the RPC URL.

const sendTx = keyless.sendTx({ signedTx });

signedTx (required) - Signed Transaction in string.

Sign and send Transaction

This method can be used to sign a transaction using the user's private key. The transaction can be done using the provider as infura by inputting the infura key or the RPC URL.

const signAndSendTx = keyless.signAndSendTx({ to, value, gasPrice, gasLimit, data, nonce, password });

Validate password and get Encrypted Private Key

This method can be used to validate a user's password and if successful, fetch the user's encrypted private key from Safle KMS.

const encryptedPKey = keyless.validatePasswordAndGetPKey({ password });

password (required) - The Safle password of the user.

Change Password

This method can be used to change a user's existing password. This method has to be called after validating the user's old password which can be done using the method validatePasswordAndGetPKey().

const changePassword = keyless.changePassword({ encryptedPrivateKey, oldPassword, newPassword, confirmPassword });

encryptedPrivateKey (required) - The encrypted private key of the user which is obtained using the function validatePasswordAndGetPKey(). oldPassword (required) - The old password of the user. newPassword (required) - The new password of the user. confirmPassword (required) - The new password of the user for confirmation.

Reset Password

This method is used to reset the password of the user incase the user forget's their password. The user needs to provide any of their below mentioned wallet info to recover their private key to reencrypt and store it in the Safle KMS.

const resetPassword = keyless.resetPassword({ privateKey, seedPhrase, encryptedJson, walletPassword, newPassword });

privateKey - The private key of the user. seedPhrase - The 12 word seed phrase of the wallet. encryptedJson - The JSON of the Keystore file. walletPassword - The password of the Keystore file. newPassword - THe new password of the user.

The user has to input either the privateKey or seedPhrase or encryptedJson in order to recover the wallet. If the user wishes to input the encryptedJson, then they also have to input the walletPassword to decrypt it.

Wallet methods

Initialising

Initialise the constructor using,

const Wallet = new safle.Wallet();

Create a new wallet

This method can be used to create a new Ethereum wallet.

const wallet = Wallet.createWallet();

Import wallet using Keystore JSON

This method can be used to import a wallet information using the keystore json and password as parameters.

const wallet = Wallet.importFromEncryptedJson(jsonData, password);

jsonData - The JSON data of the keystore file. password - The password of the keystore file.

Import wallet using Mnemonic phrase

This method can be used to import a wallet information using the 12 word seed phrase.

const wallet = Wallet.importFromMnemonic(mnemonic);

mnemonic - The 12 word seed phrase.

Import wallet using private key

This method can be used to import a wallet information using the private key.

const wallet = Wallet.importFromPrivateKey(privateKey);

privateKey - The private key of the wallet.

Widget Integration

Integrate keyless in your html page

<script src="https://unpkg.com/@getsafle/keyless-transactions@1.0.3/dist/keyless.min.js"></script>

Initialising

Widget Initialization,

keylessWidget = new safle.safle.Widget({env: '',rpcURL: ''});

Widget Initialisation Event Listener

keylessWidget.on(keylessWidget.EVENTS.KEYLESS_WIDGET_INITIALISED, (data) => {
      console.log(data)
    });

Methods

keylessWidget.initLogin();

keylessWidget.on(keylessWidget.EVENTS.LOGIN_SUCCESS, (widgetData) => {
      console.log(widgetData)   
    });

Sign and send transaction

keylessWidget.initSendTransaction({
      to: #recipient address,
      value: #value to be transferred in wei,
      gasPrice: #gasPrice,   
      gasLimit: #gasLimit,
    });

Sign and send event listeners

//Sign and send transaction success event
keylessWidget.on(keylessWidget.EVENTS.SIGN_AND_SEND_TRANSACTION_SUCCESSFUL, (data) => {
        console.log(data)
    });

//Sign and send transaction failure event keylessWidget.on(keylessWidget.EVENTS.SIGN_AND_SEND_TRANSACTION_FAILED, (data) => { console.log(data) });

> Sign transaction

keylessWidget.initSignTransaction( { to: recipient address, value: #value in wei, gasPrice: #gasPrice ,
gasLimit: #gasLimit });

> Sign transaction event listeners

//Sign transaction failure event

keylessWidget.on(keylessWidget.EVENTS.SIGN_TRANSACTION_SUCCESSFUL, (data) => { console.log(data) }); //Sign transaction failure event

keylessWidget.on(keylessWidget.EVENTS.SIGN_TRANSACTION_FAILED, (data) => {
  console.log(data)
});

### For sample integration,

Visit [this link](https://getsafle.notion.site/Javascript-10914863a7a84515b2beccd1d807f710)


## **WIP**

Want to contribute, we would ❤️ that!

We are a Global 🌏🌍🌎 team! 💪

Write to [dev@getsafle.com](mailto:dev@getsafle.com), or follow us on twitter, [https://twitter.com/getsafle](https://twitter.com/getsafle)

axios crypto-js elliptic ethereumjs-tx ethers js-sha3 web3

@infinitebrahmanuniverse/nolb-_get @everything-registry/sub-chunk-359 @getsafle/safle-token-swaps

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago