/narwallets-extension

Chrome browser extension wallet for the NEAR Blockchain

Primary LanguageTypeScriptOtherNOASSERTION

Narwallet Chrome Extension

Installation

Install Narwallets from the Chrome Web Store

Objectives

  • Be the deafult chrome-extension wallet for NEAR DApps
  • What Metamask does for ethereum, we intend to do for NEAR

Comparision with NEAR Official Web Wallet

  • Narwallets-extension aims to be a simpler and complemetary tool to the official NEAR Web wallet
  • Narwallets is designed for a desktop/laptop experience with a chromium based browser, NEAR Web wallet works on any browser and mobile
  • Narwallets is available only in english, NEAR Web wallet supports multiple languages
  • Narwallets is not yet integrated with Ledger or other HW Wallets
  • Narwallets has only one option regading account recovery: Write-down the seed phrase. NEAR Web Wallet has other user-friendly recovery options (email & phone recovery).
  • Narwallets, aiming at simplicity, has no 2FA support yet.

The good:

  • It's an extension-wallet: You'll be able to interact with DApps without leaving the DApp web site
  • Provides a similar experience as Metamask/other extension-wallets, easing the onboard of ethereum users into the NEAR ecosystem.
  • Each wallet can have multiple accounts. You can see the sum of all your accounts in the wallet
  • You can have multiple wallets by providing different user/passwords.
  • Accounts are first added to in safe-by-default read-only mode (no keys)
  • All private data is stored encrypted on chrome local storage
  • Create free implict accounts (no near required)
  • Lockup contract accounts are auto-discovered and treated as another account in the group
  • Advanced mode allows you to take full control of your lockup contract account
  • Integration with DApps. New model: wallet initiated connection to active tab, resulting in chain & wallet agnostic DApps. See Wallet integration API Documentation here

multiple accounts and total

Road Map

Future versions

  • Ledger integration
  • 2FA Support
  • Manage Create named account (currently redirecting to NEAR Web Wallet)

Dev Tooling (v0.1)

  • This project uses typescript
  • Being a chrome extension, no bundler/minimizer is needed
  • No frameworks are used neither, this is plain typescript and a main index.html

Dev Flow (v0.1)

  • Chrome Dev Tools: Map folder to Narwallets-extension/extension
  • Use Chrome Dev Tools as an quick-and-dirty IDE with Edit & Continue
  • Use VSCode as the main IDE - Ctrl-Shift-B to build with typescript

Low-level Technical debt

  • Remove plus-typescript, convert all to typescript
  • npm i eslint --save-dev
  • When wallet-API was added a lot of functions became async. Add npm install eslint-plugin-no-floating-promise --save-dev

We're using base crypto libs as a bundle (The ideal solution would be to have typescript versions of each lib and compile to ES2020 modules)

  • Replace bundle with typescript versions of basic crypto tools

We need to reduce the bundle's size. Bundle is at https://github.com/Narwallets/bundled-crypto-libs.git

Bundle includes:

  • globalThis.Buffer = SafeBuffer.Buffer
  • globalThis.BN = BN
  • globalThis.bip39 = bip39
  • globalThis.pbkdf2 = pbkdf2
  • globalThis.createHmacPackage = {createHmac:createHmac}

Beta Test Installation (Latest Unstable Version)

Clone this repository and run as unpacked extension:

  • git clone https://github.com/Narwallets/narwallets-extension.git
  • cd narwallets-extension
  • install packages: npm install
  • compile: npm run build
  • open chrome
  • enable Extensions Developer Mode
  • load unpacked extension from [your-repos-dir]/narwallets-extension/extension

When new versions of the code are pushed

  • cd narwallets-extension
  • get changes: git pull
  • install packages: npm install (in case there were changes)
  • compile: npm run build
  • open extension
  • right-mouse-button-click con the extension popup, "Inspect" -> will open chrome-developer-tools
  • press Ctrl-R on the developer-tools, that will make sure you're using the last compilation