0.2.7 Aug 16, 2022
0.2.6 Aug 13, 2022
0.2.2 Jul 22, 2022
0.1.7 Jul 9, 2022
0.1.0 May 26, 2022

#20 in #blockchain-network

Download history 44/week @ 2023-10-29 57/week @ 2023-11-05 28/week @ 2023-11-12 41/week @ 2023-11-19 58/week @ 2023-11-26 38/week @ 2023-12-03 15/week @ 2023-12-10 31/week @ 2023-12-17 66/week @ 2023-12-24 23/week @ 2023-12-31 31/week @ 2024-01-07 38/week @ 2024-01-14 48/week @ 2024-01-21 58/week @ 2024-01-28 33/week @ 2024-02-04 54/week @ 2024-02-11

197 downloads per month
Used in 71 crates (52 directly)

Apache-2.0

1MB
24K SLoC

Aptos Configuration

The configuration describes the operational details for a node (Validator or Full node) and provides the clients' information on how to connect to the blockchain and derive trust.

Validators perform the BFT protocol and host the source of truth for the blockchain.

Fullnodes offer replication services for the blockchain as the primary entry point for clients to submit read requests (i.e., queries about the state of the blockchain). In turn, Validators focus on optimizing transaction throughput.

Clients are any service interested in learning about the state of the blockchain or performing transactions.

For a more detailed summary of the differences between a Validator and a Fullnode, see this blog post.

Organization

Configuration is broken up into many utilities:

  • src/config hosts the core configuration file structure
  • src/generator.rs assists in building sets of configurations for a Validator or Fullnode set
  • src/keys.rs wraps keys within the configuration files for testing purposes
  • config-builder extends src/generator.rs with a command-line utility and also provides support for generating genesis

The separation of the config-builder into its own crate was dictated by the need for config-builder to be able to generate genesis. Genesis requires the VM as a dependency, which is not a dependency for loading or using the configuration from many of the services.

Building a Test Network (TestNet)

config-builder builds an entire configuration for a Validator or FullNode, including the genesis blob. It takes as one of its input parameters an index that specifies the specific node config to return. This can be used to create an Aptos TestNet by constructing compatible configurations for the full set of Validators. Similarly the tool can be used to add Fullnodes to an existing network. Finally, it enables generation of a mint/faucet client capable of performing mint transactions/creating accounts.

Generating a new TestNet

The only requirements for generating the configuration for a full TestNet are: (i) having IP addresses and ports for each Validator; (ii) a pre-agreed upon shared secret for the Validator network; and (iii) a fixed ordering for the Validators in the network. FullNode configs can either be newly generated added to existing configs.

The configuration for validator I, can be produced by:

config-builder validator \
    -a $PUBLIC_MULTIADDR_FOR_VALIDATOR_I \
    -b $PUBLIC_MULTIADDR_FOR_VALIDATOR_0 \
    -d /opt/aptos/data \
    -i $I \
    -l $ANY_MULTIADDR_FOR_VALIDATOR_I \
    -n $TOTAL_NUMBER_OF_VALIDATORS \
    -o /opt/aptos/etc \
    -s $SHARED_SECRET

As an example, this is the 2nd Validator (offset 1) in a 4 Validator TestNet:

config-builder validator \
    -a "/ip4/1.1.1.2/tcp/7000" \
    -b "/ip4/1.1.1.1/tcp/7000" \
    -d /opt/aptos/data \
    -i 1 \
    -l "/ip4/0.0.0.0/tcp/7000" \
    -n 4 \
    -o /opt/aptos/etc \
    -s 0123456789abcdef101112131415161718191a1b1c1d1e1f2021222324252627

To create a mint service's key:

config-builder faucet \
    -o /opt/aptos/etc \
    -s 0123456789abcdef101112131415161718191a1b1c1d1e1f2021222324252627

Instantiating a FullNode config is similar to instantiating a Validator config. Though there are three possible routes: (i) creating a new node config; (ii) extending an existing Fullnode with another network; and (iii) extending a Validator with a Fullnode network. The input is similar for all three cases with only the command (create vs. extend) differing between them. When extending a Validator, config-builder assumes that there are n + 1 Fullnodes and gives the n + 1 identity to the Validator. The n + 1 peer id is also used to define the upstream peer for state sychronization and mempool. Note: currently, the tool does not support the creation of trees of Fullnode networks.

config-builder full-node (create | extend) \
    -a $PUBLIC_MULTIADDR_FOR_FULL_NODE_I \
    -b $PUBLIC_MULTIADDR_FOR_FULL_NODE_0 \
    -d /opt/aptos/data \
    -l $ANY_MULTIADDR_FOR_FULL_NODE_I \
    -n $TOTAL_NUMBER_OF_VALIDATORS \
    -o /opt/aptos/etc \
    -s $VALIDATOR_SHARED_SECRET \
    [ -i $I -f $TOTAL_NUMBER_OF_FULL_NODES -c $FULL_NODE_SHARED_SECRET | -p ]

Here an example of extending the Validator configuration above with a FullNode configuration.

config-builder full-node extend \
    -a "/ip4/1.1.1.2/tcp/7100" \
    -b "/ip4/1.1.1.2/tcp/7100" \
    -d /opt/aptos/data \
    -l "/ip4/0.0.0.0/tcp/7100" \
    -n 4 \
    -o /opt/aptos/etc \
    -s 0123456789abcdef101112131415161718191a1b1c1d1e1f2021222324252627 \
    -i 0 \
    -f 4 \
    -c 28292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f4041424344454547

Here is an example of creating a new FullNode that will connect to the Validator/FullNode hybrid configured above.

config-builder full-node create \
    -a "/ip4/1.1.1.3/tcp/7100" \
    -b "/ip4/1.1.1.2/tcp/7100" \
    -d /opt/aptos/fn/data \
    -l "/ip4/0.0.0.0/tcp/7100" \
    -n 4 \
    -o /opt/aptos/fn/etc \
    -s 0123456789abcdef101112131415161718191a1b1c1d1e1f2021222324252627 \
    -i 1 \
    -f 4 \
    -c 28292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f4041424344454547

Similarly a public network could be added via:

config-builder full-node create \
    -a "/ip4/1.1.1.2/tcp/7100" \
    -b "/ip4/1.1.1.2/tcp/7100" \
    -d /opt/aptos/fn/data \
    -l "/ip4/0.0.0.0/tcp/7100" \
    -n 4 \
    -o /opt/aptos/etc \
    -s 0123456789abcdef101112131415161718191a1b1c1d1e1f2021222324252627 \
    -p

Internals

There are several configurations contained within the configuration.

Node Configuration

The node configuration contains several modules:

  • AdmissionControlConfig - Where a node hosts their admission control
  • BaseConfig - Specifies the Node's role and base directories
  • ConsensusConfig - The behaviors of Consensus including the SafetyRules trusted computing base
  • DebugInterface - A special gRPC service for identifying internals of the system
  • ExecutionConfig - The gRPC service endpoint and path to the genesis file that defines the Move standard library and the initial Validator set.
  • MempoolConfig - Parameters for configuring uncommitted transaction storage
  • MetricsConfig - Local storage for metrics
  • NetworkConfig - AptosNet configuration file that specifies peers with keys, seed addresses to connect to upstream peers, the local peers network keys, and other network configuration parameters
  • NodeConfig - Hosts all configuration files for a node
  • SafetyRulesConfig - Specifies the persistency strategy for Safety Rules
  • StateSyncConfig - Specifies parameters around state sycnhronization and the set of peers that provide the data
  • StorageConfig - Where the AptosDB is stored and its gRPC service endpoints

External Component Configurations

Outside of each node, external components can also be configured:

  • KeyManagerConfig - This contains configurations details for starting and operating the Key Manager: the component service responsible for rotating cryptographic keys for nodes.

Shared Configuration

  • LoggerConfig - Configures the logging service for each component
  • SecureBackendConfig - Configures the secure storage backend used by each component
  • TestConfig - Used during tests to hold account keys and temporary paths for the configurations that will automatically be cleaned up after the test.

Testing

Configuration tests serve several purposes:

  • Identifying when defaults have changed
  • Ensuring that parsing / storing works consistently
  • Verifying that default filename assumptions are maintained

Several of the defaults in the configurations, in particular paths and addresses, have dependencies outside the codebase. These tests serve as a reminder that there may be ramifications from breaking these tests, which may impact production deployments.

The test configs currently live in src/config/test_data.

TODO

  • Add the ability to turn off services that are optional (e.g., debug interface, AC gRPC)
  • Generating public networks is broken
  • Make SafetyRule use on disk by default and remove from config generator

Dependencies

~85MB
~1.5M SLoC