Add Enkrypt and MEW Wallet DApp browser as SDKs (#1291)

* devop: add enkrypt and mew wallet

* chore: update version

* update packages with necessary changes to fit current W3O patterns(versioning, injected packages changes, routing for docs)

* Remove enkrypt from injected provider labels

* Remove yarn lock within mew package

* Mark mew package as deprecated

* devop: remove unused packages

* devop: move tsconfig to the right places, fix build

* devop: remove tsconfig in the wrong place

* Update docs and deploy for new mew-wallet package

* Update enkrypt injected provider

* Update injected, MEW Wallet and Enkrypt packages

* Update handling of ChainIds

* fix: throw error for unsupported chains

* chore: make mew wallet throw error on unsupported chains

* devop: add check for ios unsupported chains

* chore: change error

* chore: change error

* chore: change error

* chore: remove console

* chore: remove hex conversion code

* Remove package level yarn.lock files

* Remove unused mew icon from injected package

* Add yarn options to readmes

* Clean up log

* Bump mew package version to display deprecated warning

* chore: update logo

* Update packages/enkrypt/README.md

* Prettier formatting

* Apply suggestions from code review

* Refine mew package.json

Co-authored-by: Adam Carpenter <adamcarpenter86@gmail.com>

Author: gamalielhere

.circleci/config.yml

@@ -219,6 +219,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/mew
     steps:
       - node-build-steps
+  build-mew-wallet:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/mew-wallet
+    steps:
+      - node-build-steps
   build-portis:
     docker:
       - image: cimg/node:16.13.1
@@ -309,6 +315,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/tallyho
     steps:
       - node-build-steps
+  build-enkrypt:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/enkrypt
+    steps:
+      - node-build-steps
 
   # Build staging/Alpha releases
   build-staging-core:
@@ -365,6 +377,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/mew
     steps:
       - node-staging-build-steps
+  build-staging-mew-wallet:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/mew-wallet
+    steps:
+      - node-staging-build-steps
   build-staging-portis:
     docker:
       - image: cimg/node:16.13.1
@@ -455,6 +473,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/tallyho
     steps:
       - node-staging-build-steps
+  build-staging-enkrypt:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/enkrypt
+    steps:
+      - node-staging-build-steps
 
 workflows:
   version: 2
@@ -513,6 +537,12 @@ workflows:
           <<: *deploy_production_filters
       - build-staging-mew:
           <<: *deploy_staging_filters
+  mew-wallet:
+    jobs:
+      - build-mew-wallet:
+          <<: *deploy_production_filters
+      - build-staging-mew-wallet:
+          <<: *deploy_staging_filters
   portis:
     jobs:
       - build-portis:
@@ -603,3 +633,9 @@ workflows:
           <<: *deploy_production_filters
       - build-staging-tallyho:
           <<: *deploy_staging_filters
+  enkrypt:
+    jobs:
+      - build-enkrypt:
+          <<: *deploy_production_filters
+      - build-staging-enkrypt:
+          <<: *deploy_staging_filters

README.md

@@ -93,10 +93,11 @@ For full documentation, check out the README.md for each package:
 - [Magic](packages/magic/README.md)
 - [Fortmatic](packages/fortmatic/README.md)
 - [Portis](packages/portis/README.md)
-- [MEW](packages/mew/README.md)
+- [MEW-Wallet](packages/mew-wallet/README.md)
 - [Web3Auth](packages/web3auth/README.md)
 - [Sequence](packages/sequence/README.md)
 - [TallyHo](packages/tallyho/README.md)
+- [Enkrypt](packages/enkrypt/README.md)
 
 **Hardware Wallets**
 

packages/demo/package.json

@@ -28,7 +28,7 @@
     "@web3-onboard/fortmatic": "^2.0.14",
     "@web3-onboard/gas": "^2.1.3",
     "@web3-onboard/gnosis": "^2.1.3",
-    "@web3-onboard/injected-wallets": "^2.3.0",
+    "@web3-onboard/injected-wallets": "^2.4.0-alpha.1",
     "@web3-onboard/keepkey": "^2.3.2",
     "@web3-onboard/keystone": "^2.3.2",
     "@web3-onboard/ledger": "^2.3.2",
@@ -40,6 +40,8 @@
     "@web3-onboard/tallyho": "^2.0.1",
     "@web3-onboard/walletconnect": "^2.2.0-alpha.1",
     "@web3-onboard/web3auth": "^2.1.3",
+    "@web3-onboard/enkrypt": "^2.0.0-alpha.1",
+    "@web3-onboard/mew-wallet": "^2.0.0-alpha.1",
     "vconsole": "^3.9.5"
   },
   "license": "MIT",

packages/demo/src/App.svelte

@@ -17,6 +17,8 @@
   import dcentModule from '@web3-onboard/dcent'
   import sequenceModule from '@web3-onboard/sequence'
   import tallyHoModule from '@web3-onboard/tallyho'
+  import enkryptModule from '@web3-onboard/enkrypt'
+  import mewWalletModule from '@web3-onboard/mew-wallet'
   import {
     recoverAddress,
     arrayify,
@@ -107,13 +109,18 @@
 
   const sequence = sequenceModule()
 
+  const enrkypt = enkryptModule()
+  const mewWallet = mewWalletModule()
+
   const onboard = Onboard({
     wallets: [
       injected,
       web3auth,
       ledger,
       trezor,
       walletConnect,
+      enrkypt,
+      mewWallet,
       keepkey,
       keystone,
       coinbaseWallet,

packages/enkrypt/README.md

@@ -0,0 +1,31 @@
+# @web3-onboard/enkrypt
+
+## Wallet module for connecting Enkrypt wallet through web3-onboard
+
+### Install
+
+**NPM**
+`npm i @web3-onboard/core @web3-onboard/enkrypt`
+
+**Yarn**
+`yarn add @web3-onboard/core @web3-onboard/enkrypt`
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import enrkypt from '@web3-onboard/enkrypt'
+
+const enrkyptModule = enrkypt()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    enrkyptModule
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```

packages/enkrypt/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@web3-onboard/enkrypt",
+  "version": "2.0.0-alpha.1",
+  "description": "Enkrypt SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
+  "keywords": [
+    "Ethereum",
+    "Web3",
+    "EVM",
+    "dapp",
+    "Multichain",
+    "Wallet",
+    "Transaction",
+    "Provider",
+    "Hardware Wallet",
+    "Notifications",
+    "React",
+    "Svelte",
+    "Vue",
+    "Next",
+    "Nuxt",
+    "MetaMask",
+    "Coinbase",
+    "WalletConnect",
+    "Ledger",
+    "Trezor",
+    "Connect Wallet",
+    "Ethereum Hooks",
+    "Blocknative",
+    "Mempool",
+    "pending",
+    "confirmed",
+    "Injected Wallet",
+    "Crypto",
+    "Crypto Wallet",
+    "Enkrypt"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/blocknative/web3-onboard.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://www.blocknative.com/onboard",
+  "bugs": "https://github.com/blocknative/web3-onboard/issues",
+  "module": "dist/index.js",
+  "browser": "dist/index.js",
+  "main": "dist/index.js",
+  "type": "module",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "type-check": "tsc --noEmit"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@ethersproject/providers": "^5.5.0",
+    "@types/node": "^17.0.21",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.5.5",
+    "window": "^4.2.7"
+  },
+  "dependencies": {
+    "@web3-onboard/common": "^2.2.2"
+  }
+}

packages/enkrypt/src/icon.ts

@@ -0,0 +1,12 @@
+export default `
+<svg width="81" height="81" viewBox="0 0 81 81" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M17.0057 17.0062C18.9303 15.0816 21.5405 14.0004 24.2622 14.0004L67.3296 14V21.8741C67.3296 23.8305 66.5523 25.7067 65.169 27.09C63.7857 28.4733 61.9095 29.2504 59.9532 29.2504H39.7045C36.9828 29.2504 34.3726 30.3316 32.448 32.2561C30.5235 34.1807 29.4423 36.7909 29.4423 39.5126V42.1242C29.4423 44.8459 30.5235 47.4561 32.448 49.3806C34.3726 51.3051 36.9828 52.3863 39.7045 52.3863H59.9532C61.9095 52.3863 63.7857 53.1635 65.169 54.5468C66.5523 55.9301 67.3296 57.8063 67.3296 59.7626V67.33H24.2622C21.5405 67.33 18.9303 66.2488 17.0057 64.3243C15.0812 62.3997 14 59.7895 14 57.0678V24.2626C14 21.5409 15.0812 18.9307 17.0057 17.0062ZM40.1479 33.5423H60.9157C64.458 33.5423 67.3295 36.4138 67.3295 39.9561V41.6816C67.3295 45.2238 64.458 48.0954 60.9157 48.0954H40.1479C36.6057 48.0954 33.7341 45.2238 33.7341 41.6816V39.9561C33.7341 36.4138 36.6057 33.5423 40.1479 33.5423Z" fill="url(#paint0_linear_287_2359)"/>
+<defs>
+<linearGradient id="paint0_linear_287_2359" x1="19.3602" y1="14" x2="56.7696" y2="69.8005" gradientUnits="userSpaceOnUse">
+<stop stop-color="#C549FF"/>
+<stop offset="1" stop-color="#654BFF"/>
+</linearGradient>
+</defs>
+</svg>
+
+`

packages/enkrypt/src/index.ts

@@ -0,0 +1,45 @@
+import type {
+  WalletInit,
+  SimpleEventEmitter,
+  EIP1193Provider
+} from '@web3-onboard/common'
+import { createEIP1193Provider } from '@web3-onboard/common'
+import { CustomWindow } from './types.js'
+declare const window: CustomWindow
+
+function enkrypt(): WalletInit {
+  if (typeof window === 'undefined') return () => null
+  return () => {
+    return {
+      label: 'Enkrypt',
+      getIcon: async () => (await import('./icon.js')).default,
+      getInterface: async () => {
+        const enkryptExists = window.hasOwnProperty('enkrypt')
+
+        if (enkryptExists) {
+          const enkryptProvider: EIP1193Provider = window.enkrypt.providers
+            .ethereum as EIP1193Provider
+          const addListener: SimpleEventEmitter['on'] =
+            enkryptProvider.on.bind(enkryptProvider)
+
+          enkryptProvider.on = (event, func) => {
+            addListener(event, func)
+          }
+
+          const provider = createEIP1193Provider(enkryptProvider)
+
+          provider.removeListener = (event, func) => {}
+
+          return {
+            provider
+          }
+        } else {
+          window.open('https://enkrypt.com', '_blank')
+          throw new Error('Please Install Enkrypt to use this wallet')
+        }
+      }
+    }
+  }
+}
+
+export default enkrypt

packages/enkrypt/src/types.ts

@@ -0,0 +1,6 @@
+import type { ExternalProvider } from '@ethersproject/providers'
+export interface CustomWindow extends Window {
+  enkrypt: {
+    providers: { ethereum: ExternalProvider }
+  }
+}

packages/enkrypt/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*"],
+
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationDir": "dist",
+    "paths": {
+      "*": ["./src/*", "./node_modules/*"]
+    },
+    "typeRoots": ["node_modules/@types"]
+  }
+}