Skip to content

Commit cbe973a

Browse files
authored
Fixed typos and spelling issues for intro pages (#43)
1 parent bd1aa73 commit cbe973a

File tree

6 files changed

+33
-33
lines changed

6 files changed

+33
-33
lines changed

learn/intro/frequently-asked-questions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,21 +73,21 @@ It is possible to migrate your Charon node to another machine running the same c
7373

7474
Currently, the minimum is 4 operators with a threshold of 3.
7575

76-
The threshold (aka quorum) corresponds to the minimum numbers of operators that need to be active for the validator(s) to be able to perform its duties. It is defined by the following formula `n-(ceil(n/3)-1)`. We strongly recommend using this default threshold in your DKG as it maximises liveness while maintaining BFT safety. Setting a 4 out of 4 cluster for example, would make your validator more vulnerable to going offline instead of less vulnerable. You can check the recommended threshold values for a cluster [here](https://docs.obol.org/learn/intro/key-concepts#distributed-validator-threshold).
76+
The threshold (aka quorum) corresponds to the minimum number of operators that need to be active for the validator(s) to be able to perform its duties. It is defined by the following formula `n-(ceil(n/3)-1)`. We strongly recommend using this default threshold in your DKG as it maximises liveness while maintaining BFT safety. Setting a 4 out of 4 cluster for example, would make your validator more vulnerable to going offline instead of less vulnerable. You can check the recommended threshold values for a cluster [here](https://docs.obol.org/learn/intro/key-concepts#distributed-validator-threshold).
7777

7878
### Obol Splits[](https://docs.obol.org/learn/intro/faq#obol-splits) <a href="#obol-splits" id="obol-splits"></a>
7979

8080
#### What are Obol Splits?[](https://docs.obol.org/learn/intro/faq#what-are-obol-splits) <a href="#what-are-obol-splits" id="what-are-obol-splits"></a>
8181

82-
Obol Splits refers to a collection of composable smart contracts that enable the splitting of validator rewards and/or principal in a non-custodial, trust-minimised manner. Obol Splits contains integrations to enable DVs within Lido, Eigenlayer, and in future a number of other LSPs.
82+
Obol Splits refers to a collection of composable smart contracts that enable the splitting of validator rewards and/or principal in a non-custodial, trust-minimised manner. Obol Splits contains integrations to enable DVs within Lido, Eigenlayer, and in the future a number of other LSPs.
8383

8484
#### Are Obol Splits non-custodial?[](https://docs.obol.org/learn/intro/faq#are-obol-splits-non-custodial) <a href="#are-obol-splits-non-custodial" id="are-obol-splits-non-custodial"></a>
8585

8686
Yes. Unless you were to decide to [deploy an editable splitter contract](https://docs.obol.org/learn/intro/faq#can-i-change-the-percentages-in-a-split), Obol Splits are immutable, non-upgradeable, non-custodial, and oracle-free.
8787

8888
#### Can I change the percentages in a split?[](https://docs.obol.org/learn/intro/faq#can-i-change-the-percentages-in-a-split) <a href="#can-i-change-the-percentages-in-a-split" id="can-i-change-the-percentages-in-a-split"></a>
8989

90-
Generally Obol Splits are deployed in an immutable fashion, meaning you cannot edit the percentages after deployment. However, if you were to choose to deploy a _controllable_ splitter contract when creating your Split, then yes, the address you select as controller can update the split percentages arbitrarily. A common pattern for this use case is to use a Gnosis SAFE as the controller address for the split, giving a group of entities (usually the operators and principal provider) the ability to update the percentages if need be. A well known example of this pattern is the [Protocol Guild](https://protocol-guild.readthedocs.io/en/latest/03-onchain-architecture.html).
90+
Generally, Obol Splits are deployed in an immutable fashion, meaning you cannot edit the percentages after deployment. However, if you were to choose to deploy a _controllable_ splitter contract when creating your Split, then yes, the address you select as controller can update the split percentages arbitrarily. A common pattern for this use case is to use a Gnosis SAFE as the controller address for the split, giving a group of entities (usually the operators and principal provider) the ability to update the percentages if need be. A well-known example of this pattern is the [Protocol Guild](https://protocol-guild.readthedocs.io/en/latest/03-onchain-architecture.html).
9191

9292
#### How do Obol Splits work?[](https://docs.obol.org/learn/intro/faq#how-do-obol-splits-work) <a href="#how-do-obol-splits-work" id="how-do-obol-splits-work"></a>
9393

@@ -111,9 +111,9 @@ No. Any address can trigger the contracts to move the funds, they do not need to
111111

112112
#### Are there any edge cases I should be aware of when using Obol Splits?[](https://docs.obol.org/learn/intro/faq#are-there-any-edge-cases-i-should-be-aware-of-when-using-obol-splits) <a href="#are-there-any-edge-cases-i-should-be-aware-of-when-using-obol-splits" id="are-there-any-edge-cases-i-should-be-aware-of-when-using-obol-splits"></a>
113113

114-
The most important decision is to be aware of whether or not the Split contract you are using has been set up with editability. If a splitter is editable, you should understand what the address that can edit the split does. Is the editor an EOA? Who controls that address? How secure is their seed phrase? Is it a smart contract? What can that contract do? Can the controller contract be upgraded? etc. Generally, the safest thing in Obol's perspective is not to have an editable splitter, and if in future you are unhappy with the configuration, that you exit the validator and create a fresh cluster with new settings that fit your needs.
114+
The most important decision is to be aware of whether or not the Split contract you are using has been set up with editability. If a splitter is editable, you should understand what the address that can edit the split does. Is the editor an EOA? Who controls that address? How secure is their seed phrase? Is it a smart contract? What can that contract do? Can the controller contract be upgraded? etc. Generally, the safest thing in Obol's perspective is not to have an editable splitter, and if in the future you are unhappy with the configuration, that you exit the validator and create a fresh cluster with new settings that fit your needs.
115115

116-
Another aspect to be aware of is how the splitting of principal from rewards works using the Optimistic Withdrawal Recipient contract. There are edge cases relating to not calling the contracts periodically or ahead of a withdrawal, activating more validators than the contract was configured for, and a worst case mass slashing on the network. Consult the documentation on the contract [here](https://docs.obol.org/learn/intro/obol-splits#optimistic-withdrawal-recipient), its audit [here](https://docs.obol.org/adv/security/smart_contract_audit), and follow up with the core team if you have further questions.
116+
Another aspect to be aware of is how the splitting of principal from rewards works using the Optimistic Withdrawal Recipient contract. There are edge cases relating to not calling the contracts periodically or ahead of a withdrawal, activating more validators than the contract was configured for, and a worst-case mass slashing on the network. Consult the documentation on the contract [here](https://docs.obol.org/learn/intro/obol-splits#optimistic-withdrawal-recipient), its audit [here](https://docs.obol.org/adv/security/smart_contract_audit), and follow up with the core team if you have further questions.
117117

118118
### Debugging Errors in Logs[](https://docs.obol.org/learn/intro/faq#debugging-errors-in-logs) <a href="#debugging-errors-in-logs" id="debugging-errors-in-logs"></a>
119119

learn/intro/key-concepts.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page outlines a number of the key concepts behind the various technologies
1212

1313
A distributed validator is an Ethereum proof-of-stake validator that runs on more than one node/machine. This functionality is possible with the use of **Distributed Validator Technology** (DVT).
1414

15-
Distributed validator technology removes some of the single points of failure in validation. Should <33% of the participating nodes in a DV cluster go offline, the remaining active nodes can still come to consensus on what to sign and can produce valid signatures for their staking duties. This is known as Active/Active redundancy, a common pattern for minimizing downtime in mission critical systems.
15+
Distributed validator technology removes some of the single points of failure in validation. Should <33% of the participating nodes in a DV cluster go offline, the remaining active nodes can still come to consensus on what to sign and can produce valid signatures for their staking duties. This is known as Active/Active redundancy, a common pattern for minimising downtime in mission-critical systems.
1616

1717
## Distributed Validator Node
1818

@@ -26,7 +26,7 @@ In the above example, the stack includes Geth, Lighthouse, Charon and Teku.
2626

2727
<figure><img src="../../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption></figcaption></figure>
2828

29-
An execution client (formerly known as an Eth1 client) specializes in running the EVM and managing the transaction pool for the Ethereum network. These clients provide execution payloads to consensus clients for inclusion into blocks.
29+
An execution client (formerly known as an Eth1 client) specialises in running the EVM and managing the transaction pool for the Ethereum network. These clients provide execution payloads to consensus clients for inclusion into blocks.
3030

3131
Examples of execution clients include:
3232

@@ -38,7 +38,7 @@ Examples of execution clients include:
3838

3939
<figure><img src="../../.gitbook/assets/image (3) (1) (1).png" alt=""><figcaption></figcaption></figure>
4040

41-
A consensus client's duty is to run the proof of stake consensus layer of Ethereum, often referred to as the beacon chain.
41+
A consensus client's duty is to run the proof-of-stake consensus layer of Ethereum, often referred to as the beacon chain.
4242

4343
Examples of Consensus clients include:
4444

@@ -83,15 +83,15 @@ A distributed validator cluster is a collection of distributed validator nodes c
8383

8484
<figure><img src="../../.gitbook/assets/image (7) (1) (1).png" alt=""><figcaption></figcaption></figure>
8585

86-
A distributed validator key is a group of BLS private keys, that together operate as a threshold key for participating in proof of stake consensus.
86+
A distributed validator key is a group of BLS private keys which together operate as a threshold key for participating in proof-of-stake consensus.
8787

8888
### Distributed Validator Key Share
8989

9090
One piece of the distributed validator private key.
9191

9292
### Distributed Validator Threshold
9393

94-
The number of nodes in a cluster that needs to be online and honest for their distributed validators to be online is outlined in the following table.
94+
The number of nodes in a cluster that need to be online and honest for their distributed validators to be online is outlined in the following table.
9595

9696
| Cluster Size | Threshold | Note |
9797
| :----------: | :-------: | --------------------------------------------- |

learn/intro/launchpad.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ description: A dapp to securely create Distributed Validators alone or with a gr
66

77
In order to activate an Ethereum validator, 32 ETH must be deposited into the official deposit contract. Distributed validators are no different.
88

9-
The vast majority of users that created validators to date have used the [~~**Eth2**~~**&#x20;Staking Launchpad**](https://launchpad.ethereum.org/), a public good open source website built by the Ethereum Foundation alongside participants who later went on to found Obol. This tool has been wildly successful in the safe and educational creation of a significant number of validators on the Ethereum mainnet.
9+
The vast majority of users that created validators to date have used the [~~**Eth2**~~**&#x20;Staking Launchpad**](https://launchpad.ethereum.org/), a public good open-source website built by the Ethereum Foundation alongside participants who later went on to found Obol. This tool has been wildly successful in the safe and educational creation of a significant number of validators on the Ethereum mainnet.
1010

11-
To facilitate the generation of distributed validator keys amongst remote users with high trust, the Obol Network developed and maintains a website that enables a group of users to come together and create these threshold keys: **The DV Launchpad**.
11+
To facilitate the generation of distributed validator keys amongst remote users with high-trust, the Obol Network developed and maintains a website that enables a group of users to come together and create these threshold keys: **The DV Launchpad**.
1212

1313
<figure><img src="../../.gitbook/assets/image (16) (1) (1).png" alt=""><figcaption></figcaption></figure>
1414

1515
## Getting started
1616

17-
For more information on running Charon in a UI friendly way through the DV Launchpad, take a look at our [Quickstart Guides](../../run-a-dv/start/quickstart_overview.md).
17+
For more information on running Charon in a UI-friendly way through the DV Launchpad, take a look at our [Quickstart Guides](../../run-a-dv/start/quickstart_overview.md).
1818

1919
## DV Launchpad Links
2020

@@ -44,6 +44,6 @@ An operator can be part of multiple clusters. Clusters, and cluster invites, are
4444
4545
## Use the Explorer
4646

47-
Clicking "explore" on the top right of the launchpad brings you to the explorer view. It shows information about every DV cluster and operator being tracked by Obol. You can search for a cluster or operator by name, or filter based on badge or protocol type.
47+
Clicking "explore" on the top-right of the launchpad brings you to the explorer view. It shows information about every DV cluster and operator being tracked by Obol. You can search for a cluster or operator by name, or filter based on badge or protocol type.
4848

4949
<figure><img src="../../.gitbook/assets/image (19) (1).png" alt=""><figcaption></figcaption></figure>

learn/intro/obol-collective.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: The Obol Collective
66

77
## What is the Obol Collective?
88

9-
The Obol Collective is the largest Decentralized Operator Ecosystem. We provides the technology, opportunities, and community to scale decentralized infrastructure networks. The list of Obol Collective participants includes 50+ staking protocols, client teams, software tools, education & community projects, professional node operators, home operators, and stakers, including names like EigenLayer, Lido, EtherFi, Figment, Bitcoin Suisse, Stakewise, Nethermind, Blockdaemon, Chorus One, DappNode, and many more. Learn more at [Obol.org](https://obol.org).
9+
The Obol Collective is the largest Decentralised Operator Ecosystem. We provide the technology, opportunities, and community to scale decentralised infrastructure networks. The list of Obol Collective participants includes 50+ staking protocols, client teams, software tools, education & community projects, professional node operators, home operators, and stakers, including names like EigenLayer, Lido, EtherFi, Figment, Bitcoin Suisse, Stakewise, Nethermind, Blockdaemon, Chorus One, DappNode, and many more. Learn more at [Obol.org](https://obol.org).
1010

1111
<figure><img src="../../.gitbook/assets/DecentralizedOperatorEcosystem.png" alt=""><figcaption></figcaption></figure>
1212

1313
## Scaling Infrastructure Networks
1414

15-
Obol is focused on scaling consensus by providing permissionless access to Distributed Validators (DVs), which offer not only protection against client issues and key mismanagement, but also byzantine fault tolerance. We believe that distributed validators should and will make up a large portion of mainnet validator configurations, with the transition of the Ethereum community to DVs enabling a new trust paradigm.
15+
Obol is focused on scaling consensus by providing permissionless access to Distributed Validators (DVs), which offer not only protection against client issues and key mismanagement, but also Byzantine fault tolerance. We believe that distributed validators should and will make up a large portion of mainnet validator configurations, with the transition of the Ethereum community to DVs enabling a new trust paradigm.
1616

1717
The Distributed Validator middleware client, Charon, boosts the security, resilience, and decentralisation of the Ethereum validator network by enabling “squad staking”. The Collective is fueled by Obol’s economic model, which directs funding to ecosystem projects via retroactive funding - a positive flywheel to accelerate adoption of DVs and scale infrastructure networks like Ethereum.
1818

learn/intro/obol-incentives.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can participate by:
3333

3434
### Is existing stake eligible?
3535

36-
* If you are staking yourself directly on Obol DVs and/or Squad Staking, your stake is 100% eligible for rewards. Please note, you must opt into [1% for Decentralization](https://blog.obol.org/1-percent-for-decentralisation/) to qualify for Obol Incentives.
36+
* If you are staking yourself directly on Obol DVs and/or Squad Staking, your stake is 100% eligible for rewards. Please note, you must opt into [1% for Decentralisation](https://blog.obol.org/1-percent-for-decentralisation/) to qualify for Obol Incentives.
3737
* If you are staking with a partner protocol, it's best to review the details of that partner at Obol.org/incentives. Only ETH staked on Obol DVs with qualified partners qualify for Obol Incentives and not all partners are created equal.
3838

3939
***
@@ -97,7 +97,7 @@ Higher effectiveness & uptime = more incentives.
9797

9898
### Can I withdraw my staked ETH at any time?
9999

100-
Yes, you can withdraw at anytime but you **stop accruing incentives** upon withdrawal.
100+
Yes, you can withdraw at any time but you **stop accruing incentives** upon withdrawal.
101101

102102
* If you are staking with a partner, they may choose to set penalties for early withdrawals but this is not common.
103103
* If you are running your own distributed validator, there is no penalty for withdrawing or exiting.

0 commit comments

Comments
 (0)