Merge pull request #20 from theAlexPatin/develop

Squarelink Wallet Integration

Author: lnbc1QWFyb24

README.md

@@ -29,6 +29,8 @@ const onboard = Onboard.init({
   modules: {
     // default wallets that are included: MetaMask, Dapper, Coinbase, Trust, WalletConnect
     walletSelect: Onboard.modules.select.defaults({
+      // if you want squarelink as a wallet option
+      squarelinkInit: { apiKey: "Your squarelink key here" },
       // if you want fortmatic as a wallet option
       fortmaticInit: { apiKey: "Your fortmatic key here" },
       // if you want portis as a wallet option
@@ -176,6 +178,7 @@ The wallet select modules are functions that return a wallet object. The followi
 - `dapper`
 - `walletConnect` (requires initialization)
 - `portis` (requires initialization)
+- `squarelink` (requires initialization)
 - `fortmatic` (requires initialization)
 
 #### Mobile Wallets
@@ -184,6 +187,7 @@ The wallet select modules are functions that return a wallet object. The followi
 - `coinbase`
 - `walletConnect` (requires initialization)
 - `portis` (requires initialization)
+- `squarelink` (requires initialization)
 - `fortmatic` (requires initialization)
 
 `defaults` Initialization:
@@ -192,7 +196,8 @@ The wallet select modules are functions that return a wallet object. The followi
 modules.select.defaults({
   heading: String, // Override the default heading [optional]
   description: String, // Override the default description [optional]
-  networkId: Number, // Required if you want the Portis or Fortmatic modules to be included
+  networkId: Number, // Required if you want the Portis, Squarelink, or Fortmatic modules to be included
+  squarelinkInit: Object, // initialization object for Squarelink module (see below)
   portisInit: Object, // initialization object for Portis module (see below)
   fortmaticInit: Object // initialization object for Fortmatic module (see below)
 })
@@ -207,11 +212,20 @@ portis({
 })
 ```
 
+`squarelink` Initialization:
+
+```javascript
+squarelink({
+  apiKey: String, // your Squarelink api key
+  networkId: Number //  the networkId of the network you want to connect to
+})
+```
+
 `fortmatic` Initialization:
 
 ```javascript
 fortmatic({
-  apiKey: String, // your Portis api key
+  apiKey: String, // your Fortmatic api key
   networkId: Number //  the networkId of the network you want to connect to
 })
 ```
@@ -231,7 +245,7 @@ import Onboard from "bnc-onboard"
 
 // PICK AND CHOOSE MODULES
 
-const { portis, dapper, metamask, fortmatic } = Onboard.modules.select
+const { portis, squarelink, dapper, metamask, fortmatic } = Onboard.modules.select
 
 const onboard = Onboard.init({
   // ...
@@ -242,7 +256,8 @@ const onboard = Onboard.init({
         "Please select the wallet that you would like to use with this Dapp",
       wallets: {
         desktop: [
-          portis({ apiKey: 'sdda-w2-ds3', networkId: 1 })
+          portis({ apiKey: 'sdda-w2-ds3', networkId: 1 }),
+          squarelink({ apiKey: 'sdda-w2-ds3', networkId: 1 }),
           dapper(),
           metmask(),
         ],

package.json

@@ -26,17 +26,18 @@
     "babel-plugin-external-helpers": "^6.18.0"
   },
   "dependencies": {
+    "@portis/web3": "^2.0.0-beta.42",
+    "@walletconnect/web3-provider": "^1.0.0-beta.36",
     "bignumber.js": "^9.0.0",
     "bnc-sdk": "0.1.1",
     "bowser": "^2.5.2",
+    "fortmatic": "^0.8.2",
     "ow": "^0.13.2",
     "promise-cancelable": "^2.1.1",
     "regenerator-runtime": "^0.13.3",
+    "squarelink": "^1.1.3",
     "svelte": "^3.0.0",
-    "svelte-i18n": "^1.1.2-beta",
-    "@portis/web3": "^2.0.0-beta.42",
-    "@walletconnect/web3-provider": "^1.0.0-beta.36",
-    "fortmatic": "^0.8.2"
+    "svelte-i18n": "^1.1.2-beta"
   },
   "scripts": {
     "prepare": "rollup -c",

rollup.config.js

@@ -46,11 +46,12 @@ export default [
       "svelte/store",
       "svelte/internal",
       "svelte/transition",
+      "squarelink",
       "promise-cancelable",
       "regenerator-runtime/runtime",
       "@portis/web3",
       "@walletconnect/web3-provider",
-      "fortmatic"
+      "fortmatic",
     ],
     plugins: [
       svelte(),

src/modules/select/index.js

@@ -5,18 +5,25 @@ import coinbase from "./wallets/coinbase"
 import trust from "./wallets/trust"
 import portis from "./wallets/portis"
 import fortmatic from "./wallets/fortmatic"
+import squarelink from "./wallets/squarelink"
 
 function defaults({
   heading,
   description,
   networkId,
   fortmaticInit,
   portisInit,
+  squarelinkInit,
   walletConnectInit
 }) {
   const desktopModules = [metamask(), dapper()]
   const mobileModules = [coinbase(), trust()]
 
+  if (squarelinkInit) {
+    desktopModules.push(squarelink({ ...squarelinkInit, networkId }))
+    mobileModules.push(squarelink({ ...squarelinkInit, networkId }))
+  }
+
   if (portisInit) {
     desktopModules.push(portis({ ...portisInit, networkId }))
     mobileModules.push(portis({ ...portisInit, networkId }))
@@ -56,5 +63,6 @@ export default {
   coinbase,
   trust,
   portis,
-  fortmatic
+  fortmatic,
+  squarelink
 }

src/modules/select/wallet-icons/icon-squarelink.svg

@@ -0,0 +1,72 @@
+import Squarelink from "squarelink"
+
+import { networkName } from "../../../utilities"
+import sqlkIcon from "../wallet-icons/icon-squarelink.svg"
+
+function squarelink(options) {
+  if (!options || typeof options !== "object") {
+    throw new Error("An options object is required to initialize squarelink module")
+  }
+
+  const { apiKey, networkId } = options
+
+  if (!apiKey || typeof apiKey !== "string") {
+    throw new Error(
+      "A apiKey of type string is required to initialize squarelink module"
+    )
+  }
+
+  if (!network || typeof networkId !== "number") {
+    throw new Error(
+      "A network of type number is required to initialize squarelink module"
+    )
+  }
+
+  return {
+    name: "Squarelink",
+    iconSrc: sqlkIcon,
+    wallet: ({ BigNumber }) => {
+      const sqlk = new Squarelink(apiKey, networkName(networkId), { useSync: true })
+      const provider = sqlk.getProviderSync()
+
+      return {
+        provider,
+        interface: {
+          name: "Squarelink",
+          connect: provider.enable,
+          address: {
+            get: () => Promise.resolve(provider.accounts[0])
+          },
+          network: {
+            get: () => Promise.resolve(networkId)
+          },
+          balance: {
+            get: () =>
+            new Promise(resolve => {
+              if (!provider.accounts.length) {
+                resolve(null)
+                return
+              }
+
+              provider.sendAsync(
+                {
+                  method: "eth_getBalance",
+                  params: [
+                    provider.accounts[0],
+                    "latest"
+                  ],
+                  id: 1
+                },
+                (e, res) => {
+                  resolve(BigNumber(res.result).toString(10))
+                }
+              )
+            })
+          }
+        }
+      }
+    }
+  }
+}
+
+export default squarelink

src/modules/select/wallets/squarelink.js

@@ -17,6 +17,7 @@ interface selectDefaultsOptions {
   networkId: number
   fortmaticInit?: any
   portisInit?: any
+  squarelinkInit?: any
   walletConnectInit?: any
 }
 
@@ -28,6 +29,7 @@ interface select {
   coinbase: () => any
   trust: () => any
   portis: (options: { apiKey: string; network: string }) => any
+  squarleink: (options: { apiKey: string; network: string }) => any
   fortmatic: (options: { apiKey: string; network: string }) => any
 }
 

types.d.ts

@@ -2320,7 +2320,7 @@ esutils@^2.0.2:
   resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
   integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==
 
-eth-block-tracker@^4.2.0:
+eth-block-tracker@^4.2.0, eth-block-tracker@^4.4.1:
   version "4.4.3"
   resolved "https://registry.yarnpkg.com/eth-block-tracker/-/eth-block-tracker-4.4.3.tgz#766a0a0eb4a52c867a28328e9ae21353812cf626"
   integrity sha512-A8tG4Z4iNg4mw5tP1Vung9N9IjgMNqpiMoJ/FouSFwNCGHv2X0mmOYwtQOJzki6XN7r7Tyo01S29p7b224I4jw==
@@ -2380,6 +2380,26 @@ eth-json-rpc-middleware@^1.5.0:
     promise-to-callback "^1.0.0"
     tape "^4.6.3"
 
+eth-json-rpc-middleware@^4.1.1:
+  version "4.3.0"
+  resolved "https://registry.yarnpkg.com/eth-json-rpc-middleware/-/eth-json-rpc-middleware-4.3.0.tgz#d3e72efb60b6f601f022ce01384481eaed552b6b"
+  integrity sha512-Acr+FaIHB0oIV0nWrCvepQghgA3FzYFvnMDXdTUeHQvAX/G6ioMbw1exGJs+6HirRjJ+MmkZqaArphx+PTrRNQ==
+  dependencies:
+    btoa "^1.2.1"
+    clone "^2.1.1"
+    eth-json-rpc-errors "^1.0.1"
+    eth-query "^2.1.2"
+    eth-sig-util "^1.4.2"
+    ethereumjs-block "^1.6.0"
+    ethereumjs-tx "^1.3.7"
+    ethereumjs-util "^5.1.2"
+    ethereumjs-vm "^2.6.0"
+    fetch-ponyfill "^4.0.0"
+    json-rpc-engine "^5.1.3"
+    json-stable-stringify "^1.0.1"
+    pify "^3.0.0"
+    safe-event-emitter "^1.0.1"
+
 eth-json-rpc-middleware@^4.1.4:
   version "4.2.0"
   resolved "https://registry.yarnpkg.com/eth-json-rpc-middleware/-/eth-json-rpc-middleware-4.2.0.tgz#cfb77c5056cb8001548c6c7d54f4af5fce04d489"
@@ -4846,6 +4866,42 @@ split-string@^3.0.1, split-string@^3.0.2:
   dependencies:
     extend-shallow "^3.0.0"
 
+squarelink-provider-engine@^15.0.5:
+  version "15.0.5"
+  resolved "https://registry.yarnpkg.com/squarelink-provider-engine/-/squarelink-provider-engine-15.0.5.tgz#93a440c5daec517b1b494424d1c279f195cd781c"
+  integrity sha512-rl9586BLpN/ldujibbMsCfq+lEyY/YMkmWqYcbmKs6VUvB56fsIG23HvVFl1mPRUu7XIq4dOt+V+4G6+GcKTtQ==
+  dependencies:
+    async "^2.5.0"
+    backoff "^2.5.0"
+    clone "^2.0.0"
+    cross-fetch "^2.1.0"
+    eth-block-tracker "^4.4.1"
+    eth-json-rpc-filters "^4.0.2"
+    eth-json-rpc-infura "^3.1.0"
+    eth-json-rpc-middleware "^4.1.1"
+    eth-sig-util "^1.4.2"
+    ethereumjs-block "^1.2.2"
+    ethereumjs-tx "^1.2.0"
+    ethereumjs-util "^5.1.5"
+    ethereumjs-vm "^2.3.4"
+    json-rpc-error "^2.0.0"
+    json-stable-stringify "^1.0.1"
+    promise-to-callback "^1.0.0"
+    readable-stream "^2.2.9"
+    request "^2.85.0"
+    semaphore "^1.0.3"
+    ws "^5.1.1"
+    xhr "^2.2.0"
+    xtend "^4.0.1"
+
+squarelink@^1.1.3:
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/squarelink/-/squarelink-1.1.3.tgz#e799fabb3055916a1e06567c0efc804945671ff2"
+  integrity sha512-DHYE2epLW59ylejSVdaqwKyE0TO7nqPeHiVwemOYLjFRrkMYXRMK7xh8CjsBJIXqyf5JmpnNNLinLAikKv0X4g==
+  dependencies:
+    bignumber.js "^9.0.0"
+    squarelink-provider-engine "^15.0.5"
+
 sshpk@^1.7.0:
   version "1.16.1"
   resolved "https://registry.yarnpkg.com/sshpk/-/sshpk-1.16.1.tgz#fb661c0bef29b39db40769ee39fa70093d6f6877"
@@ -5244,7 +5300,7 @@ vlq@^0.2.2:
     eth-block-tracker "^4.2.0"
     eth-json-rpc-filters "^4.0.2"
     eth-json-rpc-infura "^3.1.0"
-    eth-json-rpc-middleware "github:walletconnect/eth-json-rpc-middleware"
+    eth-json-rpc-middleware "^4.1.1"
     eth-sig-util "^1.4.2"
     ethereumjs-block "^1.2.2"
     ethereumjs-tx "^1.2.0"