Skip to content

Commit

Permalink
feat: update naming convention from zkSync to ZKSync
Browse files Browse the repository at this point in the history
  • Loading branch information
tx-nikola committed Dec 17, 2024
1 parent 11db697 commit bc71420
Show file tree
Hide file tree
Showing 35 changed files with 146 additions and 143 deletions.
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
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
4 changes: 2 additions & 2 deletions pages/assets.vue
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@

<template v-if="noBalances">
<TypographyCategoryLabel>
To start using zkSync ecosystem, deposit tokens in any convenient way
To start using ZKsync ecosystem, deposit tokens in any convenient way
</TypographyCategoryLabel>

<div class="flex flex-col gap-block-gap">
Expand All @@ -104,7 +104,7 @@
</div>
</template>
<template v-else>
<TypographyCategoryLabel>Deposit more tokens to zkSync</TypographyCategoryLabel>
<TypographyCategoryLabel>Deposit more tokens to ZKsync</TypographyCategoryLabel>

<CommonCardWithLineButtons>
<DestinationItem v-for="(item, index) in depositMethods" :key="index" v-bind="item.props">
Expand Down
4 changes: 2 additions & 2 deletions tests/e2e/features/actions/mainPage/actions-menu.feature
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Feature: Menu
Given I am on the Main page
When I click by "partial class" with "account-name" value
When I click by the "Logout" text element on the Menu
Then Element with "text" "Connect your Ethereum wallet to zkSync Portal" should be "visible"
Then Element with "text" "Connect your Ethereum wallet to ZKsync Portal" should be "visible"
Then Element with "testId" "network-switcher" should be "visible"
Then Element with "title" "zkSync Portal GitHub page" should be "visible"
Then Element with "title" "ZKsync Portal GitHub page" should be "visible"

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Feature: Faucet
Given A wallet should be "empty"
When I go to page "/?network=era-mainnet"
Then Element with "text" "Not enough tokens?" should be "invisible"
Then Element with "text" "Use official zkSync Era faucet" should be "invisible"
Then Element with "text" "Use official ZKsync Era faucet" should be "invisible"
Then Element with "text" " Get free test tokens " should be "invisible"

@id1635
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Feature: Artifacts - UI
Scenario: Check artifacts for an empty wallet
Then A wallet should be "empty"
Then Message " You don't have any balances on " should be visible
Then Message "zkSync Era Testnet" should be visible
Then Message "ZKsync Era Testnet" should be visible
Then Message " Proceed to " should be visible
Then Message "Add funds" should be visible
Then Message " page to add balance to your account " should be visible
Expand Down
20 changes: 10 additions & 10 deletions tests/e2e/features/artifacts/bridgePage/artifacts.feature
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Feature: Withdraw
Then Element with "testId" "close-button" should be "visible"
Then Element with "testId" "close-button" should be "clickable"
Then Modal card element with the "//*[contains(text(),'0x2CF4...75d')]" xpath should be "visible"
Then Modal card element with the "//div[text()='zkSync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//div[text()='ZKsync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//div[text()='Bridge network']" xpath should be "visible"
Then Element with "text" "View on Explorer" should be "visible"
Then Element with "text" "View on Explorer" should be "clickable"
Expand All @@ -29,8 +29,8 @@ Feature: Withdraw
When I click by partial text "..."
Then Element with "text" "Bridge network" should be "visible"
Then I click by text "Bridge network"
Then Modal card element with the "//*[text()='zkSync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//*[text()='zkSync Era Mainnet']" xpath should be "visible"
Then Modal card element with the "//*[text()='ZKsync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//*[text()='ZKsync Era Mainnet']" xpath should be "visible"


@id1604:I
Expand All @@ -44,7 +44,7 @@ Feature: Withdraw
Then Modal card element with the "//button[@data-testid='close-button']" xpath should be "visible"
Then Element with "text" "Selected network" should be "visible"
Then Element with "text" "Other networks" should be "visible"
Then Modal card element with the "//*[text()='zkSync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//*[text()='ZKsync Era Testnet']" xpath should be "visible"
Then Modal card element with the "//*[@src='/img/era.svg']" xpath should be "visible"
Then Modal card element with the "//*[text()='Ethereum Goerli Testnet']" xpath should be "visible"
Then Modal card element with the "//*[@src='/img/ethereum.svg']" xpath should be "visible"
Expand All @@ -60,7 +60,7 @@ Feature: Withdraw
Then Modal card element with the "//button[@data-testid='close-button']" xpath should be "visible"
Then Element with "text" "Selected network" should be "visible"
Then Element with "text" "Other networks" should be "visible"
Then Modal card element with the "//*[text()='zkSync Era Mainnet']" xpath should be "visible"
Then Modal card element with the "//*[text()='ZKsync Era Mainnet']" xpath should be "visible"
Then Modal card element with the "//*[@src='/img/era.svg']" xpath should be "visible"
Then Modal card element with the "//*[text()='Ethereum Mainnet']" xpath should be "visible"
Then Modal card element with the "//*[@src='/img/ethereum.svg']" xpath should be "visible"
Expand All @@ -74,7 +74,7 @@ Feature: Withdraw
#Recent withdrawals dropdown
Then Element with "partial class" "transition-transform" should be "visible"
Then Element with "text" "From" should be "visible"
Then Element with "text" "zkSync Era Testnet" should be "visible"
Then Element with "text" "ZKsync Era Testnet" should be "visible"
Then Element with "testId" "token-dropDown" should be "visible"
Then Element with "testId" "token-dropDown" should be "clickable"
Then Element with "id" "amount-input" should be "visible"
Expand Down Expand Up @@ -162,8 +162,8 @@ Feature: Withdraw
Then Element with "text" " Max " should be "visible"
Then Element with "text" " Max " should be "clickable"
#Block
Then Element with "text" "Your zkSync Era Testnet account" should be "visible"
Then Element with "text" "Your zkSync Era Testnet account" should be "clickable"
Then Element with "text" "Your ZKsync Era Testnet account" should be "visible"
Then Element with "text" "Your ZKsync Era Testnet account" should be "clickable"
Then Element with "text" "0x2CF4...75d" should be "visible"
Then Element with "text" "0x2CF4...75d" should be "clickable"
Then Element with "class" "address-avatar address-card-avatar" should be "visible"
Expand Down Expand Up @@ -199,9 +199,9 @@ Feature: Withdraw
Scenario: Check the editing recipient address in Bridge (Deposit)
Given I go to page "/bridge?network=era-goerli"
When I click by text "Deposit"
When I click by "text" with "Your zkSync Era Testnet account" value
When I click by "text" with "Your ZKsync Era Testnet account" value
Then Element with "text" "Bridge to" should be "visible"
When I fill the input field contains "placeholder" type "Address or ENS or contact name" value with "0x52B6d10d7d865B3d4103f8809AA3521288568f46" text
When I click by text "0x52B6...f46"
Then Element with "text" "zkSync Era Testnet address" should be "visible"
Then Element with "text" "ZKsync Era Testnet address" should be "visible"
Then Element with "text" "0x52B6...f46" should be "visible"
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Feature: Artifacts - UI
Then I click by "testId" with "token-dropDown" value
When I fill the input field contains "placeholder" type "Symbol or address" value with "AAA" text
Then Element with "partial string" 'No tokens was found for "AAA"' should be "visible"
Then Element with "partial text" "Make sure you are using correct zkSync network" should be "visible"
Then Element with "partial text" "Make sure you are using correct ZKsync network" should be "visible"

Examples:
| network |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ Feature: Artifacts - UI
Then Element with "text" "Copy" should be "visible"
Then Element with "text" "Copy" should be "clickable"
Then Element with "text" " Please transfer funds to this address using " should be "visible"
Then Element with "text" "zkSync Era Testnet" should be "visible"
Then Element with "text" "ZKsync Era Testnet" should be "visible"
Then Element with "text" " to successfully receive them " should be "visible"

@id1363 @loginPage
Scenario: Check artifacts on the Login page
Given I'm logged out
Then Element with "text" "Connect your Ethereum wallet to zkSync Portal" should be "visible"
Then Element with "text" "Connect your Ethereum wallet to ZKsync Portal" should be "visible"
Then Element with "testId" "network-switcher" should be "visible"
Then Element with "title" "zkSync Portal GitHub page" should be "visible"
Then Element with "title" "ZKsync Portal GitHub page" should be "visible"
Loading

0 comments on commit bc71420

Please sign in to comment.