Merge pull request #66 from ten-protocol/anthony/3695_node_docs

anixon604 · web-flow · commit 640db403e29b · 2024-11-05T16:29:31.000Z
TEN Validator Cloud Deployment Guide
diff --git a/docs/assets/ten-validator-composition.png b/docs/assets/ten-validator-composition.png
diff --git a/docs/assets/ten-validator-flow.png b/docs/assets/ten-validator-flow.png
diff --git a/docs/testnet/for-validators/node-architecture.md b/docs/testnet/for-validators/node-architecture.md
@@ -0,0 +1,50 @@
+---
+sidebar_position: 3
+---
+# Node Architecture
+
+## SGX Enclave and Trusted Execution Environment (TEE)
+The TEN network leverages Intel Software Guard Extensions (SGX) enclaves to create a secure and trusted execution environment (TEE) for processing transactions and executing smart contracts. SGX enclaves are isolated regions of memory that are encrypted and protected from unauthorized access, ensuring that sensitive data remains confidential and secure. Every transaction and smart contract execution on the TEN network is processed within an SGX enclave, guaranteeing the integrity and confidentiality of the data involved. Additionally, SGX enclaves provide hardware-based attestation, enabling nodes to verify the authenticity of each other and establish trust within the network.
+
+## Node Composition
+
+![TEN Validator Composition](../../assets/ten-validator-composition.png)
+
+The TEN Validator is composed of the following components:
+
+## Host and Enclave Architecture
+
+  #### Process Separation
+  - Separate OS processes for Host and Enclave
+  - Communication via gRPC
+  - Enclave managed by independent supervisor
+
+  #### Security Considerations
+  - Minimized TCB (Trusted Computing Base)
+  - Reduced attestation frequency
+
+### Host Component Responsibilities
+- External request handling
+- L1/L2 network synchronization
+- Secret management and rollup publishing
+- Peer node communication
+- High-availability management
+
+### Enclave Components and Responsibilities
+- Transaction validation and execution
+- Smart contract computation
+- Cryptographic operations and key management
+- State management and confidential data processing
+- Attestation generation and verification
+- Secure random number generation
+- Batch processing and sequencing
+
+## Deployment Containerization
+
+There are four deployment containers on a TEN Validator node:
+- **Host**: The host component is responsible for external communications and network operations.
+- **HostDB/Postgres**: Postgres is used to store the validator's host state.
+- **Enclave**: The enclave component is responsible for sensitive computations and data processing (SGX).
+- **EnclaveDB/Edgeless**: Edgeless is used to store the validator's enclave state (SGX).
+
+Running a TEN validator will automatically deploy these containers.
diff --git a/docs/testnet/for-validators/overview.md b/docs/testnet/for-validators/overview.md
@@ -0,0 +1,33 @@
+---
+sidebar_position: 1
+---
+# Node Overview
+Running a node on the TEN network involves participating in the network’s transaction processing, batching, and roll-up mechanisms. As a node operator, you will play a critical role in maintaining the network’s security, scalability, and efficiency. Understanding the flow of transactions and the mechanics of batches and roll-ups is essential for effectively running a node and contributing to the network’s operation.
+
+
+## Transaction Flow (TX)
+![TEN Validator Flow](../../assets/ten-validator-flow.png)
+
+### 1. Transactions
+Transactions are the fundamental operations executed on the TEN network, representing actions such as transferring value, interacting with smart contracts, or executing other network functions. Each transaction serves as a discrete unit of activity, altering the state of the network based on its payload.
+
+### 2. Batches
+Batches consist of multiple transactions grouped together on the TEN network, functioning similarly to blocks on the Ethereum network. By aggregating transactions into batches, the network enhances throughput and lowers latency, optimizing resource usage and improving overall efficiency.
+
+### 3. Roll-ups
+Roll-ups are a layer 2 scaling mechanism employed by the TEN network to securely aggregate and process transactions off-chain, before submitting a compressed version of these transactions to the Ethereum mainnet (Layer 1) for finalization. This approach significantly boosts throughput and reduces latency while maintaining the security guarantees of the Ethereum network.
+
+## Gateway
+The TEN Gateway is a network managed service and load balancer that routes transactions to the appropriate TEN validator nodes. It is responsible for securely encrypting and decrypting transactions, ensuring that sensitive data remains confidential throughout the transaction process. Validators interact with the Gateway to receive transactions, process them, and submit them to the Sequencer for batching and roll-up.
+
+## Node Types
+There are two types of nodes in the TEN network: Sequencers and Validators. They use the same software but have different roles and responsibilities. As a node operator you will be running a Validator node, but it is important to understand the role of Sequencers in the network.
+
+### Sequencer
+The TEN Sequencer is a central node that is responsible for ordering transactions, generating new batches, and creating roll-ups on the TEN network. It is the only node that can create new batches and is responsible for broadcasting these to the network, as well as submitting them to the Ethereum mainnet via roll-up.
+
+
+### Validator
+A TEN Validator is decentralized node that participates in the TEN network by processing transactions, validating transactions and batches against Ethereum L1 roll-ups, and providing data availability. The participation of multiple validators ensures the network’s security and integrity.
+
+
diff --git a/docs/testnet/for-validators/rewards.md b/docs/testnet/for-validators/rewards.md
@@ -0,0 +1,73 @@
+---
+sidebar_position: 2
+---
+# Node Rewards
+
+As a node operator, your participation is essential in maintaining a secure, reliable, and high-performance network. In recognition of your contributions, TEN has implemented a comprehensive reward structure to incentivize active and consistent engagement in the network’s testnet phases.
+
+---
+
+## Program Overview
+
+TEN is an encrypted Layer 2 network built on Ethereum, designed by the team behind Corda. TEN offers a highly scalable and private environment for Web3 applications,including AI, tokenizing real-world assets (RWA), enabling decentralized financial solutions (DeFi) and on-chain games.
+
+### Objective
+
+TEN’s incentivized testnet rewards participants—including node operators, developers, and users—who actively contribute to testing and improving the network. Node operators play a vital role in decentralizing TEN and ensuring robust node operations, and they are rewarded for maintaining network health, stability, and performance.
+
+---
+
+## Node Operator Rewards Structure
+
+TEN has allocated **22,500,000 TEN** (representing 2.25% of the total token supply) to incentivize contributions across the community, including node operations.
+
+### Rewards Overview
+
+1. **Staking Requirements**: Node operators do not need an initial stake to participate in the testnet (however, a minimum of 50,000 TEN tokens will be required for staking on Mainnet).
+2. **ETH-Based Compensation**: Node operators receive rewards paid in **ETH** to help cover hosting costs and encourage active participation.
+3. **Delegated Staking Model**: Community members can delegate their TEN tokens to node operators, broadening community involvement and fostering a more decentralized ecosystem.
+
+### Performance-Based Rewards
+
+Performance-based rewards are structured to motivate the consistent and high-quality performance of nodes, as follows:
+
+- **Top 10% Performers**: The highest 10% of node operators, ranked by performance and uptime, will earn the top reward bracket. Top performers will receive a reward equivalent to the minimum mainnet staking requirement and will be offered priority access to participate in the mainnet launch.
+- **Remaining Participants**: Node operators outside the top 10% but in the top 20% will also receive a reward based on their contributions and performance.
+
+### Participation-Based Rewards
+
+Node operators who meet minimum participation requirements but do not rank in the top 20% will still receive a reward. These rewards aim to foster inclusivity and recognize the contributions of all node operators.
+
+---
+
+## Testnet Phases & Participation
+
+The incentivized testnet is split into three phases, each lasting approximately **6-8 weeks**, followed by a short intermission between phases. The phases are designed to test and validate different aspects of the network:
+
+1. **Phase 1**: Focus on onboarding developers and user quests aimed at network resilience.
+2. **Phase 2**: Dedicated to expanding node operations and enhancing network decentralization.
+3. **Phase 3**: Final phase with an emphasis on testing newly deployed dApps and security-focused initiatives.
+
+### Eligibility
+
+- **Application**: Node operators can apply via the [Validator Application Form](https://cform.coinlist.co/forms/56274a78-8291-4899-bee1-a68ecbc5b2b8).
+- **Selection**: Applications are prioritized based on node management experience and community commitment, with selected participants notified by email.
+
+  \* Jurisdictional Limitations will be applied.
+
+## Additional Information
+
+- **Updates and Notifications**: Important updates will be shared via the **TEN Discord testnet channel** and by email for selected participants.
+- **Documentation**: Technical documents and guides are available on TEN’s official documentation site, with more added throughout the testnet phases.
+
+### Reward Distribution
+
+All rewards will be distributed after the mainnet launch, following the tokenomics vesting schedule outlined in the official TEN whitepaper.
+
+---
+
+This Node Rewards program aims to build a community-driven network powered by participants' shared efforts and contributions. By rewarding commitment and performance, TEN is cultivating a stable, high-performance Layer 2 ecosystem that is decentralized, secure, and inclusive.
+
+---
+
+For further queries, please reach out via our **[Discord channel](https://discord.gg/tenprotocol)** or reach out on to **[@TENprotocol](https://twitter.com/tenprotocol)** on X.
diff --git a/docs/testnet/for-validators/running-a-node.md b/docs/testnet/for-validators/running-a-node.md
@@ -1,12 +1,93 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
-# Running a node
+# Running a TEN Validator Node on Azure
 
-Thank you for your interest in running a node on the Ten testnet.
+This guide provides detailed instructions to set up and manage a TEN Validator Node on Azure using Terraform and Ansible. Due to TEN’s use of SGX architecture and cloud-specific security assurances, all current deployments are limited to cloud infrastructure to mitigate risks associated with physical attacks. A proof-of-cloud assertion, provided by TEN, certifies the security and reliability of each validator node running in the cloud.
 
-Reasons for running a node on testnet:
-- The best performers will receive rewards as per the [FAQ](../faq.md)
-- The top performers in this group will be invited to run nodes on mainnet
+---
+
+## Overview
+
+The deployment process leverages **Terraform** for Azure infrastructure provisioning and **Ansible** for configuring the Validator Node. By following this guide, you’ll set up a secure, compliant environment that meets TEN’s standards for validator operations.
+
+- **Terraform**: Automates the creation of Azure resources for a TEN Validator Node.
+- **Ansible**: Configures and deploys node software on the provisioned infrastructure.
+
+---
+
+## Requirements
+
+Before starting, ensure the following dependencies are installed on your local machine:
+
+- [**Terraform**](https://www.terraform.io/downloads.html) (version >= 0.12)
+  - [Terraform Installation Guide](https://learn.hashicorp.com/tutorials/terraform/install-cli)
+- [**Ansible**](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
+  - [Ansible Installation guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
+  - **Required Ansible Collections**: Install with:
+    ```sh
+    ansible-galaxy collection install community.docker community.crypto
+    ```
+- [**Azure CLI**](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli): For authenticating and managing Azure resources.
+- [**Docker**](https://docs.docker.com/get-docker/): Required for node deployment.
+- [**Docker Compose**](https://docs.docker.com/compose/install/): Used for managing containerized services.
+- [**Git**](https://git-scm.com/downloads): For repository cloning and version control.
+
+---
+## Clone the TEN Validator Repository
+```
+git clone https://github.com/ten-protocol/ten-validator.git
+cd ten-validator
+```
+## Azure Setup Instructions (Terraform)
+
+### Step 1: Authenticate and Configure Azure
+
+1. **Log into Azure**:
+   ```sh
+   az login
+2. Set Your Azure Subscription: Specify the Azure subscription for deploying the resources:
+   ```sh
+   az account set --subscription <your-subscription-id>
+   ```
+
+### Step 2: Configure Terraform Variables (optional)
+```
+cp terraform.tfvars.example terraform.tfvars
+```
+
+### Step 3: Deploy the Terraform Script
+```
+terraform init
+terraform apply
+```
+
+### Step 4: Access the Validator Node (Optional)
+1. ```chmod +x get-key.sh ./get-key.sh```
+2. ```ssh -i <path-to-key> <username>@<public-ip>```
+
+## TEN Validator Setup Instructions (Ansible)
+1. Network Configuration: Node network settings are located in `ansible/files/network_vars.yml`. These settings are typically not changed and are specific to the L2 network. One will be provided by the TEN team for ITN (testnet) and another for mainnet.
+2. Run the Installation Script: Use Ansible to configure and deploy the TEN Validator Node:
+    ```
+    chmod +x install-ten.sh
+    ./install-ten.sh
+    ```
+    During deployment, you will be prompted to enter:
+
+   -  Host ID: Public key of the validator node wallet
+
+   -  Private Key: Private key of the validator node wallet
+
+   -  Host Public P2P Address: Public IP or DNS of the node
+
+   -  SSH Details: Username and key path (or password if applicable)
+
+   -  L1 WS URL: WebSocket URL for the Layer 1 node (e.g., Infura)
+
+   -  Postgres DB Host: Leave blank to provision a new database
+
+   Note: If Terraform provisioned the VM, default values are often applicable—just press Enter to accept.
 
-Applications to run a node on testnet will be open at a later stage in the campaign. Join the Ten [Discord](https://discord.gg/tenprotocol) to stay up to date.
+## Managing the Validator Node
+Coming soon! (monitoring, backups, tear down, etc.)
