Skip to content

Commit

Permalink
Rename project to anchor
Browse files Browse the repository at this point in the history
  • Loading branch information
AgeManning committed Sep 25, 2024
1 parent 9c06203 commit 55bdcb5
Show file tree
Hide file tree
Showing 19 changed files with 101 additions and 101 deletions.
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributors Guide

SSV is an open-source Secret Shared Validator (SSV) client. We're community driven and
Anchor is an open-source Secret Shared Validator (SSV) client. We're community driven and
welcome all contribution. We aim to provide a constructive, respectful and fun
environment for collaboration.

Expand All @@ -9,7 +9,7 @@ free to just skim this document and get straight into crushing issues.

## Why Contribute

There are many reasons you might contribute to SSV. For example, you may
There are many reasons you might contribute to Anchor. For example, you may
wish to:

- contribute to the SSV ecosystem.
Expand All @@ -25,9 +25,9 @@ wish to:

Regardless of the reason, the process to begin contributing is very much the
same. We operate like a typical open-source project operating on GitHub: the
repository [Issues](https://github.com/sigp/ssv/issues) is where we
repository [Issues](https://github.com/sigp/anchor/issues) is where we
track what needs to be done and [Pull
Requests](https://github.com/sigp/ssv/pulls) is where code gets
Requests](https://github.com/sigp/anchor/pulls) is where code gets
reviewed. We use [discord](TODO) to chat
informally.

Expand All @@ -39,8 +39,8 @@ We recommend the following work-flow for contributors:
your skill-set. Use comments to communicate your intentions and ask
questions.
2. **Work in a feature branch** of your personal fork
(github.com/YOUR_NAME/ssv) of the main repository
(github.com/sigp/ssv).
(github.com/YOUR_NAME/anchor) of the main repository
(github.com/sigp/anchor).
3. Once you feel you have addressed the issue, **create a pull-request** with
`unstable` as the base branch to merge your changes into the main repository.
4. Wait for the repository maintainers to **review your changes** to ensure the
Expand All @@ -67,8 +67,8 @@ steps:
to your local machine.
2. [Add an _"upstream"_
branch](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository)
that tracks github.com/sigp/ssv using `$ git remote add upstream
https://github.com/sigp/ssv.git` (
that tracks github.com/sigp/anchor using `$ git remote add upstream
https://github.com/sigp/anchor.git` (
pro-tip: [use SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) instead of HTTPS).
3. Create a new feature branch with `$ git checkout -b your_feature_name`. The
name of your branch isn't critical but it should be short and instructive.
Expand All @@ -79,7 +79,7 @@ steps:
5. Commit your changes and push them to your fork with `$ git push origin
your_feature_name`.
6. Go to your fork on github.com and use the web interface to create a pull
request into the sigp/ssv repo.
request into the sigp/anchor repo.

From there, the repository maintainers will review the PR and either accept it
or provide some constructive feedback.
Expand All @@ -91,8 +91,8 @@ having trouble. As always, jump on [discord](https://discord.gg/cyAszAh)
if you get stuck.

Additionally,
the ["Contributing to SSV" section](https://ssv-book.sigmaprime.io/contributing.html#contributing-to-ssv)
of the SSV Book provides more details on the setup.
the ["Contributing to Anchor" section](https://anchor-book.sigmaprime.io/contributing.html#contributing-to-anchor)
of the Anchor Book provides more details on the setup.

## FAQs

Expand All @@ -111,10 +111,10 @@ We're open to developers of all levels. If you create a PR and your code
doesn't meet our standards, we'll help you fix it and we'll share the reasoning
with you. Contributing to open-source is a great way to learn.

### I'm not sure I know enough about SSV
### I'm not sure I know enough about Anchor

No problems, there's plenty of tasks that don't require extensive SSV
knowledge. You can learn about SSV as you go.
No problems, there's plenty of tasks that don't require extensive Anchor
knowledge. You can learn about Anchor as you go.

### I'm afraid of making a mistake and looking silly

Expand Down
38 changes: 19 additions & 19 deletions Cargo.lock

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

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "ssv"
name = "anchor"
version = "0.1.0"
edition = "2021"
authors = ["Sigma Prime <contact@sigmaprime.io>"]
Expand Down
16 changes: 8 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ build-aarch64:

# Create a `.tar.gz` containing a binary for a specific target.
define tarball_release_binary
cp $(1)/ssv $(BIN_DIR)/ssv
cp $(1)/anchor $(BIN_DIR)/anchor
cd $(BIN_DIR) && \
tar -czf ssv-$(GIT_TAG)-$(2)$(3).tar.gz ssv && \
rm ssv
tar -czf anchor-$(GIT_TAG)-$(2)$(3).tar.gz anchor && \
rm anchor
endef

# Create a series of `.tar.gz` files in the BIN_DIR directory, each containing
# a `ssv` binary for a different target.
# a `anchor` binary for a different target.
#
# The current git tag will be used as the version in the output file names. You
# will likely need to use `git tag` and create a semver tag (e.g., `v0.2.3`).
Expand Down Expand Up @@ -101,13 +101,13 @@ check-benches:
# test vectors.
test: test-release

# Updates the CLI help text pages in the SSV book, building with Docker.
# Updates the CLI help text pages in the Anchor book, building with Docker.
cli:
docker run --rm --user=root \
-v ${PWD}:/home/runner/actions-runner/ssv sigmaprime/github-runner \
bash -c 'cd ssv && make && ./scripts/cli.sh'
-v ${PWD}:/home/runner/actions-runner/anchor sigmaprime/github-runner \
bash -c 'cd anchor && make && ./scripts/cli.sh'

# Updates the CLI help text pages in the SSV book, building using local
# Updates the CLI help text pages in the Anchor book, building using local
# `cargo`.
cli-local:
make && ./scripts/cli.sh
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# SSV: Rust-based Secret Share Validator Client
# Anchor: A Secret Share Validator (SSV) Client in Rust

Open source implantation of the Secret Shared Validator (SSV) protocol, written
in Rust and maintained by Sigma Prime.

[![Book Status]][Book Link] [![Chat Badge]][Chat Link]

[Book Status]:https://img.shields.io/badge/user--docs-stable-informational
[Book Link]: https://ssv-book.sigmaprime.io
[stable]: https://github.com/sigp/ssv/tree/stable
[unstable]: https://github.com/sigp/ssv/tree/unstable
[Book Link]: https://anchor-book.sigmaprime.io
[stable]: https://github.com/sigp/anchor/tree/stable
[unstable]: https://github.com/sigp/anchor/tree/unstable
[blog]: https://blog.sigmaprime.io

## Overview
Expand All @@ -18,13 +18,13 @@ be used for production until a formal production release has been made.

## Documentation

The [SSV Book](https://ssv-book.sigmaprime.io) contains information for users and
The [Anchor Book](https://anchor-book.sigmaprime.io) contains information for users and
developers. Instructions for how to compile/build and run this client are all
contained in this book.

## Branches

SSV maintains two permanent branches:
Anchor maintains two permanent branches:

- [`stable`][stable]: Always points to the latest stable release.
- This is ideal for most users.
Expand All @@ -33,8 +33,8 @@ SSV maintains two permanent branches:

## Contributing

SSV welcomes contributors.
Anchor welcomes contributors.

If you are looking to contribute, please head to the
[Contributing](https://ssv-book.sigmaprime.io/contributing.html) section
of the SSV book.
[Contributing](https://anchor-book.sigmaprime.io/contributing.html) section
of the Anchor book.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Supported Versions

Please see [Releases](https://github.com/ssv/lighthouse/releases/). We recommend using the [most recently released version](https://github.com/sigp/ssv/releases/latest).
Please see [Releases](https://github.com/anchor/releases/). We recommend using the [most recently released version](https://github.com/sigp/anchor/releases/latest).

## Reporting a Vulnerability

Expand Down
2 changes: 1 addition & 1 deletion book/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
language = "en"
multilingual = false
src = "src"
title = "SSV Book"
title = "Anchor Book"
author = "Sigma Prime"

[output.html]
Expand Down
6 changes: 3 additions & 3 deletions book/src/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SSV Book
# Anchor Book

Contains an [mdBook](https://github.com/rust-lang-nursery/mdBook) that serves
as the primary source of SSV user documentation.
as the primary source of Anchor user documentation.

The book is hosted at [ssv.sigmaprime.io](http://ssv.sigmaprime.io)
The book is hosted at [anchor-book.sigmaprime.io](http://anchor-book.sigmaprime.io)

## Usage

Expand Down
24 changes: 12 additions & 12 deletions book/src/contributing.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Contributing to SSV
# Contributing to Anchor

[stable]: https://github.com/sigp/ssv/tree/stable
[unstable]: https://github.com/sigp/ssv/tree/unstable
[stable]: https://github.com/sigp/anchor/tree/stable
[unstable]: https://github.com/sigp/anchor/tree/unstable

SSV welcomes contributions. If you are interested in contributing to to this project, and you want to learn Rust, feel free to join us building this project.
Anchor welcomes contributions. If you are interested in contributing to to this project, and you want to learn Rust, feel free to join us building this project.

To start contributing,

1. Read our [how to contribute](https://github.com/sigp/ssv/blob/stable/CONTRIBUTING.md) document.
1. Read our [how to contribute](https://github.com/sigp/anchor/blob/stable/CONTRIBUTING.md) document.
2. Setup a [development environment](./setup.md).
3. Browse through the [open issues](https://github.com/sigp/ssv/issues)
3. Browse through the [open issues](https://github.com/sigp/anchor/issues)
(tip: look for the [good first
issue](https://github.com/sigp/ssv/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
issue](https://github.com/sigp/anchor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
tag).
4. Comment on an issue before starting work.
5. Share your work via a pull-request.

## Branches

SSV maintains two permanent branches:
Anchor maintains two permanent branches:

- [`stable`][stable]: Always points to the latest stable release.
- This is ideal for most users.
Expand All @@ -41,9 +41,9 @@ cargo fmt --all --check

### Panics

Generally, **panics should be avoided at all costs**. SSV operates in an
Generally, **panics should be avoided at all costs**. Anchor operates in an
adversarial environment (the Internet) and it's a severe vulnerability if
people on the Internet can cause SSV to crash via a panic.
people on the Internet can cause Anchor to crash via a panic.

Always prefer returning a `Result` or `Option` over causing a panic. For
example, prefer `array.get(1)?` over `array[1]`.
Expand Down Expand Up @@ -72,7 +72,7 @@ pub fn my_function(&mut self, _something &[u8]) -> Result<String, Error> {

```rust
// Comment for this struct
struct SSV {}
struct Anchor {}
fn validate_attestation() {} // A comment on the same line after a space
```

Expand All @@ -86,7 +86,7 @@ fn validate_attestation() {} // A comment on the same line after a space
/// This struct is general, other components may implement more
/// specialized config structs.
#[derive(Clone)]
pub struct SSVConfig {
pub struct Config {
pub data_dir: PathBuf,
pub p2p_listen_port: u16,
}
Expand Down
2 changes: 1 addition & 1 deletion book/src/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
_Documentation for protocol developers._

This section lists Lighthouse-specific decisions that are not strictly spec'd and may be useful for
other protocol developers wishing to interact with SSV.
other protocol developers wishing to interact with Anchor.
4 changes: 2 additions & 2 deletions book/src/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Frequently Asked Questions

- [What is sigp/SSV](#sigp-ssv)
- [What is sigp/anchor](#sigp-anchor)

## <a name="sigp-ssv"></a> What is sigp/SSV
## <a name="sigp-anchor"></a> What is sigp/anchor

The rust implementation of the Secret Shared Validator (SSV) protocol.
10 changes: 5 additions & 5 deletions book/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Lighthouse Book

_Documentation for SSV users and developers._
_Documentation for Anchor users and developers._

This is the SSV client.
This is the Anchor client.

## About this Book

This book is open source, contribute at
[github.com/sigp/ssv/book](https://github.com/sigp/ssv/tree/unstable/book).
[github.com/sigp/anchor/book](https://github.com/sigp/anchor/tree/unstable/book).

The SSV CI system maintains a hosted version of the `unstable` branch
at [ssv-book.sigmaprime.io](http://ssv-book.sigmaprime.io).
The Anchor CI system maintains a hosted version of the `unstable` branch
at [anchor-book.sigmaprime.io](http://anchor-book.sigmaprime.io).
8 changes: 4 additions & 4 deletions book/src/setup.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Development Environment

Most SSV developers work on Linux or MacOS, however Windows should still
Most Anchor developers work on Linux or MacOS, however Windows should still
be suitable.

First, follow the [`Installation Guide`](./installation.md) to install
SSV. This will install SSV to your `PATH`, which is not
Anchor. This will install Anchor to your `PATH`, which is not
particularly useful for development but still a good way to ensure you have the
base dependencies.

Expand All @@ -21,14 +21,14 @@ you can run them locally and avoid CI failures:
- `$ make cargo-fmt`: (fast) runs a Rust code formatting check.
- `$ make lint`: (fast) runs a Rust code linter.
- `$ make test`: (medium) runs unit tests across the whole project.
- `$ make test-specs`: (medium) runs the SSV test vectors.
- `$ make test-specs`: (medium) runs the Anchor test vectors.
- `$ make test-full`: (slow) runs the full test suite (including all previous
commands). This is approximately everything
that is required to pass CI.

## Testing

As with most other Rust projects, SSV uses `cargo test` for unit and
As with most other Rust projects, Anchor uses `cargo test` for unit and
integration tests. For example, to test the `qbft` crate run:

```bash
Expand Down
Loading

0 comments on commit 55bdcb5

Please sign in to comment.