Merge branch 'develop' into release/1.24.0

Author: taylorjdawson

package.json

@@ -56,7 +56,7 @@
     "@cvbb/eth-keyring": "^1.1.0",
     "@ledgerhq/hw-app-eth": "^5.21.0",
     "@ledgerhq/hw-transport-u2f": "^5.21.0",
-    "@portis/web3": "^2.0.0-beta.57",
+    "@portis/web3": "^4.0.0",
     "@toruslabs/torus-embed": "^1.9.2",
     "@walletconnect/web3-provider": "^1.4.1",
     "authereum": "^0.1.12",

src/components/Wallets.svelte

@@ -2,7 +2,7 @@
   import { onDestroy } from 'svelte'
   import Button from '../elements/Button.svelte'
   import IconButton from '../elements/IconButton.svelte'
-  import { app, wallet } from '../stores'
+  import { wallet } from '../stores'
   import {
     WalletSelectModalData,
     WalletModule,
@@ -13,6 +13,8 @@
   export let loadingWallet: string | undefined
   export let showingAllWalletModules: boolean = false
   export let showAllWallets: () => void
+  export let walletsDisabled: boolean = false
+
   let selectedWallet: WritableStore
 
   const unsubscribe = wallet.subscribe(wallet => (selectedWallet = wallet))
@@ -68,7 +70,7 @@
   {#each modalData.primaryWallets as wallet, i (wallet.name)}
     <li>
       <IconButton
-        disabled={!$app.termsAgreed}
+        disabled={walletsDisabled}
         onclick={() => handleWalletSelect(wallet)}
         iconSrc={wallet.iconSrc}
         iconSrcSet={wallet.iconSrcSet}
@@ -82,7 +84,7 @@
 
   {#if modalData.secondaryWallets && modalData.secondaryWallets.length && !showingAllWalletModules}
     <div>
-      <Button disabled={!$app.termsAgreed} onclick={showAllWallets}
+      <Button disabled={walletsDisabled} onclick={showAllWallets}
         >Show More</Button
       >
     </div>
@@ -92,7 +94,7 @@
     {#each modalData.secondaryWallets as wallet, i (wallet.name)}
       <li>
         <IconButton
-          disabled={!$app.termsAgreed}
+          disabled={walletsDisabled}
           onclick={() => handleWalletSelect(wallet)}
           iconSrc={wallet.iconSrc}
           iconSrcSet={wallet.iconSrcSet}

src/constants.ts

@@ -1,5 +1,5 @@
 import { StorageKeys } from './interfaces'
 
 export const STORAGE_KEYS: StorageKeys = {
-  TERMS_AGREED: 'onboard.js:termsAgreed'
+  TERMS_AGREEMENT: 'onboard.js:agreement'
 }

src/elements/Button.svelte

@@ -1,7 +1,7 @@
 <script lang="ts">
   import { app } from '../stores'
   export let onclick: () => void = () => {}
-  export let position: string
+  export let position: string = ''
   export let disabled: boolean = false
 </script>
 

src/interfaces.ts

@@ -23,17 +23,21 @@ export interface WalletSelectModuleOptions {
   description?: string
   wallets?: Array<WalletModule | WalletInitOptions>
   explanation?: string
-  termsOfServiceUrl?: string
-  privacyPolicyUrl?: string
+  agreement?: TermsOfServiceAgreementOptions
 }
 
 export interface WalletSelectModule {
   heading: string
   description: string
   wallets: Array<WalletModule | WalletInitOptions>
   explanation?: string
-  termsOfServiceUrl: string
-  privacyPolicyUrl: string
+  agreement?: TermsOfServiceAgreementOptions
+}
+
+export interface TermsOfServiceAgreementOptions {
+  version: string
+  termsUrl?: string
+  privacyUrl?: string
 }
 
 export interface WalletCheckModule {
@@ -484,13 +488,23 @@ export interface AppState {
   walletSelectDisplayedUI: boolean
   walletCheckDisplayedUI: boolean
   displayBranding: boolean
-  termsAgreed: boolean
+  agreement: TermsOfServiceAgreementOptions
 }
 
 export interface CancelablePromise extends Promise<any> {
   cancel: () => void
 }
 
 export interface StorageKeys {
-  TERMS_AGREED: string
+  TERMS_AGREEMENT: string
+}
+
+/**
+ * The object that will be stored in local storage to track
+ * user's agreement to the terms.
+ */
+export interface TermsAgreementState {
+  version: string
+  terms?: boolean
+  privacy?: boolean
 }

src/modules/check/network.ts

@@ -5,8 +5,6 @@ import {
   WalletCheckCustomOptions
 } from '../../interfaces'
 import { networkIcon } from './icons'
-import { app } from './../../stores'
-import { get } from 'svelte/store'
 
 function network(
   options: WalletCheckCustomOptions = {}

src/modules/index.ts

@@ -26,8 +26,7 @@ export default function initializeModules(
     heading = defaultHeading,
     description = defaultDescription,
     explanation = defaultWalletExplanation,
-    termsOfServiceUrl = '',
-    privacyPolicyUrl = ''
+    agreement = {}
   } = walletSelectOptions || {}
 
   return {
@@ -36,8 +35,7 @@ export default function initializeModules(
       description,
       wallets,
       explanation,
-      termsOfServiceUrl,
-      privacyPolicyUrl
+      agreement
     },
     walletCheck: check(walletCheck, networkId)
   }

src/modules/select/index.ts

@@ -7,11 +7,10 @@ import { isWalletInit } from '../../validation'
 
 // wallets that qualify for default wallets need to have no
 // init parameters that are required for full functionality
-const desktopDefaultWalletNames = ['metamask', 'authereum', 'torus', 'opera']
+const desktopDefaultWalletNames = ['metamask', 'torus', 'opera', 'liquality']
 
 const mobileDefaultWalletNames = [
   'metamask',
-  'authereum',
   'coinbase',
   'trust',
   'torus',
@@ -24,7 +23,8 @@ const mobileDefaultWalletNames = [
   'atoken',
   'liquality',
   'alphawallet',
-  'ownbit'
+  'ownbit',
+  'authereum'
 ]
 
 function select(

src/modules/select/wallets/cobovault.ts

@@ -70,7 +70,7 @@ async function cobovaultProvider(options: {
 
   const BASE_PATH = "m/44'/60'/0'/0"
 
-  const { networkId, appName, rpcUrl, BigNumber, networkName } = options
+  const { networkId, rpcUrl, BigNumber, networkName } = options
 
   const keyring = AirGapedKeyring.getEmptyKeyring()
 

src/modules/select/wallets/lattice.ts

@@ -156,7 +156,7 @@ async function latticeProvider(options: {
     return addressList
   }
 
-  function setPrimaryAccount(address: string) {
+  function setPrimaryAccount() {
     return
   }
 

src/onboard.ts

@@ -31,7 +31,6 @@ import {
 } from './interfaces'
 
 import initializeModules from './modules'
-import { STORAGE_KEYS } from './constants'
 
 let onboard: any
 
@@ -78,13 +77,6 @@ function init(initialization: Initialization): API {
       displayBranding = false
     }
   }
-  const { termsOfServiceUrl, privacyPolicyUrl } =
-    initialization.walletSelect || {}
-
-  const termsAgreed =
-    termsOfServiceUrl || privacyPolicyUrl
-      ? localStorage.getItem(STORAGE_KEYS.TERMS_AGREED) == 'true'
-      : true
 
   app.update((store: AppState) => ({
     ...store,
@@ -100,7 +92,7 @@ function init(initialization: Initialization): API {
     displayBranding,
     checkModules: initializedModules.walletCheck,
     blockPollingInterval,
-    termsAgreed
+    agreement: initialization.walletSelect?.agreement || null
   }))
 
   initializeStores()

src/stores.ts

@@ -35,7 +35,7 @@ export const app: WritableStore = writable({
   walletCheckDisplayedUI: false,
   displayBranding: false,
   blockPollingInterval: 4000,
-  termsAgreed: false
+  agreement: {}
 })
 
 export const stateSyncStatus: {

src/validation.ts

@@ -8,7 +8,8 @@ import {
   WalletInterface,
   WalletInitOptions,
   WalletCheckInit,
-  WalletSelectModuleOptions
+  WalletSelectModuleOptions,
+  TermsOfServiceAgreementOptions
 } from './interfaces'
 
 const validSubscriptionKeys = ['address', 'network', 'balance', 'wallet']
@@ -81,7 +82,8 @@ export function validateInit(init: Initialization): never | void {
       'darkMode',
       'apiUrl',
       'hideBranding',
-      'blockPollingInterval'
+      'blockPollingInterval',
+      'agreement'
     ],
     'init'
   )
@@ -202,21 +204,13 @@ function validateWalletSelect(
     description,
     explanation,
     wallets,
-    termsOfServiceUrl,
-    privacyPolicyUrl,
+    agreement,
     ...otherParams
   } = walletSelect
 
   invalidParams(
     otherParams,
-    [
-      'heading',
-      'description',
-      'explanation',
-      'termsOfServiceUrl',
-      'privacyPolicyUrl',
-      'wallets'
-    ],
+    ['heading', 'description', 'explanation', 'wallets', 'agreement'],
     'walletSelect'
   )
 
@@ -241,23 +235,44 @@ function validateWalletSelect(
     optional: true
   })
 
+  if (Array.isArray(wallets)) {
+    wallets.forEach(validateWallet)
+  }
+
   validateType({
-    name: 'termsOfServiceUrl',
-    value: termsOfServiceUrl,
-    type: 'string',
+    name: 'agreement',
+    value: agreement,
+    type: 'object',
     optional: true
   })
 
+  if (agreement) {
+    validateAgreement(agreement)
+  }
+}
+
+const validateAgreement = (agreement: TermsOfServiceAgreementOptions) => {
+  const { version, termsUrl, privacyUrl } = agreement
+  validateType({
+    name: 'version',
+    value: version,
+    type: 'string',
+    optional: false
+  })
+
   validateType({
-    name: 'privacyPolicyUrl',
-    value: privacyPolicyUrl,
+    name: 'termsUrl',
+    value: termsUrl,
     type: 'string',
     optional: true
   })
 
-  if (Array.isArray(wallets)) {
-    wallets.forEach(validateWallet)
-  }
+  validateType({
+    name: 'privacyUrl',
+    value: privacyUrl,
+    type: 'string',
+    optional: true
+  })
 }
 
 export function isWalletModule(obj: any): obj is WalletModule {

src/views/WalletCheck.svelte

@@ -347,7 +347,7 @@
         </Button>
       {/if}
       {#if errorMsg}
-        <Button position={!activeModal.button && 'left'} onclick={doAction}>
+        <Button position={!activeModal.button ? 'left' : ''} onclick={doAction}>
           Try Again
         </Button>
       {:else}