Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvements #28

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ An overview of the different projects, in order of relevance and interest:

## Participating

Brief technical overview of participating in the MPC. Further information available [here](https://app.gitbook.com/@aztec-protocol/s/mpc).
Brief technical overview of participating in the MPC. Further information is available [here](https://app.gitbook.com/@aztec-protocol/s/mpc).

#### The Easy Way

Expand Down
4 changes: 2 additions & 2 deletions ci-scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ set -e

IMAGE_NAME=$1

# Docker layer caching can have old layers. Pull given images from remote if we haven't rebuilt this run.
# Docker layer caching can have old layers. Pull the given images from the remote if we haven't rebuilt this run.
for DEP in $2; do
if [ ! -f /tmp/${DEP#*/}.rebuilt ]; then
docker pull $DEP:latest
Expand All @@ -15,4 +15,4 @@ if [ -n "$CIRCLE_SHA1" ]; then
docker tag $IMAGE_NAME:latest $IMAGE_NAME:$CIRCLE_SHA1
fi

touch /tmp/${IMAGE_NAME#*/}.rebuilt
touch /tmp/${IMAGE_NAME#*/}.rebuilt
2 changes: 1 addition & 1 deletion setup-iac/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ resource "aws_vpc" "setup" {
}
}

# We create an addional CIDR block to expand beyond initial /16 limits.
# We create an additional CIDR block to expand beyond initial /16 limits.
resource "aws_vpc_ipv4_cidr_block_association" "cidr1" {
vpc_id = aws_vpc.setup.id
cidr_block = "10.1.0.0/16"
Expand Down
2 changes: 1 addition & 1 deletion setup-iac/us-east-2/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ resource "aws_vpc" "setup" {
}
}

# We create an addional CIDR block to expand beyond initial /16 limits.
# We create an additional CIDR block to expand beyond initial /16 limits.
resource "aws_vpc_ipv4_cidr_block_association" "cidr1" {
vpc_id = aws_vpc.setup.id
cidr_block = "10.3.0.0/16"
Expand Down
2 changes: 1 addition & 1 deletion setup-mpc-client-bash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This project contains a few bash scripts which can be used as a reference as to
## Requirements

- You need to be running [setup-mpc-client](../setup-mpc-client) with the environment variable `COMPUTE_OFFLINE=1`.
- You need to be running an ETH node such as ganache configured with the account that you will use to verify with the server.
- You need to be running an ETH node such as a ganache configured with the account that you will use to verify with the server.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion setup-mpc-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Participants in the AZTEC trusted setup multi party computation fall into three
2. **Early bird individuals** - Participants that have signed up for the ceremony prior to the _selection date_. They have secondary priority during the ceremony.
3. **Individuals** - Participants that have signed up for the ceremony after the _selection date_, or who were not choosen during selection. They have tertiary priority during the ceremony.

The _selection date_ is goverened by a predetermined Ethereum block height. The block hash of the block is used as a seed to a pseudo random number generator which first selects a number of participants from tier 2, and is then used to randomise the priority order of participants in both tier 1 and tier 2. Unselected participants and participants in tier 3 are ordered on a first come first served basis.
The _selection date_ is goverened by a predetermined Ethereum block height. The block hash of the block is used as a seed to a pseudo random number generator which first selects a number of participants from tier 2, and is then used to randomize the priority order of participants in both tier 1 and tier 2. Unselected participants and participants in tier 3 are ordered on a first come first served basis.

To sign up for participation, a user must send 1 wei to the AZTEC controlled address `0x000000000xxxxxxx0000000`. The private key of the sending address must be provided to the client application for authentication.

Expand Down
2 changes: 1 addition & 1 deletion setup-mpc-map/src/shooting-stars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export class ShootingStars {
constructor(locations: LatLon[], viewer: Cesium.Viewer) {
const baseTime = viewer.clock.startTime;

// Stick first location on the end, so we get a loop. Remove duplicate contiguous locations.
// Stick the first location on the end, so we get a loop. Remove duplicate contiguous locations.
locations = [...locations, locations[0]].filter(
(el, i, a) => i === 0 || (el.lat !== a[i - 1].lat || el.lon !== a[i - 1].lon)
);
Expand Down
2 changes: 1 addition & 1 deletion setup-mpc-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The text `SignMeWithYourPrivateKey`, signed by the admin address.

`PATCH /api/participant/<address>`

Updates telemetry around a participants progress.
Updates telemetry around a participant's progress.

`Body`

Expand Down