Skip to content

Commit

Permalink
docs: minor changes in concepts/snarkOS & add client node docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zklimaleo committed Oct 15, 2024
1 parent 6174d6d commit 1566ff9
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 5 deletions.
43 changes: 43 additions & 0 deletions documentation/concepts/network/network/client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: client
title: Client
sidebar_label: Client
---

A client in the Aleo network is a node that serves blockchain data and interacts with the network without participating in consensus or block production. Clients play a crucial role in the ecosystem by providing access to blockchain data and facilitating user interactions with the network.

Key features of an Aleo client:

1. Data Retrieval: Clients can fetch and serve blockchain data, including blocks, transactions, and state information, to users and applications.

2. Transaction Submission: Users can submit new transactions to the network through client nodes.

3. Network Interaction: Clients maintain connections with other nodes to stay updated with the latest blockchain state.

4. Lightweight Operation: Compared to validators and provers, clients have lower hardware requirements, making them more accessible to run.

5. API Access: Many clients expose REST APIs, allowing developers to build applications that interact with the Aleo network.

To run an Aleo client node:

1. Ensure your system meets the minimum requirements:
- OS: Ubuntu 22.04 (LTS), macOS Sonoma or later, Windows 11 or later
- CPU: 32-cores
- RAM: 32GB of memory
- Storage: 300GB of disk space (PCIe Gen 3 x4 NVME SSD or better)
- Network: 100Mbps of upload and download bandwidth

2. Install snarkOS following the instructions in the Build Guide.

3. Start the client node by running:
```
./run-client.sh
```

Or use the following command for more control:
```
snarkos start --client
```

By running a client node, you contribute to the decentralization and robustness of the Aleo network while gaining direct access to its data and functionality.

10 changes: 5 additions & 5 deletions documentation/concepts/network/zkcloud/snarkos.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: SnarkOS
sidebar_label: SnarkOS
---

>SnarkOS is a decentralized operating system for zero-knowledge applications. This code forms the backbone of Aleo network, which verifies transactions and stores the encrypted state of applications in a publicly-verifiable manner.
SnarkOS is a decentralized operating system for zero-knowledge applications. This code forms the backbone of Aleo network, which verifies transactions and stores the encrypted state of applications in a publicly-verifiable manner.

The network client has to take care of verifying the transactions computed off chain using snarkvm, allowing all snarkOS nodes to reach consensus and to store the private and non private state in Aleo's distributed ledger.

Expand All @@ -14,14 +14,14 @@ An Aleo node can be run in three modes.
<!-- ### [Client](../network/) -->

<!-- markdown-link-check-disable -->
### Client
### [Prover](../network/provers)
### [Validator](../network/validators)
- [Client](../network/client)
- [Prover](../network/provers)
- [Validator](../network/validators)

<!-- markdown-link-check-enable -->

## Who uses snarkOS ?
>Everyone involved in Aleo uses snarkOS both to submit transactions and to fetch their data.
Everyone involved in Aleo uses snarkOS both to submit transactions and to fetch their data.



Expand Down

0 comments on commit 1566ff9

Please sign in to comment.