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.

Sign up for GitHub

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 fix spelling issues #6873

Closed
wants to merge 4 commits into from
Closed

Docs fix spelling issues #6873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
089c3d7
Update README.md
nnsW3 Jan 25, 2025
bc8a283
Update attestation_processing_and_production.md
nnsW3 Jan 25, 2025
113c378
Update block_synchronization.md
nnsW3 Jan 25, 2025
1f6876e
Update eth1_data_processing.md
nnsW3 Jan 25, 2025
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The [Quickstart](https://nimbus.guide/quick-start.html) in particular will help
* http://testing.holesky.beacon-api.nimbus.team/
* http://unstable.holesky.beacon-api.nimbus.team/

Note that right now these are very much unstable testing instances. They may be unresponsive at times - so **please do not rely on them for validating**. We may also disable them at any time.
Note that right now these are very unstable testing instances. They may be unresponsive at times - so **please do not rely on them for validating**. We may also disable them at any time.

## Migrate from another client

Expand All @@ -64,7 +64,7 @@ If you'd like to contribute to Nimbus development, our donation address is [`0x7
## Branch guide

* `stable` - latest stable release - **this branch is recommended for most users**
* `testing` - pre-release branch with features and bugfixes slated for the next stable release - this branch is suitable for use on testnets and for adventurous users that want to live on the edge.
* `testing` - pre-release branch with features and bug fixes slated for the next stable release - this branch is suitable for use on testnets and for adventurous users that want to live on the edge.
* `unstable` - main development branch against which PR's are merged - if you want to contribute to Nimbus, start here.

## Developer resources
Expand Down Expand Up @@ -94,7 +94,7 @@ build/block_sim --help

### Local network simulation

The local network simulation will create a full peer-to-peer network of beacon nodes and validators on a single machine, and run the beacon chain in real time.
The local network simulation will create a full peer-to-peer network of beacon nodes and validators on a single machine, and run the beacon chain in real-time.
Parameters such as shard, validator counts, and data folders can be set in as environment variables before launching the simulation.

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/nbc_audit_2020/eth2_spec_core/attestation_processing_and_production.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Concretely:

The main application is the **beacon_node**, it has 2 mode of operations regarding accounts. With accounts managed in an integrated manner or managed in a split manner, something we call the VC/BN split (Validator Client / Beacon Node split).

In both case, there is a need of a keystore to hold the validators' **signing keys.**
In both cases, there is a need of a keystore to hold the validators' **signing keys.**

### 2.1 Reminder on Ethereum secret keys

Expand Down
2 changes: 1 addition & 1 deletion docs/nbc_audit_2020/eth2_spec_core/block_synchronization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ category: "ETH2 Specification Core Audit"
repositories: "nim-beacon-chain"
---

**Note:** Currently there is an issue where ingoing block sync is slow on Medalla testnet and being investigated. There are many changes being made.
**Note:** Currently there is an issue where ingoing block sync is slow on Medalla testnet and is being investigated. There are many changes being made.

Spec: TODO

Expand Down
4 changes: 2 additions & 2 deletions docs/nbc_audit_2020/eth2_spec_core/eth1_data_processing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ repositories: "nim-beacon-chain, nim-web3"
ETH2 validators are added by locking ETH on a designated ETH1 contract.

Monitoring the ETH1 deposit contract is done via the mainchain_monitor service
which connects to a ETH1 Web3 provider (Geth or Infura):
which connects to an ETH1 Web3 provider (Geth or Infura):
- [https://github.com/status-im/nim-beacon-chain/blob/master/beacon_chain/mainchain_monitor.nim](https://github.com/status-im/nim-beacon-chain/blob/master/beacon_chain/mainchain_monitor.nim)
- Spec of the deposit contract (for reference): [https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/deposit-contract.md](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/deposit-contract.md)

nim-web3 scope is significantly larger (and unimplemented) that the audit of nim-beacon-chain. The subset in scope is the one used by mainchain_monitor namely:
nim-web3 scope is significantly larger (and unimplemented) than the audit of nim-beacon-chain. The subset in scope is the one used by mainchain_monitor namely:

- The types Web3, Sender, Subscription

Expand Down
Loading