Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update naming convention from zkSync to ZKsync #204

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
![zkSync Portal](public/preview.png)
![ZKsync Portal](public/preview.png)

# zkSync Portal 🚀
# ZKsync Portal 🚀

**zkSync Portal** is a state-of-the-art dapp, merging the power of bridge, tokens manager and transaction history into one user-friendly interface. Designed with a stress on effortless user experience, it simplifies token management, making it your premier interface for interacting with both zkSync versions - every interaction smooth and efficient.
**ZKsync Portal** is a state-of-the-art dapp, merging the power of bridge, tokens manager and transaction history into one user-friendly interface. Designed with a stress on effortless user experience, it simplifies token management, making it your premier interface for interacting with both ZKsync versions - every interaction smooth and efficient.

## ✨ Features

- 🖥️ Intuitive interface for managing, sending, and bridging zkSync Era.
- 🖥️ Intuitive interface for managing, sending, and bridging ZKsync Era.
- 📇 Ability to add contacts for quick and easy access.
- 🔧 Effortless setup and connection to local zkSync nodes or ZK Stack Hyperchains.
- 🔧 Effortless setup and connection to local ZKsync nodes or ZK Stack Hyperchains.

## 🎉 Try it out!

Expand All @@ -18,29 +18,29 @@

## 🌍 Connecting to local node

Harness the Portal's power to connect to your [local zkSync Era node](https://docs.zksync.io/zksync-node/quickstart).
Harness the Portal's power to connect to your [local ZKsync Era node](https://docs.zksync.io/zksync-node/quickstart).

**Prerequisites:** Node.js version 16+, npm version 7+

1. 📚 Follow the [documentation](https://docs.zksync.io/zksync-node/quickstart) for setting up either an **in-memory node** or **dockerized local setup**.
2. 🔄 Clone the Portal repository and set it up:
```bash
git clone https://github.com/matter-labs/dapp-portal.git
cd dapp-portal
npm install
```
```bash
git clone https://github.com/matter-labs/dapp-portal.git
cd dapp-portal
npm install
```
3. 🛠️ Modify the default network settings in `data/networks.ts` if your network ID, RPC URL, or other info differs. Customize displayed tokens there if needed.
- Alternatively, use the [configuration form](./hyperchains/README.md#configure-automatically-with-form) for guided config setup.
- Alternatively, use the [configuration form](./hyperchains/README.md#configure-automatically-with-form) for guided config setup.
4. 🔥 Launch the dev server:
- For in-memory node:
```bash
npm run dev:node:memory
```
- For dockerized setup:
```bash
npm run dev:node:docker
```
Navigate to the displayed Portal URL (typically http://localhost:3000).
- For in-memory node:
```bash
npm run dev:node:memory
```
- For dockerized setup:
`bash
npm run dev:node:docker
`
Navigate to the displayed Portal URL (typically http://localhost:3000).

---

Expand All @@ -55,18 +55,21 @@ To use Portal with your ZK Stack Hyperchain, see the guide [here](./hyperchains/
### Advanced configuration

#### L1 Balances:

By default, L1 balances are fetched via a public RPC. For faster loading speeds and reduced load on your L1 RPC provider, consider using [Ankr's RPC service](https://www.ankr.com/rpc/). Obtain an Ankr token and update the `.env` file:

```bash
ANKR_TOKEN=your_ankr_token_here
```

#### Wallet Connect Project Setup:

Before deploying your own version of the Portal, ensure you create your own Wallet Connect project on [walletconnect.com](https://walletconnect.com). After creating the project, update the project ID in the `.env` file:

```bash
WALLET_CONNECT_PROJECT_ID=your_project_id_here
```


### 🔧 Setup

Ensure you've installed the necessary dependencies:
Expand Down Expand Up @@ -103,4 +106,4 @@ Open arms for contributions! Enhance our code and send your pull request [here](

## 📜 License

Proudly under the [MIT License](https://github.com/matter-labs/dapp-portal/blob/main/LICENSE).
Proudly under the [MIT License](https://github.com/matter-labs/dapp-portal/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion components/EcosystemBlock.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
>
<XMarkIcon aria-hidden="true" class="h-6 w-6" />
</button>
<p class="text-left xs:text-center">Explore the wonders of zkSync ecosystem</p>
<p class="text-left xs:text-center">Explore the wonders of ZKsync ecosystem</p>
<AnimationsEcosystemLogotypes />
<CommonButton
variant="primary"
Expand Down
2 changes: 1 addition & 1 deletion components/header/HelpModal.vue
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</DestinationItem>
<DestinationItem
label="Official Documentation"
description="Developer resources and technical zkSync documentation"
description="Developer resources and technical ZKsync documentation"
as="a"
href="https://era.zksync.io"
target="_blank"
Expand Down
2 changes: 1 addition & 1 deletion components/header/MobileAccountNavigation.vue
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
<CommonCardWithLineButtons class="mt-block-padding-1/2">
<DestinationItem
label="Official Documentation"
description="Developer resources and technical zkSync documentation"
description="Developer resources and technical ZKsync documentation"
as="a"
href="https://era.zksync.io"
target="_blank"
Expand Down
74 changes: 30 additions & 44 deletions components/icons/zkSync.vue
Original file line number Diff line number Diff line change
@@ -1,47 +1,33 @@
<template>
<svg viewBox="0 0 160 32" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0_2308_2426)">
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="M55.5386 15.7054L39.7838 0.0057373V11.5034L24.1407 23.0153L39.7838 23.0261V31.405L55.5386 15.7054Z"
fill="currentColor"
/>
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="M-0.00213623 15.6997L15.7526 31.3993V19.9941L31.3958 8.38965L15.7526 8.37891V0L-0.00213623 15.6997Z"
fill="currentColor"
/>
<path
d="M79.0115 23.5456H66.9531V20.0828L73.8563 12.3879H67.131V8.98425H78.893V12.2695L71.7825 20.1124H79.0115V23.5456Z"
fill="currentColor"
/>
<path
d="M95.4678 8.98435L89.6313 15.1108L95.5864 23.5457H90.757L86.9056 17.9816L85.276 19.6981V23.5457H81.3356V2.11804H85.276V14.4005L90.3126 8.98435H95.4678Z"
fill="currentColor"
/>
<path
d="M112.606 7.56374L108.932 8.68839C108.794 7.93861 108.419 7.25791 107.807 6.64626C107.194 6.0346 106.296 5.72878 105.11 5.72878C104.143 5.72878 103.353 5.99514 102.74 6.52787C102.128 7.04087 101.822 7.66239 101.822 8.39243C101.822 9.67492 102.582 10.4641 104.103 10.7601L107.036 11.3225C108.893 11.6776 110.335 12.4174 111.362 13.5421C112.389 14.6668 112.902 15.9888 112.902 17.508C112.902 19.2444 112.211 20.7636 110.829 22.0658C109.466 23.3484 107.629 23.9896 105.318 23.9896C103.995 23.9896 102.8 23.7922 101.733 23.3977C100.666 23.003 99.8071 22.4802 99.1554 21.829C98.5035 21.1582 97.9901 20.4578 97.6147 19.7277C97.2593 18.978 97.0419 18.2085 96.963 17.4193L100.755 16.413C100.854 17.5376 101.289 18.4749 102.059 19.2246C102.849 19.9744 103.945 20.3493 105.348 20.3493C106.414 20.3493 107.244 20.1125 107.836 19.6389C108.448 19.1654 108.755 18.5438 108.755 17.7744C108.755 17.1628 108.528 16.6398 108.073 16.2058C107.639 15.752 107.016 15.4462 106.207 15.2884L103.274 14.6964C101.575 14.3413 100.232 13.6408 99.2443 12.595C98.2567 11.5493 97.7629 10.2471 97.7629 8.68839C97.7629 6.83369 98.4739 5.27496 99.8961 4.0122C101.338 2.74943 103.066 2.11804 105.081 2.11804C106.286 2.11804 107.362 2.28576 108.31 2.62119C109.258 2.9566 110.019 3.41042 110.592 3.9826C111.164 4.53507 111.609 5.10726 111.925 5.69918C112.241 6.2911 112.468 6.91262 112.606 7.56374Z"
fill="currentColor"
/>
<path
d="M119.541 29.2872H115.363L118.8 21.7105L112.608 8.98425H117.022L120.904 17.5079L124.489 8.98425H128.696L119.541 29.2872Z"
fill="currentColor"
/>
<path
d="M134.135 15.17V23.5457H130.194V8.98436H134.016V10.7897C134.431 10.0794 135.023 9.53681 135.793 9.16193C136.564 8.78705 137.373 8.59961 138.223 8.59961C139.941 8.59961 141.245 9.1422 142.133 10.2274C143.043 11.2929 143.496 12.674 143.496 14.3709V23.5457H139.556V15.0516C139.556 14.1834 139.329 13.4829 138.875 12.9502C138.44 12.4174 137.768 12.1512 136.86 12.1512C136.031 12.1512 135.369 12.4372 134.875 13.0094C134.381 13.5816 134.135 14.3018 134.135 15.17Z"
fill="currentColor"
/>
<path
d="M153.155 12.1808C152.108 12.1808 151.229 12.5457 150.517 13.2758C149.807 14.0058 149.451 15.0022 149.451 16.265C149.451 17.5277 149.807 18.534 150.517 19.2838C151.248 20.0138 152.137 20.3789 153.184 20.3789C154.112 20.3789 154.853 20.1421 155.407 19.6685C155.96 19.1753 156.335 18.5932 156.532 17.9224L159.999 19.0766C159.643 20.4184 158.873 21.5725 157.688 22.5394C156.503 23.5062 155.001 23.9896 153.184 23.9896C151.012 23.9896 149.184 23.2596 147.703 21.7994C146.241 20.3197 145.511 18.4749 145.511 16.265C145.511 14.0354 146.232 12.1906 147.673 10.7305C149.135 9.27044 150.932 8.54041 153.065 8.54041C154.923 8.54041 156.443 9.02381 157.628 9.99062C158.813 10.9377 159.573 12.092 159.909 13.4533L156.384 14.6372C155.909 12.9996 154.833 12.1808 153.155 12.1808Z"
fill="currentColor"
/>
</g>
<defs>
<clipPath id="clip0_2308_2426">
<rect width="160" height="32" fill="currentColor" />
</clipPath>
</defs>
<svg width="171" height="40" viewBox="0 0 171 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M0 20.0078L14.5656 5.44214V12.725H29.1313L14.5656 23.6492V34.5734L0 20.0078Z" fill="white"></path>
<path
d="M50.9797 20.0078L36.414 34.5734V27.2906H21.8484L36.414 16.3664V5.44214L50.9797 20.0078Z"
fill="white"
></path>
<path
d="M79.6396 32.7969V7.30591H85.8008V18.0848H86.1369L94.5634 7.30591H101.82L92.7835 18.6823L101.982 32.7969H94.6131L88.2653 22.7773L85.8008 25.889V32.7969H79.6396Z"
fill="white"
></path>
<path
d="M57.4476 32.7969V29.2869L69.8322 12.3095H57.4601V7.30591H77.6239V10.8159L65.2393 27.7933H77.6114V32.7969H57.4476Z"
fill="white"
></path>
<path
d="M163.211 33.1952C161.418 33.1952 159.875 32.772 158.58 31.9256C157.286 31.0792 156.29 29.9134 155.593 28.4281C154.896 26.9428 154.548 25.2458 154.548 23.3373C154.548 21.3956 154.904 19.6821 155.618 18.1968C156.34 16.7032 157.344 15.5373 158.63 14.6993C159.925 13.8529 161.435 13.4297 163.161 13.4297C164.505 13.4297 165.717 13.6786 166.795 14.1765C167.874 14.6744 168.758 15.3714 169.446 16.2676C170.135 17.1637 170.562 18.2093 170.728 19.4041H167.791C167.567 18.5329 167.069 17.7612 166.297 17.089C165.534 16.4086 164.505 16.0684 163.211 16.0684C162.065 16.0684 161.061 16.3671 160.198 16.9646C159.344 17.5537 158.676 18.3877 158.195 19.4664C157.722 20.5368 157.485 21.7939 157.485 23.2378C157.485 24.7148 157.717 26.001 158.182 27.0963C158.655 28.1916 159.319 29.0421 160.174 29.6479C161.037 30.2536 162.049 30.5565 163.211 30.5565C163.974 30.5565 164.667 30.4237 165.289 30.1582C165.912 29.8926 166.438 29.5109 166.87 29.0131C167.301 28.5152 167.608 27.9178 167.791 27.2207H170.728C170.562 28.3492 170.152 29.3657 169.496 30.2702C168.849 31.1664 167.99 31.88 166.92 32.411C165.858 32.9338 164.621 33.1952 163.211 33.1952Z"
fill="white"
></path>
<path
d="M139.631 21.2961V32.7969H136.693V13.6786H139.531V16.6659H139.78C140.228 15.695 140.909 14.915 141.821 14.3259C142.734 13.7284 143.912 13.4297 145.356 13.4297C146.651 13.4297 147.783 13.6952 148.754 14.2263C149.725 14.749 150.48 15.5456 151.02 16.6161C151.559 17.6782 151.829 19.0224 151.829 20.6488V32.7969H148.891V20.848C148.891 19.3461 148.501 18.1761 147.721 17.338C146.941 16.4916 145.871 16.0684 144.51 16.0684C143.572 16.0684 142.734 16.2717 141.996 16.6783C141.265 17.0849 140.689 17.6782 140.266 18.4582C139.842 19.2382 139.631 20.1841 139.631 21.2961Z"
fill="white"
></path>
<path
d="M120.827 39.9663C120.33 39.9663 119.886 39.9249 119.496 39.8419C119.106 39.7672 118.836 39.6925 118.687 39.6178L119.433 37.0289C120.147 37.2115 120.778 37.2778 121.325 37.228C121.873 37.1783 122.358 36.9335 122.782 36.4937C123.213 36.0622 123.607 35.361 123.964 34.3902L124.512 32.8966L117.442 13.6787H120.628L125.906 28.9136H126.105L131.382 13.6787H134.569L126.453 35.5851C126.088 36.5725 125.636 37.3899 125.097 38.0371C124.557 38.6926 123.931 39.178 123.217 39.4934C122.512 39.8087 121.715 39.9663 120.827 39.9663Z"
fill="white"
></path>
<path
d="M115.918 17.9603L113.279 18.7071C113.113 18.2673 112.868 17.84 112.545 17.4251C112.229 17.0019 111.798 16.6534 111.25 16.3796C110.703 16.1057 110.001 15.9688 109.147 15.9688C107.977 15.9688 107.002 16.2385 106.222 16.7779C105.45 17.3089 105.064 17.9852 105.064 18.8067C105.064 19.5369 105.33 20.1136 105.861 20.5368C106.392 20.96 107.222 21.3127 108.35 21.5948L111.188 22.2918C112.897 22.7067 114.171 23.3415 115.009 24.1962C115.847 25.0425 116.266 26.1337 116.266 27.4697C116.266 28.565 115.951 29.5441 115.32 30.4071C114.698 31.2701 113.827 31.9505 112.707 32.4484C111.586 32.9463 110.284 33.1952 108.798 33.1952C106.848 33.1952 105.234 32.772 103.956 31.9256C102.679 31.0792 101.87 29.8429 101.529 28.2165L104.317 27.5195C104.583 28.5484 105.085 29.3201 105.823 29.8346C106.57 30.349 107.545 30.6063 108.748 30.6063C110.118 30.6063 111.205 30.3158 112.009 29.735C112.823 29.1458 113.229 28.4405 113.229 27.619C113.229 26.9552 112.997 26.3992 112.532 25.9512C112.068 25.4948 111.354 25.1546 110.391 24.9305L107.205 24.1837C105.454 23.7688 104.168 23.1257 103.347 22.2545C102.533 21.3749 102.127 20.2754 102.127 18.9561C102.127 17.8773 102.43 16.9231 103.035 16.0933C103.649 15.2635 104.483 14.6121 105.537 14.1392C106.599 13.6662 107.802 13.4297 109.147 13.4297C111.039 13.4297 112.524 13.8446 113.603 14.6744C114.69 15.5042 115.461 16.5995 115.918 17.9603Z"
fill="white"
></path>
</svg>
</template>
2 changes: 1 addition & 1 deletion components/modal/LegalNotice.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<CommonModal v-model:opened="modalDisplayed" :initial-focus="checkbox" :closable="false">
<DialogTitle as="div" class="modal-title">zkSync Bridge is live on beta</DialogTitle>
<DialogTitle as="div" class="modal-title">ZKsync Bridge is live on beta</DialogTitle>
<p class="modal-text">
Nothing on this website should be construed as an invitation, inducement, or solicitation to engage in investment
activity. You understand that the bridge, asset, and transaction features available through this website are in
Expand Down
2 changes: 1 addition & 1 deletion components/modal/NetworkChangedWarning.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
>from <span class="font-medium">{{ lastSelectedNetwork.name }}</span>
</span>
to
<span class="font-medium">{{ selectedNetwork.name }}</span> since your last use of zkSync Portal.
<span class="font-medium">{{ selectedNetwork.name }}</span> since your last use of ZKsync Portal.
</p>
<TypographyCategoryLabel class="-mb-2.5">Optional settings</TypographyCategoryLabel>
<CommonCheckbox v-model="doNotSwitchNetwork">Do not switch network automatically</CommonCheckbox>
Expand Down
2 changes: 1 addition & 1 deletion components/token/TokenSelectModal.vue
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<template v-if="isConnected">
No tokens for "{{ search }}" were found on connected account
<br />
<span class="mt-1.5 inline-block">Make sure you are using correct zkSync network</span>
<span class="mt-1.5 inline-block">Make sure you are using correct ZKsync network</span>
</template>
<template v-else>Connect wallet to see all tokens available for you</template>
</p>
Expand Down
2 changes: 1 addition & 1 deletion components/transaction/CustomBridge.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:icon="ExclamationTriangleIcon"
class="mb-block-gap"
>
<p>Bridging {{ customBridgeToken.symbol }} is not supported by zkSync Portal.</p>
<p>Bridging {{ customBridgeToken.symbol }} is not supported by ZKsync Portal.</p>
</CommonAlert>
<TypographyCategoryLabel>
Use 3rd party bridges to get native {{ customBridgeToken.symbol }} on
Expand Down
2 changes: 1 addition & 1 deletion composables/zksync/useTransaction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default (getSigner: () => Promise<Signer | undefined>, getProvider: () =>

status.value = "processing";
const signer = await getSigner();
if (!signer) throw new Error("zkSync Signer is not available");
if (!signer) throw new Error("ZKsync Signer is not available");
const provider = getProvider();

const getRequiredBridgeAddress = async () => {
Expand Down
12 changes: 6 additions & 6 deletions data/meta.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
export const portal = {
title: "zkSync Portal | View balances, transfer and bridge tokens",
title: "ZKsync Portal | View balances, transfer and bridge tokens",
description:
"zkSync Portal allows you to view your balances, transfer tokens and bridge assets between zkSync and Ethereum",
"ZKsync Portal allows you to view your balances, transfer tokens and bridge assets between ZKsync and Ethereum",
previewImg: {
src: "https://portal.zksync.io/preview.png",
alt: "zkSync Portal",
alt: "ZKsync Portal",
},
};
export const bridge = {
title: "zkSync Bridge | Transfer funds between zkSync and Ethereum",
title: "ZKsync Bridge | Transfer funds between ZKsync and Ethereum",
description:
"With the zkSync Bridge you can easily deposit tokens to zkSync. Enjoy faster, cheaper and more efficient transactions with the future proof zkEVM scaling Ethereum's security and values.",
"With the ZKsync Bridge you can easily deposit tokens to ZKsync. Enjoy faster, cheaper and more efficient transactions with the future proof zkEVM scaling Ethereum's security and values.",
previewImg: {
src: "https://portal.zksync.io/preview.png",
alt: "zkSync Bridge",
alt: "ZKsync Bridge",
},
};
8 changes: 4 additions & 4 deletions data/networks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export type ZkSyncNetwork = {
getTokens?: () => Token[] | Promise<Token[]>; // If blockExplorerApi is specified, tokens will be fetched from there. Otherwise, this function will be used.
};

// See the official documentation on running a local zkSync node: https://era.zksync.io/docs/tools/testing/
// See the official documentation on running a local ZKsync node: https://era.zksync.io/docs/tools/testing/
// Also see the guide in the README.md file in the root of the repository.

// In-memory node default config. Docs: https://era.zksync.io/docs/tools/testing/era-test-node.html
Expand Down Expand Up @@ -86,7 +86,7 @@ const publicChains: ZkSyncNetwork[] = [
{
id: 324,
key: "mainnet",
name: "zkSync",
name: "ZKsync",
rpcUrl: "https://mainnet.era.zksync.io",
blockExplorerUrl: "https://era.zksync.network",
blockExplorerApi: "https://block-explorer-api.mainnet.zksync.io",
Expand All @@ -98,7 +98,7 @@ const publicChains: ZkSyncNetwork[] = [
{
id: 300,
key: "sepolia",
name: "zkSync Sepolia Testnet",
name: "ZKsync Sepolia Testnet",
rpcUrl: "https://sepolia.era.zksync.dev",
blockExplorerUrl: "https://sepolia-era.zksync.network",
blockExplorerApi: "https://block-explorer-api.sepolia.zksync.dev",
Expand All @@ -110,7 +110,7 @@ const publicChains: ZkSyncNetwork[] = [
{
id: 270,
key: "stage",
name: "zkSync Stage",
name: "ZKsync Stage",
rpcUrl: "https://z2-dev-api.zksync.dev",
blockExplorerUrl: "https://sepolia-beta.staging-scan-v2.zksync.dev",
blockExplorerApi: "https://block-explorer-api.stage.zksync.dev",
Expand Down
4 changes: 2 additions & 2 deletions data/wagmi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import { chainList, type ZkSyncNetwork } from "@/data/networks";
const portalRuntimeConfig = usePortalRuntimeConfig();

const metadata = {
name: "zkSync Portal",
description: "zkSync Portal - view balances, transfer and bridge tokens",
name: "ZKsync Portal",
description: "ZKsync Portal - view balances, transfer and bridge tokens",
url: "https://portal.zksync.io",
icons: ["https://portal.zksync.io/icon.png"],
};
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "zksync-dapp-portal",
"description": "zkSync Portal provides Wallet and Bridge functionality for interacting with zkSync",
"description": "ZKsync Portal provides Wallet and Bridge functionality for interacting with ZKsync",
"private": true,
"scripts": {
"dev": "nuxt dev",
Expand Down
Loading
Loading