Skip to content

Commit

Permalink
fix: upgrade web3modal to v3
Browse files Browse the repository at this point in the history
  • Loading branch information
JackHamer09 committed Oct 4, 2023
1 parent 8429a51 commit f8fcd74
Show file tree
Hide file tree
Showing 15 changed files with 291 additions and 337 deletions.
4 changes: 3 additions & 1 deletion data/wallets.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
type WalletEntry = { walletName: string; type: "injected" | "walletConnect" };
type WalletEntry = { walletName: string; type: "injected" | "metaMask" | "walletConnect" };

export const confirmedSupportedWallets: WalletEntry[] = [
{ walletName: "MetaMask", type: "metaMask" },

{ walletName: "MetaMask", type: "injected" },
{ walletName: "BitKeep", type: "injected" },
{ walletName: "BlockWallet", type: "injected" },
Expand Down
381 changes: 220 additions & 161 deletions package-lock.json

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,8 @@
"@vitejs/plugin-vue": "^3.2.0",
"@vueuse/core": "^10.2.0",
"@vueuse/router": "^10.1.2",
"@wagmi/core": "^1.3.3",
"@web3modal/ethereum": "^2.6.2",
"@web3modal/html": "^2.6.2",
"@wagmi/core": "^1.4.3",
"@web3modal/wagmi": "^3.0.2",
"cheerio": "^1.0.0-rc.12",
"crypto-js": "^4.1.1",
"dotenv": "^16.0.3",
Expand All @@ -96,7 +95,7 @@
"sass": "^1.57.1",
"semantic-release": "^21.1.1",
"slugify": "^1.6.6",
"viem": "^1.2.6",
"viem": "^1.15.1",
"vite": "^3.0.0",
"vitest": "^0.15.2",
"vue-tippy": "^6.0.0",
Expand Down
7 changes: 0 additions & 7 deletions pages/transaction/zksync/era/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,6 @@
target="_blank"
href="https://www.layerswap.io/?sourceExchangeName=ZKSYNCERA_MAINNET"
/>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?source=zkSync%20Era"
/>
<DestinationItem
v-bind="destinations.rhino"
:icon="ArrowUpRightIcon"
Expand Down
7 changes: 0 additions & 7 deletions pages/transaction/zksync/era/receive.vue
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,6 @@
target="_blank"
href="https://www.layerswap.io/?destNetwork=ZKSYNCERA_MAINNET"
/>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?dest=zkSync%20Era"
/>
<DestinationItem
v-bind="destinations.rhino"
:icon="ArrowUpRightIcon"
Expand Down
7 changes: 0 additions & 7 deletions pages/transaction/zksync/era/send-lite.vue
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,6 @@
target="_blank"
href="https://www.layerswap.io/?sourceExchangeName=ZKSYNCERA_MAINNET&destNetwork=ZKSYNC_MAINNET"
/>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?source=zkSync%20Era&dest=zkSync%20Lite"
/>
</CommonCardWithLineButtons>
</div>
</template>
Expand Down
29 changes: 0 additions & 29 deletions pages/transaction/zksync/lite/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@
:to="{ name: 'transaction-zksync-lite-withdraw', query: $route.query }"
:description="`Withdraw to ${destinations.ethereum.label}`"
/>
<DestinationItem
v-bind="destinations.era"
as="RouterLink"
:to="{ name: 'transaction-zksync-lite-send-era', query: $route.query }"
description="Send to zkSync Era∎ network"
/>
</CommonCardWithLineButtons>

<template v-if="zkSyncLiteNetwork.l1Network">
Expand All @@ -43,35 +37,12 @@
/>
</CommonCardWithLineButtons>
</template>

<TypographyCategoryLabel>Send to another network</TypographyCategoryLabel>
<CommonCardWithLineButtons>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?source=zkSync%20Lite"
/>
</CommonCardWithLineButtons>

<TypographyCategoryLabel>Sell tokens for cash</TypographyCategoryLabel>
<CommonCardWithLineButtons>
<DestinationItem
v-bind="destinations.banxa"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://zksync.banxa.com/"
/>
</CommonCardWithLineButtons>
</div>
</template>

<script lang="ts" setup>
import { ref } from "vue";
import { ArrowUpRightIcon } from "@heroicons/vue/24/outline";
import { storeToRefs } from "pinia";
import { useDestinationsStore } from "@/store/destinations";
Expand Down
29 changes: 0 additions & 29 deletions pages/transaction/zksync/lite/receive.vue
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,6 @@

<TypographyCategoryLabel>Top-up with cash</TypographyCategoryLabel>
<CommonCardWithLineButtons>
<DestinationItem
v-bind="destinations.banxa"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
:href="
buildUrl('https://zksync.banxa.com', {
walletAddress: account.address!,
accountReference: account.address!,
returnUrlOnSuccess: 'https://portal.zksync.io',
returnUrlOnFailure: 'https://portal.zksync.io',
})
"
/>
<DestinationItem
v-bind="destinations.moonpay"
:icon="ArrowUpRightIcon"
Expand All @@ -65,13 +51,6 @@
target="_blank"
href="https://www.layerswap.io/?destNetwork=ZKSYNC_MAINNET"
/>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?dest=zkSync%20Lite"
/>
</CommonCardWithLineButtons>
</div>
</template>
Expand All @@ -81,18 +60,10 @@ import { ArrowUpRightIcon, QrCodeIcon } from "@heroicons/vue/24/outline";
import { storeToRefs } from "pinia";
import { useDestinationsStore } from "@/store/destinations";
import { useOnboardStore } from "@/store/onboard";
import { useLiteProviderStore } from "@/store/zksync/lite/provider";
const { account } = storeToRefs(useOnboardStore());
const { destinations } = storeToRefs(useDestinationsStore());
const { zkSyncLiteNetwork } = storeToRefs(useLiteProviderStore());
function buildUrl(base: string, params: Record<string, string>) {
let url = new URL("/", base);
Object.keys(params).forEach((key) => url.searchParams.append(key, params[key]));
return url;
}
</script>

<style lang="scss" scoped></style>
19 changes: 2 additions & 17 deletions pages/transaction/zksync/lite/send-era.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,10 @@
<BackButton :fallback="{ name: 'transaction-zksync-lite' }" />
<h1 class="h1">Choose provider</h1>

<CommonCardWithLineButtons>
<DestinationItem
v-bind="destinations.orbiter"
:icon="ArrowUpRightIcon"
as="a"
target="_blank"
href="https://www.orbiter.finance/?source=zkSync%20Lite&dest=zkSync%20Era"
/>
</CommonCardWithLineButtons>
<CommonCardWithLineButtons></CommonCardWithLineButtons>
</div>
</template>

<script lang="ts" setup>
import { ArrowUpRightIcon } from "@heroicons/vue/24/outline";
import { storeToRefs } from "pinia";
import { useDestinationsStore } from "@/store/destinations";
const { destinations } = storeToRefs(useDestinationsStore());
</script>
<script lang="ts" setup></script>

<style lang="scss" scoped></style>
10 changes: 0 additions & 10 deletions store/destinations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,6 @@ export const useDestinationsStore = defineStore("destinations", () => {
label: "Layerswap",
iconUrl: "/img/layerswap.svg",
},
orbiter: {
key: "orbiter",
label: "Orbiter",
iconUrl: "/img/orbiter.svg",
},
banxa: {
key: "banxa",
label: "Banxa",
iconUrl: "/img/banxa.svg",
},
ramp: {
key: "ramp",
label: "Ramp",
Expand Down
111 changes: 63 additions & 48 deletions store/onboard.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
import { configureChains, createConfig, getPublicClient, getWalletClient } from "@wagmi/core";
import {
configureChains,
createConfig,
getAccount,
getNetwork,
getPublicClient,
getWalletClient,
InjectedConnector,
switchNetwork as switchWalletNetwork,
disconnect as walletDisconnect,
watchAccount,
watchNetwork,
} from "@wagmi/core";
import { zkSync, zkSyncTestnet } from "@wagmi/core/chains";
import { WalletConnectConnector } from "@wagmi/core/connectors/walletConnect";
import { publicProvider } from "@wagmi/core/providers/public";
import { EthereumClient, w3mConnectors } from "@web3modal/ethereum";
import { Web3Modal } from "@web3modal/html";
import { createWeb3Modal } from "@web3modal/wagmi";
import { defineStore, storeToRefs } from "pinia";

import useColorMode from "@/composables/useColorMode";
Expand Down Expand Up @@ -63,67 +75,72 @@ export const useOnboardStore = defineStore("onboard", () => {
const { selectedNetwork, l1Network } = storeToRefs(useNetworkStore());

const { publicClient } = configureChains(extendedChains, [publicProvider()]);
const wagmiClient = createConfig({
const metadata = {
name: "zkSync Portal",
description:
"zkSync Portal provides all the required tools for working with Era and Lite networks such as Wallet, Bridge & Faucet functionality.",
url: "https://portal.zksync.io",
icons: ["https://portal.zksync.io/icon.png"],
};
const wagmiConfig = createConfig({
autoConnect: true,
connectors: w3mConnectors({
projectId: env.walletConnectProjectID,
chains: extendedChains,
}),
connectors: [
new WalletConnectConnector({
chains: extendedChains,
options: { projectId: env.walletConnectProjectID, showQrModal: false, metadata },
}),
new InjectedConnector({ chains: extendedChains, options: { shimDisconnect: true } }),
],
publicClient,
});
const ethereumClient = new EthereumClient(wagmiClient, extendedChains);

const account = ref(ethereumClient.getAccount());
const network = ref(ethereumClient.getNetwork());
const account = ref(getAccount());
const network = ref(getNetwork());
const connectingWalletError = ref<string | undefined>();
const connectorName = ref(wagmiClient.connector?.name);
const connectorName = ref(wagmiConfig.connector?.name);
const walletName = ref<string | undefined>();
const walletNotSupported = computed(() => {
if (!walletName.value || !wagmiClient.connector) return false;
if (!walletName.value || !wagmiConfig.connector) return false;
const isWalletNotSupported = !confirmedSupportedWallets.find(
(wallet) => wallet.walletName === walletName.value && wallet.type === wagmiClient.connector?.id
(wallet) => wallet.walletName === walletName.value && wallet.type === wagmiConfig.connector?.id
);
return isWalletNotSupported;
});
const identifyWalletName = async () => {
const provider = await wagmiClient.connector?.getProvider();
const provider = await wagmiConfig.connector?.getProvider();
const name = provider?.session?.peer?.metadata?.name;

if (!name && wagmiClient.connector?.name !== "WalletConnect") {
walletName.value = wagmiClient.connector?.name.replace(/ Wallet$/, "").trim();
if (!name && wagmiConfig.connector?.name !== "WalletConnect") {
walletName.value = wagmiConfig.connector?.name.replace(/ Wallet$/, "").trim();
} else {
walletName.value = name?.replace(/ Wallet$/, "").trim();
}

if (walletName.value && wagmiClient.connector) {
if (walletName.value && wagmiConfig.connector) {
const isWalletDisabled = !!disabledWallets.find(
(wallet) => wallet.walletName === walletName.value && wallet.type === wagmiClient.connector?.id
(wallet) => wallet.walletName === walletName.value && wallet.type === wagmiConfig.connector?.id
);
if (isWalletDisabled) throw new Error(`Unfortunately ${walletName.value} wallet is not supported at the moment!`);
}
};
identifyWalletName();
const web3modal = new Web3Modal(
{
projectId: env.walletConnectProjectID,
enableNetworkView: false,
enableAccountView: false,
themeMode: selectedColorMode.value,
explorerRecommendedWalletIds: [
"c57ca95b47569778a828d19178114f4db188b89b763c899ba0be274e97267d96",
"971e689d0a5be527bac79629b4ee9b925e82208e5168b733496a09c0faed0709",
"38f5d18bd8522c244bdd70cb4a68e0e718865155811c043f052fb9f1c51de662",
"1aa28414c95f5024133faf5766d376bb9c853c280d158cd3e22dc2b7b0a95a2d",
"7674bb4e353bf52886768a3ddc2a4562ce2f4191c80831291218ebd90f5f5e26",
],
explorerExcludedWalletIds: ["bc949c5d968ae81310268bf9193f9c9fb7bb4e1283e1284af8f2bd4992535fd6"],

termsOfServiceUrl: "https://zksync.io/terms",
privacyPolicyUrl: "https://zksync.io/privacy",
},
ethereumClient
);
ethereumClient.watchAccount(async (updatedAccount) => {

const web3modal = createWeb3Modal({
wagmiConfig,
projectId: env.walletConnectProjectID,
chains: extendedChains,
excludeWalletIds: ["bc949c5d968ae81310268bf9193f9c9fb7bb4e1283e1284af8f2bd4992535fd6"],
featuredWalletIds: [
"971e689d0a5be527bac79629b4ee9b925e82208e5168b733496a09c0faed0709",
"38f5d18bd8522c244bdd70cb4a68e0e718865155811c043f052fb9f1c51de662",
"1aa28414c95f5024133faf5766d376bb9c853c280d158cd3e22dc2b7b0a95a2d",
],
termsConditionsUrl: "https://zksync.io/terms",
privacyPolicyUrl: "https://zksync.io/privacy",
themeMode: selectedColorMode.value,
});

watchAccount(async (updatedAccount) => {
// There is a bug in @wagmi/[email protected] or @web3modal/ethereum@^2.3.7
// On page update or after using `ethereumClient.disconnect` method
// the account state is replaced with "connecting" state
Expand All @@ -133,7 +150,7 @@ export const useOnboardStore = defineStore("onboard", () => {
try {
await identifyWalletName();
account.value = updatedAccount;
connectorName.value = wagmiClient.connector?.name;
connectorName.value = wagmiConfig.connector?.name;
} catch (err) {
disconnect();
const error = formatError(err as Error);
Expand All @@ -142,18 +159,16 @@ export const useOnboardStore = defineStore("onboard", () => {
}
}
});
ethereumClient.watchNetwork((updatedNetwork) => {
watchNetwork((updatedNetwork) => {
network.value = updatedNetwork;
});
watch(selectedColorMode, (colorMode) => {
web3modal.setTheme({
themeMode: colorMode,
});
web3modal.setThemeMode(colorMode);
});

const openModal = () => web3modal.openModal();
const openModal = () => web3modal.open();
const disconnect = () => {
ethereumClient.disconnect();
walletDisconnect();
};

const isCorrectNetworkSet = computed(() => {
Expand All @@ -162,7 +177,7 @@ export const useOnboardStore = defineStore("onboard", () => {
});
const switchNetworkById = async (chainId: number, networkName?: string) => {
try {
await ethereumClient.switchNetwork({ chainId });
await switchWalletNetwork({ chainId });
} catch (err) {
if (err instanceof Error && err.message.includes("does not support programmatic chain switching")) {
throw new Error(`Please switch network manually to "${networkName}" in your ${walletName.value} wallet`);
Expand Down
Loading

0 comments on commit f8fcd74

Please sign in to comment.