Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.27 KB

README.md

File metadata and controls

71 lines (49 loc) · 2.27 KB
Raw

Aptos Testnet

This is an Aptos testnet Kurtosis package. It creates a local testnet with an arbitrary number of validators, validator full nodes and public full nodes.
For more background on the different types of networks reference Aptos' docs.

Run this package

If you have Kurtosis installed, run:

kurtosis run github.com/kurtosis-tech/aptos-package/testnet-topology --enclave aptos

To blow away the created enclave, run kurtosis clean -a.

Configuration

Click to see configuration

You can configure this package using a JSON structure as an argument to the kurtosis run function. The full structure that this package accepts are as follows, with default values shown (note that the // lines are not valid JSON and should be removed!):

{
    "num_validators": 2
}

These arguments can either be provided manually:

kurtosis run github.com/kurtosis-tech/aptos-package/testnet-topology --enclave aptos '{"num_validators":2}'

or by loading via a file, for instance using the args.json file in this repo:

kurtosis run github.com/kurtosis-tech/aptos-package/testnet-topology --enclave aptos "$(cat args.json)"

Use this package in your package

Kurtosis packages can be composed inside other Kurtosis packages. To use this package in your package:

First, import this package by adding the following to the top of your Starlark file:

this_package = import_module("github.com/kurtosis-tech/aptos-package/testnet-topology/main.star")

Then, call the this package's run function somewhere in your Starlark script:

this_package_output = this_package.run(plan, args)

Develop on this package

  1. Install Kurtosis
  2. Clone this repo
  3. For your dev loop, run kurtosis clean -a && kurtosis run . inside the repo directory