Merge pull request #27 from blocknative/develop

Release 0.2.0

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
@@ -88,7 +90,7 @@ const options = {
     address: Function, // Called with the current account address of the user [String]
     network: Function, // Called with the current network id the users' wallet is connected to [Number]
     balance: Function, // Called with the current balance in `wei` of the users' current account address [String]
-    wallet: Function // Called with the users' current selected wallet [Object]: {provider: Object, name: String}
+    wallet: Function // Called with the users' current selected wallet [Object]: {provider: Object, name: String, instance: Object (if a sdk wallet)}
   },
   modules: {
     walletSelect: {
@@ -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)
 })
@@ -203,23 +208,32 @@ modules.select.defaults({
 ```javascript
 portis({
   apiKey: String, // your Portis api key
-  network: String //  the name of network you want to connect to
+  networkId: Number //  the networkId of network you want to connect to
+})
+```
+
+`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
-  network: String //  the name of the network you want to connect to
+  apiKey: String, // your Fortmatic api key
+  networkId: Number //  the networkId of the network you want to connect to
 })
 ```
 
 `walletConnect` Initialization:
 
 ```javascript
-fortmatic({
+walletConnect({
   infuraKey: String
 })
 ```
@@ -231,7 +245,13 @@ 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,11 +262,12 @@ const onboard = Onboard.init({
         "Please select the wallet that you would like to use with this Dapp",
       wallets: {
         desktop: [
-          portis({ apiKey: 'sdda-w2-ds3', network: 'main' })
+          portis({ apiKey: "sdda-w2-ds3", networkId: 1 }),
+          squarelink({ apiKey: "sdda-w2-ds3", networkId: 1 }),
           dapper(),
-          metmask(),
+          metmask()
         ],
-        mobile: [fortmatic({apiKey: 'sd-3d3-d', network: 'main'})]
+        mobile: [fortmatic({ apiKey: "sd-3d3-d", networkId: 1 })]
       }
     }
     //....
@@ -263,7 +284,7 @@ const onboard = Onboard.init({
     walletSelect: Onboard.modules.select.defaults({
       portisInit: { apiKey: "Your portis key here" },
       networkId: 4
-    }),
+    })
     // ...
   }
 })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnc-onboard",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [
@@ -26,17 +26,17 @@
     "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",
+    "bnc-sdk": "0.2.1",
     "bowser": "^2.5.2",
-    "ow": "^0.13.2",
+    "fortmatic": "^0.8.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

@@ -39,18 +39,18 @@ export default [
     external: [
       "bowser",
       "bnc-sdk",
-      "ow",
       "bignumber.js",
       "svelte-i18n",
       "svelte",
       "svelte/store",
       "svelte/internal",
       "svelte/transition",
+      "squarelink",
       "promise-cancelable",
       "regenerator-runtime/runtime",
       "@portis/web3",
       "@walletconnect/web3-provider",
-      "fortmatic"
+      "fortmatic",
     ],
     plugins: [
       svelte(),

src/index.js

@@ -15,9 +15,9 @@ import {
   walletInterface
 } from "./stores"
 
-import { validateInit, validateConfig } from "./validation"
 import { isMobileDevice } from "./utilities"
 import { initializeBlocknative } from "./services"
+import { validateInit, validateConfig } from "./validation"
 
 import { version } from "../package.json"
 

src/modules/ready/index.js

@@ -2,19 +2,13 @@ import connect from "./connect"
 import network from "./network"
 import balance from "./balance"
 
+import { validateDefaultsOptions } from "../../validation"
+
 function defaults(options) {
-  if (!options || typeof options !== "object") {
-    throw new Error("initModules must be called with a valid option object")
-  }
+  validateDefaultsOptions(options)
 
   const { networkId, minimumBalance } = options
 
-  if (!networkId || typeof networkId !== "number") {
-    throw new Error(
-      "initModules must be called with a property of networkId that is of type Number"
-    )
-  }
-
   return [connect(), network(networkId), balance(minimumBalance || "0")]
 }
 

src/modules/select/index.js

@@ -5,28 +5,28 @@ import coinbase from "./wallets/coinbase"
 import trust from "./wallets/trust"
 import portis from "./wallets/portis"
 import fortmatic from "./wallets/fortmatic"
-import { networkName } from "../../utilities"
+import squarelink from "./wallets/squarelink"
 
 function defaults({
   heading,
   description,
   networkId,
   fortmaticInit,
   portisInit,
+  squarelinkInit,
   walletConnectInit
 }) {
   const desktopModules = [metamask(), dapper()]
   const mobileModules = [coinbase(), trust()]
-  const network = networkName(networkId)
 
   if (portisInit) {
-    desktopModules.push(portis({ ...portisInit, network }))
-    mobileModules.push(portis({ ...portisInit, network }))
+    desktopModules.push(portis({ ...portisInit, networkId }))
+    mobileModules.push(portis({ ...portisInit, networkId }))
   }
 
   if (fortmaticInit) {
-    desktopModules.push(fortmatic({ ...fortmaticInit, network }))
-    mobileModules.push(fortmatic({ ...fortmaticInit, network }))
+    desktopModules.push(fortmatic({ ...fortmaticInit, networkId }))
+    mobileModules.push(fortmatic({ ...fortmaticInit, networkId }))
   }
 
   if (walletConnectInit) {
@@ -38,6 +38,11 @@ function defaults({
     )
   }
 
+  if (squarelinkInit) {
+    desktopModules.push(squarelink({ ...squarelinkInit, networkId }))
+    mobileModules.push(squarelink({ ...squarelinkInit, networkId }))
+  }
+
   return {
     heading: heading || "Select a Wallet",
     description:
@@ -58,5 +63,6 @@ export default {
   coinbase,
   trust,
   portis,
-  fortmatic
+  fortmatic,
+  squarelink
 }

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

@@ -1,50 +1,42 @@
 import Fortmatic from "fortmatic"
-import { networkToId } from "../../../utilities"
 import fortmaticIcon from "../wallet-icons/icon-fortmatic.svg"
+import { networkName } from "../../../utilities"
+import { validateType } from "../../../validation"
 
 function fortmatic(options) {
-  if (!options || typeof options !== "object") {
-    throw new Error(
-      "An options object is required to initialize fortmatic module"
-    )
-  }
-
-  const { apiKey, network } = options
+  validateType({ name: "Fortmatic options", value: options, type: "object" })
 
-  if (!apiKey || typeof apiKey !== "string") {
-    throw new Error(
-      "A apiKey of type string is required to initialize fortmatic module"
-    )
-  }
+  const { apiKey, networkId } = options
 
-  if (!network || typeof network !== "string") {
-    throw new Error(
-      "A network of type string is required to initialize fortmatic module"
-    )
-  }
+  validateType({ name: "apiKey", value: apiKey, type: "string" })
+  validateType({ name: "networkId", value: networkId, type: "number" })
 
   return {
     name: "Fortmatic",
     iconSrc: fortmaticIcon,
     wallet: ({ BigNumber }) => {
-      const fortmatic = new Fortmatic(apiKey, network)
-      const provider = fortmatic.getProvider()
+      const instance = new Fortmatic(
+        apiKey,
+        networkId === 1 ? undefined : networkName(networkId)
+      )
+      const provider = instance.getProvider()
 
       return {
         provider,
+        instance,
         interface: {
           name: "Fortmatic",
-          connect: fortmatic.user.login,
+          connect: instance.user.login,
           address: {
             get: () => Promise.resolve(provider.account)
           },
           network: {
-            get: () => Promise.resolve(networkToId(network))
+            get: () => Promise.resolve(networkId)
           },
           balance: {
             get: () =>
               provider.account &&
-              fortmatic.user.getBalances().then(res =>
+              instance.user.getBalances().then(res =>
                 res[0]
                   ? BigNumber(res[0].crypto_amount)
                       .times(BigNumber("1000000000000000000"))