A Decentralized Operating System for ZK Applications Table of Contents1. OverviewsnarkOS is a decentralized operating system for zero-knowledge applications.This code forms the backbone the Aleo[1] network,which verifies transactions and stores the encrypted state applications in a publicly-verifiable manner.2. Build Guide2.1 RequirementsThe following are minimum requirements to run an Aleo node: - CPU: 16-cores (32-cores preferred) - RAM: 16GB of memory (32GB preferred) - Storage: 128GB of disk space - Network: 10 Mbps of upload and download bandwidthPlease note to run an Aleo Prover that is competitive, the machine will require more than these requirements.2.2 InstallationBefore beginning, please ensure your machine has Rust v1.65+ installed. Instructions to install Rust can be found here.[2]Start by cloning this Github repository:git clone https://github.com/AleoHQ/snarkOS.git --depth 1Next, move into the snarkOS directory:cd snarkOS[For Ubuntu users] A helper script to install dependencies is available. From the snarkOS directory, run:./build_ubuntu.shLastly, install snarkOS:cargo install --path .3. Run an Aleo Node3a. Run an Aleo ClientStart by following the instructions in the Build Guide[3].Next, to start a client node, from the snarkOS directory, run:./run-client.sh3b. Run an Aleo ProverStart by following the instructions in the Build Guide[4].Next, generate an Aleo account address:snarkos account newThis will output a new Aleo account in the terminal.Please remember to save the account private key and view key. The following is an example output:``` Attention - Remember to store this account private key and view key.Private Key APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me And Use In The Next Step View Key AViewKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me Address aleo1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me```Next, to start a proving node, from the snarkOS directory, run:./run-prover.shWhen prompted, enter your Aleo private key:Enter the Aleo Prover account private key:APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx4. FAQs1. My node is unable to compile.Ensure your machine has Rust v1.65+ installed. Instructions to install Rust can be found here.[5]If large errors appear during compilation, try running cargo clean.Ensure snarkOS is started using ./run-client.sh or ./run-prover.sh.2. My node is unable to connect to peers on the network.Ensure ports 4133/tcp and 3033/tcp are open on your router and OS firewall.Ensure snarkOS is started using ./run-client.sh or ./run-prover.sh.3. I can't generate a new address ###Before running the command above (snarkos account new) try source ~/.bashrcAlso double-check the spelling of snarkos. Note the directory is /snarkOS, the command is snarkos5. Command Line InterfaceTo run a node with custom settings, refer to the full list of options and flags available in the snarkOS CLI.The full list of CLI flags and options can be viewed with snarkos --help:```snarkOS The Aleo Team Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein![6]USAGE: snarkos [OPTIONS] OPTIONS: -h, --help Print help information -v, --verbosity Specify the verbosity [options: 0, 1, 2, 3] [default: 2]SUBCOMMANDS: account Commands to manage Aleo accounts clean Cleans the snarkOS node storage help Print this message or the help of the given subcommand(s) start Starts the snarkOS node update Update snarkOS```The following are the options for the snarkos start command:```snarkos-start Starts the snarkOS nodeUSAGE: snarkos start [OPTIONS]OPTIONS: --beacon Specify this as a beacon, with the given account private key for this node --client Specify this as a client, with an optional account private key for this node --connect Specify the IP address and port of a peer to connect to [default: ] --dev Enables development mode, specify a unique ID for this node -h, --help Print help information --logfile Specify the path to the file where logs will be stored [default: /tmp/snarkos.log] --network Specify the network of this node [default: 3] --node Specify the IP address and port for the node server [default: 0.0.0.0:4133] --nodisplay If the flag is set, the node will not render the display --norest If the flag is set, the node will not initialize the REST server --prover Specify this as a prover, with the given account private key for this node --rest Specify the IP address and port for the REST server [default: 0.0.0.0:3033] --validator Specify this as a validator, with the given account private key for this node --verbosity Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2]```6. Development6.1 Quick StartIn one terminal, start the beacon by running:cargo run --release -- start --nodisplay --dev 0 --beacon ""In a second terminal, run:cargo run --release -- start --nodisplay --dev 1 --prover ""This procedure can be repeated to start more nodes.6.2 OperationsIt is important to initialize the nodes starting from 0 and incrementing by 1 for each new node.The following is a list of options to initialize a node (replace XX with a number starting from 0):cargo run --release -- start --nodisplay --dev XX --beacon ""cargo run --release -- start --nodisplay --dev XX --validator ""cargo run --release -- start --nodisplay --dev XX --prover ""cargo run --release -- start --nodisplay --dev XX --client ""cargo run --release -- start --nodisplay --dev XXWhen no node type is specified, the node will default to --client.Clean UpTo clean up the node storage, run:cargo run --release -- clean --dev XX7. LicenseWe welcome all contributions to snarkOS. Please refer to the license[7] for the terms of contributions. To restore the repository download the bundle wget https://archive.org/download/github.com-AleoHQ-snarkOS_-_2022-12-02_15-19-08/AleoHQ-snarkOS_-_2022-12-02_15-19-08.bundle and run: git clone AleoHQ-snarkOS_-_2022-12-02_15-19-08.bundle Source: https://github.com/AleoHQ/snarkOS[8]Uploader: AleoHQ[9]Upload date: 2022-12-02 References^ Aleo (aleo.org)^ install Rust can be found here. (www.rust-lang.org)^ Build Guide (archive.org)^ Build Guide (archive.org)^ install Rust can be found here. (www.rust-lang.org)^ Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein! (archive.org)^ license (archive.org)^ https://github.com/AleoHQ/snarkOS (github.com)^ AleoHQ (github.com) github.com-AleoHQ-snarkOS_-_2022-12-02_15-19-08
- Details
- Archive.org
- Kategorie: Archivierte Beiträge
A Decentralized Operating System for ZK Applications Table of Contents1. OverviewsnarkOS is a decentralized operating system for zero-knowledge applications.This code forms the backbone the Aleo[1] network,which verifies transactions and stores the encrypted state applications in a publicly-verifiable manner.2. Build Guide2.1 RequirementsThe following are minimum requirements to run an Aleo node: - CPU: 16-cores (32-cores preferred) - RAM: 16GB of memory (32GB preferred) - Storage: 128GB of disk space - Network: 10 Mbps of upload and download bandwidthPlease note to run an Aleo Prover that is competitive, the machine will require more than these requirements.2.2 InstallationBefore beginning, please ensure your machine has Rust v1.65+ installed. Instructions to install Rust can be found here.[2]Start by cloning this Github repository:git clone https://github.com/AleoHQ/snarkOS.git --depth 1Next, move into the snarkOS directory:cd snarkOS[For Ubuntu users] A helper script to install dependencies is available. From the snarkOS directory, run:./build_ubuntu.shLastly, install snarkOS:cargo install --path .3. Run an Aleo Node3a. Run an Aleo ClientStart by following the instructions in the Build Guide[3].Next, to start a client node, from the snarkOS directory, run:./run-client.sh3b. Run an Aleo ProverStart by following the instructions in the Build Guide[4].Next, generate an Aleo account address:snarkos account newThis will output a new Aleo account in the terminal.Please remember to save the account private key and view key. The following is an example output:``` Attention - Remember to store this account private key and view key.Private Key APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me And Use In The Next Step View Key AViewKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me Address aleo1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me```Next, to start a proving node, from the snarkOS directory, run:./run-prover.shWhen prompted, enter your Aleo private key:Enter the Aleo Prover account private key:APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx4. FAQs1. My node is unable to compile.Ensure your machine has Rust v1.65+ installed. Instructions to install Rust can be found here.[5]If large errors appear during compilation, try running cargo clean.Ensure snarkOS is started using ./run-client.sh or ./run-prover.sh.2. My node is unable to connect to peers on the network.Ensure ports 4133/tcp and 3033/tcp are open on your router and OS firewall.Ensure snarkOS is started using ./run-client.sh or ./run-prover.sh.3. I can't generate a new address ###Before running the command above (snarkos account new) try source ~/.bashrcAlso double-check the spelling of snarkos. Note the directory is /snarkOS, the command is snarkos5. Command Line InterfaceTo run a node with custom settings, refer to the full list of options and flags available in the snarkOS CLI.The full list of CLI flags and options can be viewed with snarkos --help:```snarkOS The Aleo Team Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein![6]USAGE: snarkos [OPTIONS] OPTIONS: -h, --help Print help information -v, --verbosity Specify the verbosity [options: 0, 1, 2, 3] [default: 2]SUBCOMMANDS: account Commands to manage Aleo accounts clean Cleans the snarkOS node storage help Print this message or the help of the given subcommand(s) start Starts the snarkOS node update Update snarkOS```The following are the options for the snarkos start command:```snarkos-start Starts the snarkOS nodeUSAGE: snarkos start [OPTIONS]OPTIONS: --beacon Specify this as a beacon, with the given account private key for this node --client Specify this as a client, with an optional account private key for this node --connect Specify the IP address and port of a peer to connect to [default: ] --dev Enables development mode, specify a unique ID for this node -h, --help Print help information --logfile Specify the path to the file where logs will be stored [default: /tmp/snarkos.log] --network Specify the network of this node [default: 3] --node Specify the IP address and port for the node server [default: 0.0.0.0:4133] --nodisplay If the flag is set, the node will not render the display --norest If the flag is set, the node will not initialize the REST server --prover Specify this as a prover, with the given account private key for this node --rest Specify the IP address and port for the REST server [default: 0.0.0.0:3033] --validator Specify this as a validator, with the given account private key for this node --verbosity Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2]```6. Development6.1 Quick StartIn one terminal, start the beacon by running:cargo run --release -- start --nodisplay --dev 0 --beacon ""In a second terminal, run:cargo run --release -- start --nodisplay --dev 1 --prover ""This procedure can be repeated to start more nodes.6.2 OperationsIt is important to initialize the nodes starting from 0 and incrementing by 1 for each new node.The following is a list of options to initialize a node (replace XX with a number starting from 0):cargo run --release -- start --nodisplay --dev XX --beacon ""cargo run --release -- start --nodisplay --dev XX --validator ""cargo run --release -- start --nodisplay --dev XX --prover ""cargo run --release -- start --nodisplay --dev XX --client ""cargo run --release -- start --nodisplay --dev XXWhen no node type is specified, the node will default to --client.Clean UpTo clean up the node storage, run:cargo run --release -- clean --dev XX7. LicenseWe welcome all contributions to snarkOS. Please refer to the license[7] for the terms of contributions. To restore the repository download the bundle wget https://archive.org/download/github.com-AleoHQ-snarkOS_-_2022-12-02_15-19-08/AleoHQ-snarkOS_-_2022-12-02_15-19-08.bundle and run: git clone AleoHQ-snarkOS_-_2022-12-02_15-19-08.bundle Source: https://github.com/AleoHQ/snarkOS[8]Uploader: AleoHQ[9]Upload date: 2022-12-02 References^ Aleo (aleo.org)^ install Rust can be found here. (www.rust-lang.org)^ Build Guide (archive.org)^ Build Guide (archive.org)^ install Rust can be found here. (www.rust-lang.org)^ Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein! (archive.org)^ license (archive.org)^ https://github.com/AleoHQ/snarkOS (github.com)^ AleoHQ (github.com) - Zugriffe: 103