From 8d2e272744fc3ae56dd50ba0221eb4af8948cfcb Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 14:22:05 +0000 Subject: [PATCH 01/10] Fix orthographic mistake: change 'commiting' to 'committing' --- docs/rustdoc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rustdoc/README.md b/docs/rustdoc/README.md index 6764e18b8b..2c7ec8da1a 100644 --- a/docs/rustdoc/README.md +++ b/docs/rustdoc/README.md @@ -12,4 +12,4 @@ like so: REGENERATE_INDEX=1 ./deployments/scripts/rust-docs ``` -and then commiting the changes, if any, to `docs/rustdoc/index.html`. +and then committing the changes, if any, to `docs/rustdoc/index.html`. From 2715f139bbb85f38aa2e0423c6964b7021c9b7f4 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 14:26:09 +0000 Subject: [PATCH 02/10] Fix typo: change 'profobuf's' to 'protobuf's' --- docs/protocol/src/ibc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/ibc.md b/docs/protocol/src/ibc.md index b40fb6dc62..1503dac141 100644 --- a/docs/protocol/src/ibc.md +++ b/docs/protocol/src/ibc.md @@ -30,7 +30,7 @@ In order to support the IBC protocol, Penumbra adds a single additional Action * `Acknowledgement` These datagrams are implemented as protocol buffers, with the enclosing -`IBCAction` type using profobuf's `OneOf` directive to encapsulate all possible +`IBCAction` type using protobuf's `OneOf` directive to encapsulate all possible IBC datagram types. # Transfers into Penumbra From a3061de94ee47a4287efb83c583684db4dc2b995 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 15:04:51 +0000 Subject: [PATCH 03/10] Fix typo: change 'superceded' to 'superseded' --- docs/protocol/src/governance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/governance.md b/docs/protocol/src/governance.md index fcf1b5cfc7..d36c5f977b 100644 --- a/docs/protocol/src/governance.md +++ b/docs/protocol/src/governance.md @@ -36,7 +36,7 @@ proposer at the end of voting. From the proposer's point of view, the lifecycle of a proposal begins when it is _submitted_ and ends when it the deposit is _claimed_. During the voting period, the proposer may also optionally _withdraw_ the proposal, which prevents it from passing, but does not prevent it -from being slashed. This is usually used when a proposal has been superceded by a revised +from being slashed. This is usually used when a proposal has been superseded by a revised alternative. From 5334054cd918f4d318cab8a3df0630df5b2116a6 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 15:19:32 +0000 Subject: [PATCH 04/10] Fix typo in 'Privacy for Market-Takers' section, change 'deposits' to 'withdrawals' --- docs/protocol/src/zswap/swap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/zswap/swap.md b/docs/protocol/src/zswap/swap.md index 9dac325da0..31928dd888 100644 --- a/docs/protocol/src/zswap/swap.md +++ b/docs/protocol/src/zswap/swap.md @@ -164,7 +164,7 @@ potential places to try to correlate amounts: - Each epoch discloses the net amount of newly bonded stake for each validator; - Liquidity pool deposits disclose the precise type and amount of newly deposited reserves; -- Liquidity pool deposits disclose the precise type and amount of newly +- Liquidity pool withdrawals disclose the precise type and amount of newly withdrawn reserves; The existence of the swap mechanism potentially makes correlation by amount more From 7dd4ac9ca1f67ce626c61ae1ce926ecdc6e0f031 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 15:32:53 +0000 Subject: [PATCH 05/10] Fix typo: Change 'Make sure choose the correct platform for your machine.' to 'Make sure to choose the correct platform for your machine.' in installation instructions. --- docs/guide/src/pd/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/src/pd/install.md b/docs/guide/src/pd/install.md index bacb08a8d7..08bcbab96c 100644 --- a/docs/guide/src/pd/install.md +++ b/docs/guide/src/pd/install.md @@ -4,7 +4,7 @@ Download prebuilt binaries from the [Penumbra releases page on Github](https://g Make sure to use the most recent version available, as the version of `pd` must match the software currently running on the network. -Make sure choose the correct platform for your machine. After downloading the `.tar.xz` file, +Make sure to choose the correct platform for your machine. After downloading the `.tar.xz` file, extract it, and copy its contents to your `$PATH`. For example: ``` From 7655d5574fd811cb26703ee1617d37b42465e2b5 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 20:16:58 +0000 Subject: [PATCH 06/10] Fix typo in 'Maintaining protobuf specs' section --- docs/guide/src/dev/protobuf.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/src/dev/protobuf.md b/docs/guide/src/dev/protobuf.md index 18705d4d9d..578db3adca 100644 --- a/docs/guide/src/dev/protobuf.md +++ b/docs/guide/src/dev/protobuf.md @@ -7,7 +7,7 @@ are relevant: * `proto/penumbra/**/*.proto`, the developer-authored spec files * `crates/proto/src/gen/*.rs`, the generated Rust code files * `proto/go/**/*.pb.go`, the generated Go code files - * `tools/proto-compiler/`, the build logic for generated the Rust code files + * `tools/proto-compiler/`, the build logic for generating the Rust code files We use [buf] to auto-publish the protobuf schemas at [buf.build/penumbra-zone/penumbra][protobuf], and to generate Go and Typescript packages. From 5bedc55ffe908be6eadbb38af6adec67216aaed1 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 20:27:38 +0000 Subject: [PATCH 07/10] Corrected phrasing in the 'Updating your validator' section --- docs/guide/src/pd/join-testnet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/src/pd/join-testnet.md b/docs/guide/src/pd/join-testnet.md index b6fedef33a..a662b9bc07 100644 --- a/docs/guide/src/pd/join-testnet.md +++ b/docs/guide/src/pd/join-testnet.md @@ -241,7 +241,7 @@ First fetch your existing validator definition from the chain: pcli validator definition fetch --file validator.toml ``` -Then make any changes desired and **make sure to increase by `sequence_number` by at least 1!** +Then make any changes desired and **make sure to increase `sequence_number` by at least 1!** The `sequence_number` is a unique, increasing identifier for the version of the validator definition. After updating the validator definition you can upload it again to update your validator metadata on-chain: From 79fc14ce4c3bca3086d8b747dbb08e8f6e33a207 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 20:43:39 +0000 Subject: [PATCH 08/10] Fix redundant phrase 'for to' in document --- docs/protocol/src/concepts/batching_flows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/concepts/batching_flows.md b/docs/protocol/src/concepts/batching_flows.md index fa17d8ff1b..7ee0bb5aa1 100644 --- a/docs/protocol/src/concepts/batching_flows.md +++ b/docs/protocol/src/concepts/batching_flows.md @@ -28,7 +28,7 @@ allowing value flows to be batched over any time interval from 1 block up to the length of an epoch. We propose epoch boundaries on the order of 1-3 days. At the beginning of each epoch, the validator set performs distributed key -generation for to produce a decryption key jointly controlled by the +generation to produce a decryption key jointly controlled by the validators (on an approximately stake-weighted basis) and includes the encryption key in the first block of the epoch. From 73e18e43c1f05543ee67efa16084a7f59292db03 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 20:53:12 +0000 Subject: [PATCH 09/10] Fix typo in NOTE section: change 'requries' to 'requires' --- docs/protocol/src/crypto/flow-encryption/dkg.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/crypto/flow-encryption/dkg.md b/docs/protocol/src/crypto/flow-encryption/dkg.md index a8f9b56f3e..cee4855639 100644 --- a/docs/protocol/src/crypto/flow-encryption/dkg.md +++ b/docs/protocol/src/crypto/flow-encryption/dkg.md @@ -117,7 +117,7 @@ on the delay between the start of a new epoch and the completion of the DKG as This could potentially be pipelined by including each participant's commitments for the next epoch (the commitments $a_{ij}*G$ from FROST) in the block data at one of the last blocks of the previous epoch. *Round 2* of FROST could occur during the vote extensions phase of the epoch transition block. -***NOTE***: FROST requries private communication channels for round 2, thus we +***NOTE***: FROST requires private communication channels for round 2, thus we must assign validators encryption keys, perform key agreement, and encrypt round 2 communications before placing them in the vote extension. This can be accomplished using ECDH with `decaf377`, and an AEAD cipher (though From 141e37f5f8b701e7c26c07865d0b7c09f33c4d36 Mon Sep 17 00:00:00 2001 From: joaolago1113 <22820692+joaolago1113@users.noreply.github.com> Date: Sat, 9 Dec 2023 20:56:24 +0000 Subject: [PATCH 10/10] Fix typo in 'Algorithms and Protocols' section --- docs/protocol/src/crypto/flow/ideal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/src/crypto/flow/ideal.md b/docs/protocol/src/crypto/flow/ideal.md index f0952f951b..fd7e0ee2d6 100644 --- a/docs/protocol/src/crypto/flow/ideal.md +++ b/docs/protocol/src/crypto/flow/ideal.md @@ -51,7 +51,7 @@ the specific instantiation. ###### `FlowEnc/Encrypt` -This an algorithm run by users. On input an encryption key $D$ and the opening +This is an algorithm run by users. On input an encryption key $D$ and the opening $(v, \widetilde{v})$ to a Pedersen commitment $C$, this algorithm outputs a ciphertext $E = \operatorname{Enc}(v)$ and a proof $\pi_{\operatorname{Enc}}$ which establishes that