Skip to content

Commit

Permalink
[docs] clean up tutorials
Browse files Browse the repository at this point in the history
* Clean up text where appropriate
* Deelete old tutorials that are irrelevant
  • Loading branch information
davidiw committed Mar 8, 2022
1 parent 8ee2553 commit e3671d3
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 1,331 deletions.
1 change: 0 additions & 1 deletion developer-docs-site/docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,6 @@ then there is a guarantee that T_N will never be included in the blockchain.

- **Move** is a new programming language that implements all the transactions on the Aptos Blockchain.
- It has two different kinds of code — [transaction scripts](#transaction-script) and [Move modules](#move-module).
- For further information on Move, refer to the [Move technical paper](/technical-papers/move-paper)

## Move Bytecode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ We've described what happens in each stage below, along with links to the corres
| Description | Aptos Node Component Interactions |
| ------------------------------------------------------------ | ---------------------------------------- |
| 6. **Consensus → Mempool**: &mdash; As validator V<sub>1</sub> is a proposer/leader for this transaction, it will pull a block of transactions from its mempool and replicate this block as a proposal to other validator nodes via its consensus component. | [1. Consensus](#1-consensus-→-mempool), [3. Mempool](#3-consensus-→-mempool) |
| 7. **Consensus → Other Validators**: The consensus component of V<sub>1</sub> is responsible for coordinating agreement among all validators on the order of transactions in the proposed block. Refer to our technical paper [State Machine Replication in the Aptos Blockchain](/technical-papers/state-machine-replication-paper) for details of our proposed consensus protocol AptosBFT. | [2. Consensus](#2-consensus-→-other-validators) |
| 7. **Consensus → Other Validators**: The consensus component of V<sub>1</sub> is responsible for coordinating agreement among all validators on the order of transactions in the proposed block. | [2. Consensus](#2-consensus-→-other-validators) |

## Executing the block and reaching consensus

Expand Down
32 changes: 12 additions & 20 deletions developer-docs-site/docs/tutorials/configure-run-public-fullnode.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
title: "Configure and run a public FullNode"
slug: "configure-run-public-fullnode"
hidden: false
---
You can run [FullNodes](/basics/basics-fullnodes) to verify the state and synchronize to the Aptos Blockchain. FullNodes can be run by anyone. FullNodes replicate the full state of the blockchain by querying each other, or by querying the validators directly.

This tutorial details how to configure a public FullNode to connect to *testnet*, the Aptos Payment Network’s public test network..

>
> **Note:** Your public FullNode will be connected to testnet with a JSON-RPC endpoint accessible on your computer at localhost:8080.
>
#### Prerequisites
Before you get started with this tutorial, we recommend you familiarize yourself with the following:
* [Validator node concepts](/basics/basics-validator-nodes)
* [FullNode concepts](/basics/basics-fullnodes)
* [JSON-RPC specifications](https://github.com/aptos/aptos/blob/main/json-rpc/json-rpc-spec.md)
* [CLI reference](/tools/cli-reference)
* [REST specifications][rest_spec]


## Getting started
Expand All @@ -25,7 +22,7 @@ You can configure a public FullNode in two ways: using the Aptos Core source cod
### Using Aptos Core source code
1. Download and clone the Aptos Core repository from GitHub and prepare your developer environment by running the following commands:
```
git clone https://github.com/aptos/aptos.git
git clone https://github.com/aptos-labs/aptos-core.git
cd aptos
./scripts/dev_setup.sh
source ~/.cargo/env
Expand All @@ -37,25 +34,14 @@ You can configure a public FullNode in two ways: using the Aptos Core source cod
* Copy `config/src/config/test_data/public_full_node.yaml` to your current working directory.
* Download [genesis](https://testnet.aptos.com/genesis.blob) and [waypoint](https://testnet.aptos.com/waypoint.txt) files for testnet.
* Download [genesis][testnet_genesis] and [waypoint][testnet_waypoint] files for testnet.
* Update the public_full_node.yaml file in your current working directory by:
* Specifying the directory where you want testnet to store its database next to `base:data_dir`; for example, `./data`.
* Copying and pasting the contents of the waypoint file to the `waypoint` field.
* Adding the path where your Genesis file is located to `genesis_file_location`.
* Adding the following under `full_node_networks`.
```
seed_addrs:
D4C4FB4956D899E55289083F45AC5D84:
- "/dns4/fn.testnet.aptos.com/tcp/6182/ln-noise-ik/d29d01bed8ab6c30921b327823f7e92c63f8371456fb110256e8c0e8911f4938/ln-handshake/0"
```
* Disable on-chain discovery for the `discovery_method: "none"` (this is not required but it will limit log spew)
*
* Reading through the config and making any other desired changes. You can see what configurations the `public_full_node.yaml` file should have by checking the following file as an example: `docker/compose/public_full_node/public_full_node.yaml`
4. Run the aptos-node using `cargo run -p aptos-node --release -- -f ./public_full_node.yaml`
Expand All @@ -69,8 +55,8 @@ You can also use Docker to configure and run your PublicFullNode.
1. Install Docker and Docker-Compose.
2. Create a directory for your public FullNode composition.
3. Download the public FullNode [docker compose](https://github.com/aptos/aptos/tree/main/docker/compose/public_full_node/docker-compose.yaml) and [aptos](https://github.com/aptos/aptos/tree/main/docker/compose/public_full_node/public_full_node.yaml) configuration files into this directory.
4. Download [genesis](https://testnet.aptos.com/genesis.blob) and [waypoint](https://testnet.aptos.com/waypoint.txt) files for testnet into that directory.
3. Download the public FullNode [docker compose][pfn_docker_compose] and [aptos-core][pfn_config_file] configuration files into this directory.
4. Download [genesis][testnet_genesis] and [waypoint][testnet_waypoint] files for testnet into that directory.
5. Run docker-compose: `docker-compose up`.
### Understand and verify the correctness of your FullNode
Expand Down Expand Up @@ -101,4 +87,10 @@ During the initial synchronization of your FullNode, there may be a lot of data
docker exec -it $id /bin/bash
# Observe the volume (ledger) size:
du -cs -BM /opt/aptos/data
```
```
[pfn_config_file]: https://github.com/aptos-labs/aptos-core/tree/main/docker/compose/public_full_node/public_full_node.yaml
[pfn_docker_compose]: https://github.com/aptos-labs/aptos-core/tree/main/docker/compose/public_full_node/docker-compose.yaml
[rest_spec]: https://github.com/aptos-labs/aptos-core/tree/main/api
[testnet_genesis]: https://dev.fullnode.aptoslabs.com/genesis.blob
[testnet_waypoint]: https://dev.fullnode.aptoslabs.com/waypoint.txt
Loading

0 comments on commit e3671d3

Please sign in to comment.