Skip to content
forked from ankur12-1610/snapx

SnapX is a metamask snap powered with notifications and account recovery features using biometric authentication. The API keys have a rate limit, please use your own faceIO and Etherscan API Keys.

License

Notifications You must be signed in to change notification settings

Aadeesh11/snapx

 
 

Repository files navigation

SnapX

Silver Medalist 🥈 submission in ConsenSys' MetaMask Snap Development Hackathon conducted at InterIIT Tech Meet 11.0 | February 2023

Team:

Twitter Handles

  • AaryanK666
  • ankurrap
  • Aadeesh38096402
  • nishtha9960
  • shaan_kumar26
  • PartikSingh17
  • PallavAg2808
  • Sahil Saini

What does our snap do?

SnapX is a metamask snap powered with notifications and account recovery features using biometric authentication.

Demo

To see the working of SnapX, please click here.

Setup and Run

  • Run the following commands:

yarn install
yarn start

Note: If the build takes too long, kill the process and run yarn start again.

About

SnapX mainly offers two features SnapX-Notify (Snap for getting notifications), SnapX-Recovery (Snap to recover the private key).

  • SnapX-Notify

    This is a notification snap, helps user to get notifications regarding:
    • DAO Proposals
    • Balance Updates
    • NFT Offers

    Steps Involved

    • Open the Dapp.
    • Install Metamask flask and click on connect.
    • Click on SnapX notify in the sidebar.
    • Now click no get notifications.
    • Even if the dapp is closed you will get the browser notifications.
    • You can also view notifications on the dapp by clicking on the correspoding section.
    • To turn off notifications click on turn off notificaitions.

  • SnapX-RecoveryKit

    This is a recovery snap which helps user to recover private key using biometric authentication:

    Steps Involved

    • Open the Dapp.
    • Install Metamask flask and click on connect.
    • Click on SnapX recovery kit in the sidebar.
      • Setup up recovery key:

        • Click on setup recovery key.
        • Follow the on-screen instructions to scan your face.
        • Set the pin.
        • Get your recovery key and copy it to some place.
      • Recover private key:

        • In order to retrieve the lost accounts switch to the respective network in which the accounts was present.
        • Click on get private key.
        • Enter the recovery key of the wallet you need to recover, which was generated using your above.
        • Follow the on screen instructions to authenticate your face.
        • Use the recovered private keys to import your accounts in the new wallet using the metamask extension.

Aims to Accomplish

Pain points users

  • Users do not receive any update when a transaction is made to their wallet.
  • Users don't receive any notifications about offers made on their NFT on OpenSea.
  • No updates regarding proposals being launched on registered DAO to users.
  • If users have lost their private key, they may struggle to recover their MetaMask account.
  • Private key is very sensitive hence we need to safely store it.
  • If users have forgotten their seed phrase, they may have trouble accessing their account.

Our Solution

  • SnapX-Notify

    • Receive notification whenever a proposal is launched by any of the DAOs you follow.
    • Receive updates whenever someone send ether to their Metamask wallet.
    • Receive alerts when a buyer makes an offer on your published NFT on OpenSea.
  • SnapX-RecoveryKit

    • In case where the users lose their private key, we provide a method to recover the wallet via recovery key.
    • Since the recoveryKey is public (since it is encrypted) we can freely store it anywhere.

About

SnapX is a metamask snap powered with notifications and account recovery features using biometric authentication. The API keys have a rate limit, please use your own faceIO and Etherscan API Keys.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 77.3%
  • TypeScript 22.6%
  • Shell 0.1%