Skip to content

Commit

Permalink
Update the validator client name to Tachyon
Browse files Browse the repository at this point in the history
  • Loading branch information
nibty committed Dec 18, 2024
1 parent 4d646ba commit cd23d6b
Show file tree
Hide file tree
Showing 37 changed files with 195 additions and 197 deletions.
128 changes: 64 additions & 64 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 17 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
<p align="center">
<a href="https://solana.com">
<img alt="Solana" src="https://i.imgur.com/0vfIMHo.png" width="250" />
</a>
</p>
# X1: Tachyon Validator Node

[![Solana crate](https://img.shields.io/crates/v/solana-core.svg)](https://crates.io/crates/solana-core)
[![Solana documentation](https://docs.rs/solana-core/badge.svg)](https://docs.rs/solana-core)
[![Build status](https://badge.buildkite.com/8cc350de251d61483db98bdfc895b9ea0ac8ffa4a32ee850ed.svg?branch=master)](https://buildkite.com/solana-labs/solana/builds?branch=master)
[![codecov](https://codecov.io/gh/solana-labs/solana/branch/master/graph/badge.svg)](https://codecov.io/gh/solana-labs/solana)
## Building

# Building

## **1. Install rustc, cargo and rustfmt.**
### **1. Install rustc, cargo and rustfmt.**

```bash
$ curl https://sh.rustup.rs -sSf | sh
Expand Down Expand Up @@ -44,37 +35,38 @@ On Fedora:
$ sudo dnf install openssl-devel systemd-devel pkg-config zlib-devel llvm clang cmake make protobuf-devel protobuf-compiler perl-core
```

## **2. Download the source code.**
### **2. Download the source code.**

```bash
<<<<<<< HEAD
$ git clone https://github.com/solana-labs/solana.git
$ cd solana
=======
$ git clone https://github.com/x1-labs/tachyon.git
$ cd tachyon
>>>>>>> 5bd2b74988 (Update the validator client name to Tachyon)
```

## **3. Build.**
### **3. Build.**

```bash
$ ./cargo build
```

# Testing
## Testing

**Run the test suite:**

```bash
$ ./cargo test
```

### Starting a local testnet

Start your own testnet locally, instructions are in the [online docs](https://docs.solanalabs.com/clusters/benchmark).

### Accessing the remote development cluster
#### Accessing the remote testnet cluster

* `devnet` - stable public cluster for development accessible via
devnet.solana.com. Runs 24/7. Learn more about the [public clusters](https://docs.solanalabs.com/clusters)
* `testnet` - stable public cluster for development accessible via
https://xolana.xen.network

# Benchmarking
## Benchmarking

First, install the nightly build of rustc. `cargo bench` requires the use of the
unstable features only available in the nightly build.
Expand All @@ -89,11 +81,11 @@ Run the benchmarks:
$ cargo +nightly bench
```

# Release Process
## Release Process

The release process for this project is described [here](RELEASE.md).

# Code coverage
## Code coverage

To generate code coverage statistics:

Expand Down
4 changes: 2 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Solana Release process
# Tachyon Release process

## Branches and Tags

Expand Down Expand Up @@ -143,7 +143,7 @@ appearing. To check for progress:
* The `solana-secondary` Buildkite pipeline handles creating the Linux and macOS release artifacts and updated crates. Look for a job under the tag name of the release: https://buildkite.com/solana-labs/solana-secondary.
* The Windows release artifacts are produced by GitHub Actions. Look for a job under the tag name of the release: https://github.com/solana-labs/solana/actions.
[Crates.io](https://crates.io/crates/solana) should have an updated Solana version. This can take 2-3 hours, and sometimes fails in the `solana-secondary` job.
[Crates.io tachyon-validator](https://crates.io/crates/tachyon-validator) should have an updated tachyon-validator version. This can take 2-3 hours, and sometimes fails in the `agave-secondary` job.
If this happens and the error is non-fatal, click "Retry" on the "publish crate" job
### Update software on testnet.solana.com
Expand Down
4 changes: 2 additions & 2 deletions ci/localnet-sanity.sh
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ killNodes() {
# Try to use the RPC exit API to cleanly exit the first two nodes
# (dynamic nodes, -x, are just killed)
echo "--- RPC exit"
$agave_validator --ledger "$SOLANA_CONFIG_DIR"/bootstrap-validator exit --force || true
$agave_validator --ledger "$SOLANA_CONFIG_DIR"/validator exit --force || true
$tachyon_validator --ledger "$SOLANA_CONFIG_DIR"/bootstrap-validator exit --force || true
$tachyon_validator --ledger "$SOLANA_CONFIG_DIR"/validator exit --force || true

# Give the nodes a splash of time to cleanly exit before killing them
sleep 2
Expand Down
2 changes: 1 addition & 1 deletion ci/run-sanity.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ while [[ $latest_slot -le $((snapshot_slot + 1)) ]]; do
latest_slot=$($solana_cli --url http://localhost:8899 slot --commitment processed)
done

$agave_validator --ledger config/ledger exit --force || true
$tachyon_validator --ledger config/ledger exit --force || true

wait $pid

Expand Down
14 changes: 7 additions & 7 deletions docs/src/clusters/available.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ export SOLANA_METRICS_CONFIG="host=https://metrics.solana.com:8086,db=devnet,u=s
solana config set --url https://api.devnet.solana.com
```

##### Example `agave-validator` command-line
##### Example `tachyon-validator` command-line

```bash
$ agave-validator \
$ tachyon-validator \
--identity validator-keypair.json \
--vote-account vote-account-keypair.json \
--known-validator dv1ZAGvdsz5hHLwWXsVnM94hWf1pjbKVau1QVkaMJ92 \
Expand Down Expand Up @@ -93,10 +93,10 @@ export SOLANA_METRICS_CONFIG="host=https://metrics.solana.com:8086,db=tds,u=test
solana config set --url https://api.testnet.solana.com
```

##### Example `agave-validator` command-line
##### Example `tachyon-validator` command-line

```bash
$ agave-validator \
$ tachyon-validator \
--identity validator-keypair.json \
--vote-account vote-account-keypair.json \
--known-validator 5D1fNXzvv5NjV1ysLjirC4WY92RNsVH18vjmcszZd8on \
Expand Down Expand Up @@ -145,10 +145,10 @@ export SOLANA_METRICS_CONFIG="host=https://metrics.solana.com:8086,db=mainnet-be
solana config set --url https://api.mainnet-beta.solana.com
```

##### Example `agave-validator` command-line
##### Example `tachyon-validator` command-line

```bash
$ agave-validator \
$ tachyon-validator \
--identity ~/validator-keypair.json \
--vote-account ~/vote-account-keypair.json \
--known-validator 7Np41oeYqPefeNQEHSv1UDhYrehxin3NStELsSKCT4K2 \
Expand All @@ -173,4 +173,4 @@ $ agave-validator \
:::info
The above four [`--known-validator`s](../operations/guides/validator-start.md#known-validators)
are operated by Solana Labs.
:::
:::
2 changes: 1 addition & 1 deletion docs/src/clusters/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ For example

Generally we are using `debug` for infrequent debug messages, `trace` for potentially frequent messages and `info` for performance-related logging.

You can also attach to a running process with GDB. The leader's process is named _agave-validator_:
You can also attach to a running process with GDB. The leader's process is named _tachyon-validator_:

```bash
sudo gdb
Expand Down
2 changes: 1 addition & 1 deletion docs/src/implemented-proposals/installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ $ agave-install deploy http://example.com/path/to/solana-release.tar.bz2 update-
$ agave-install init --pubkey 92DMonmBYXwEMHJ99c9ceRSpAmk9v6i3RdvDdXaVcrfj # <-- pubkey is obtained from whoever is deploying the updates
$ export PATH=~/.local/share/agave-install/bin:$PATH
$ solana-keygen ... # <-- runs the latest solana-keygen
$ agave-install run agave-validator ... # <-- runs a validator, restarting it as necessary when an update is applied
$ agave-install run tachyon-validator ... # <-- runs a validator, restarting it as necessary when an update is applied
```

## On-chain Update Manifest
Expand Down
Loading

0 comments on commit cd23d6b

Please sign in to comment.