A private blockchain solution with access control features that leverage the ZKsync Elastic Chain ecosystem's development tools and interoperability.
-*High-level architecture design for a “Double-Zero” implementation using a Validium +*High-level architecture design for a “Private Validium” implementation using a Validium Chain with access control features and scoped data access.* > [!NOTE] @@ -24,9 +24,9 @@ public blockchain integration. > **This trade-off creates a barrier** for organizations that need a **hybrid solution** combining the benefits of both > private and controlled systems in the public blockchain ecosystem. -## 💡 The Double Zero Framework +## 💡 The Private Validium Framework -**Double Zero** empowers organizations to operate within private blockchain environments while seamlessly connecting to +**Private Validium** empowers organizations to operate within private blockchain environments while seamlessly connecting to public networks. This is achieved through: - **Validium Chains**: Ensures confidentiality by keeping sensitive data off-chain while leveraging zero-knowledge @@ -62,7 +62,7 @@ tools and decentralized applications. ## ⚙️ Components -Double Zero consists of three main components. Below, we'll cover the rationale behind these choices and their +Private Validium consists of three main components. Below, we'll cover the rationale behind these choices and their implications: 1. [**Validium Chain**](#️-why-validium) @@ -71,7 +71,7 @@ implications: ## ⛓️ Why Validium? -Validium provides the ideal foundation for Double Zero by addressing key enterprise needs: security, scalability, and +Validium provides the ideal foundation for Private Validium by addressing key enterprise needs: security, scalability, and interoperability. Here's why it stands out: ### 1. **Privacy** @@ -124,26 +124,26 @@ The proxy layer enhances security, streamlines access control, and improves usab ### Key Benefits of the Proxy -1. **Enforcing Zero-Access Principles**: Acts as a gatekeeper, ensuring only authenticated and authorized users can interact with the Validium chain, in line with Double Zero's access control philosophy. +1. **Enforcing Zero-Access Principles**: Acts as a gatekeeper, ensuring only authenticated and authorized users can interact with the Validium chain, in line with Private Validium's access control philosophy. 2. **Enhanced Security**: Protects the Validium RPC interface by filtering and validating all incoming requests. This minimizes exposure to potential security risks, such as unauthorized access or malicious actions. 3. **Streamlined Authentication and Authorization**: Integrates robust mechanisms to verify user identities and permissions before granting access, ensuring strict adherence to organizational policies. ### YAML-Based Permission Configuration -Double Zero is a **flexible framework**, allowing permission management to be tailored to specific organizational needs. The example implementation below showcases one approach, but it can be easily modified to accommodate unique workflows or compliance requirements. +Private Validium is a **flexible framework**, allowing permission management to be tailored to specific organizational needs. The example implementation below showcases one approach, but it can be easily modified to accommodate unique workflows or compliance requirements. Permissions are defined in a `YAML file` to simplify configuration and enhance accessibility, especially for web2-oriented teams: - **Groups**: Logical collections of users or addresses sharing the same permissions. - **Permissions**: Specific contracts or methods that a group is allowed to access. -This flexibility ensures Double Zero can adapt to various industries and use cases, from financial institutions to decentralized platforms. +This flexibility ensures Private Validium can adapt to various industries and use cases, from financial institutions to decentralized platforms. You can explore an example configuration file in [example-permissions.yaml](./compose-proxy-permissions.yaml), demonstrating how groups and permissions can be structured in practice. ## 👀 Private Block Explorer -**Double Zero** Block Explorer is a customized version of +**Private Validium** Block Explorer is a customized version of the [ZKsync Era Block Explorer](https://github.com/matter-labs/block-explorer) that introduces a layer of privacy and access control. This tailored block explorer provides a secure, user-specific view of the blockchain. @@ -155,11 +155,11 @@ blockchain data according to their assigned permissions. ## 🎯 **Conclusion** -Double Zero uniquely combines ***privacy, scalability, and integration***: +Private Validium uniquely combines ***privacy, scalability, and integration***: 1. **Confidentiality**: Keeps sensitive data secure through advanced off-chain storage. 2. **Integration**: Bridges to public chains like Ethereum, providing access to liquidity, decentralized applications and tools. 3. **Efficiency**: High throughput and reduced costs for enterprise-grade applications. 4. **Ease of Adoption**: Intuitive deployment and familiar tools lower technical barriers. -By leveraging Validium technology, zero-knowledge proofs, and tailored access control, Double Zero enables organizations to harness blockchain innovation without compromising control or security. +By leveraging Validium technology, zero-knowledge proofs, and tailored access control, Private Validium enables organizations to harness blockchain innovation without compromising control or security. diff --git a/docs/block-explorer.md b/docs/block-explorer.md index 84483d1e63..8cd2d2cfac 100644 --- a/docs/block-explorer.md +++ b/docs/block-explorer.md @@ -1,11 +1,11 @@ -# Double Zero Block Explorer +# Private Validium Block Explorer -**A privacy-focused, access-controlled blockchain browser for the Double Zero implementation** +**A privacy-focused, access-controlled blockchain browser for the Private Validium implementation** ## 📌 Overview > [!NOTE] -> **Double Zero** Block Explorer is a customized version of +> **Private Validium** Block Explorer is a customized version of > the [ZKsync Era Block Explorer](https://github.com/matter-labs/block-explorer) that introduces a layer of privacy and > access control. By implementing user **authentication and permission-based data restrictions**, it ensures that users > can access blockchain data according to their assigned permissions. @@ -173,7 +173,7 @@ docker compose up It will run local Ethereum node, ZkSync Era, Postgres DB and all Block Explorer services. -Another option is to run only the double zero services hitting external endpoints +Another option is to run only the private validium services hitting external endpoints These can be done by upgrading the content `proxy.env` with the desired rpc and explorer urls. Then running: @@ -182,7 +182,7 @@ docker compose -f docker-compose-00.yaml --env-file=proxy.env up ``` This is going to spin only the services needed to make a functional -double zero setup against the specified environment. +private validium setup against the specified environment. ## ⛓️ Connection to your Hyperchain diff --git a/docs/step-by-step-guide.md b/docs/step-by-step-guide.md index a30c270d59..b14b8344b1 100644 --- a/docs/step-by-step-guide.md +++ b/docs/step-by-step-guide.md @@ -1,9 +1,9 @@ # Step-by-step full guide -Double Zero is a framework that provides privacy and access control for ZKsync-compatible chains. +Private Validium is a framework that provides privacy and access control for ZKsync-compatible chains. -This guide walks you through the complete process of setting up a local Double Zero environment, which includes a -private validium chain and a dapp built on the Double Zero framework. +This guide walks you through the complete process of setting up a local Private Validium environment, which includes a +private validium chain and a dapp built on the Private Validium framework. ## 1 - Deploy your validium chain @@ -59,7 +59,7 @@ Ensure to have to following ports free: - 8545 Now we need to create the ecosystem. This command is going to promp you with a wizzard to do the initial configuration -of the network. Double zero can work with any configuration, but the framework is meant to be used with a validium +of the network. Private Validium can work with any configuration, but the framework is meant to be used with a validium chain. Also, it’s good to avoid using the default chain id. For this example we are going to use `54678` . @@ -125,10 +125,10 @@ control: After this is done you are going to have funds ready to use in your local validium chain. -## 2. Double Zero +## 2. Private Validium -Double Zero adds authentication and authorization on top of the newly created validium chain. All the services are -written in nodejs and they are meant to be easy to run and configure. Let’s go step by step. +Private Validium adds authentication and authorization on top of the newly created validium chain. All the services are +written in nodejs and they are meant to be easy to run and configure. Let's go step by step. ### 2.1 - Clone the repo @@ -142,7 +142,7 @@ cd double-zero ### 2.2 Config -At this stage we need to link the private chain with double zero. We are going to run the double zero services inside a +At this stage we need to link the private chain with Private Validium. We are going to run the Private Validium services inside a docker a network. But they need to interact with our validium chain that is running in the host machine. The easiest way to make this work is by connecting the validium chain using your local ip. You can use this commands to get your local ip: @@ -184,7 +184,7 @@ APP_HOSTNAMES=localhost APP_ICON=/images/icons/zksync-arrows.svg # Here you need to set your chain id APP_L2_CHAIN_ID=54678 # <-- your chain id. -APP_L2_NETWORK_NAME=Double Zero Local +APP_L2_NETWORK_NAME=Private Validium Local APP_MAINTENANCE=false APP_NAME=local APP_PUBLISHED=true @@ -192,7 +192,7 @@ APP_RPC_URL=http://localhost:4041 APP_BASE_TOKEN_ADDRESS=0x000000000000000000000000000000000000800A ``` -Once the configuration is in place you can run the double zero services. +Once the configuration is in place you can run the Private Validium services. ### 2.3 - Launch @@ -200,7 +200,7 @@ Once the configuration is in place you can run the double zero services. ./environments/launch-hyperchain-env.sh ``` -This is going to run all the services of double zero using docker. At this stage you can check that the explorer is +This is going to run all the services of Private Validium using docker. At this stage you can check that the explorer is working going with your browser to [http://localhost:3010](http://localhost:3010)  @@ -255,9 +255,9 @@ After running this script: - The 3 addresses have received some tokens to test everything. - The deployer was registered as a VIP user and PREMIUM_USER_ADDRESS as a premium userr. -### 3.3 - Configure double zero permissions +### 3.3 - Configure Private Validium permissions -Let’s go back to the double zero repo. We have to edit this file: `envieronments/compose-hyperchain-permissions.yaml` +Let's go back to the Private Validium repo. We have to edit this file: `envieronments/compose-hyperchain-permissions.yaml` This files defined the access for permissions for each contract. This is what we are going to do @@ -281,7 +281,7 @@ contracts: # ... ``` -Now you can run all the double zero services again, this time we are going to leave them up: +Now you can run all the Private Validium services again, this time we are going to leave them up: ```bash ./environments/launch-hyperchain-env.sh @@ -324,4 +324,4 @@ Now, you can go to [localhost:3000](http://localhost:3000) to see your dapp runn  -You can connect your metamask wallet to the double zero rpc through the explorer. And then you can use the app. \ No newline at end of file +You can connect your metamask wallet to the Private Validium rpc through the explorer. And then you can use the app. \ No newline at end of file diff --git a/packages/app/index.html b/packages/app/index.html index 1231f249ea..af40432548 100644 --- a/packages/app/index.html +++ b/packages/app/index.html @@ -1,17 +1,17 @@ -