Skip to content

Max/2nd gitbook test do not merge #516

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

Open
wants to merge 5 commits into
base: main
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
4 changes: 4 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
root: ./

​structure:
readme: README.md
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# sdk

89 changes: 89 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Table of contents

* [sdk](README.md)
* [index](sdk/index.md)
* [classes](sdk/classes/README.md)
* [Client](sdk/classes/Client.md)
* [enumerations](sdk/enumerations/README.md)
* [FORK\_MAPPING](sdk/enumerations/FORK_MAPPING.md)
* [functions](sdk/functions/README.md)
* [validateClusterLock](sdk/functions/validateClusterLock.md)
* [interfaces](sdk/interfaces/README.md)
* [ClusterDefinition](sdk/interfaces/ClusterDefinition.md)
* [RewardsSplitPayload](sdk/interfaces/RewardsSplitPayload.md)
* [type-aliases](sdk/type-aliases/README.md)
* [BuilderRegistration](sdk/type-aliases/BuilderRegistration.md)
* [BuilderRegistrationMessage](sdk/type-aliases/BuilderRegistrationMessage.md)
* [ClusterCreator](sdk/type-aliases/ClusterCreator.md)
* [ClusterLock](sdk/type-aliases/ClusterLock.md)
* [ClusterOperator](sdk/type-aliases/ClusterOperator.md)
* [ClusterPayload](sdk/type-aliases/ClusterPayload.md)
* [ClusterValidator](sdk/type-aliases/ClusterValidator.md)
* [DepositData](sdk/type-aliases/DepositData.md)
* [DistributedValidator](sdk/type-aliases/DistributedValidator.md)
* [ETH\_ADDRESS](sdk/type-aliases/ETH_ADDRESS.md)
* [OperatorPayload](sdk/type-aliases/OperatorPayload.md)
* [SplitRecipient](sdk/type-aliases/SplitRecipient.md)
* [TotalSplitPayload](sdk/type-aliases/TotalSplitPayload.md)
* [adv](adv/README.md)
* [advanced](adv/advanced/README.md)
* [Advanced Docker Configs](adv/advanced/adv-docker-configs.md)
* [Combine DV Private Key Shares](adv/advanced/quickstart-combine.md)
* [Migrate an Existing Validator](adv/advanced/quickstart-split.md)
* [Self-Host a Relay](adv/advanced/self-relay.md)
* [security](adv/security/README.md)
* [Obol Bug Bounty Program](adv/security/bug-bounty.md)
* [Contacts](adv/security/contact.md)
* [ev-assessment](adv/security/ev-assessment.md)
* [Overview](adv/security/overview.md)
* [Centralization Risks and Mitigation](adv/security/risks.md)
* [Charon Threat Model](adv/security/threat_model.md)
* [troubleshooting](adv/troubleshooting/README.md)
* [Client Configuration](adv/troubleshooting/client_configurations.md)
* [Handling DKG Failure](adv/troubleshooting/dkg_failure.md)
* [Test Commands](adv/troubleshooting/test_command.md)
* [gov](gov/README.md)
* [community](gov/community/README.md)
* [Obol Contributions Program](gov/community/contributions.md)
* [Staking Mastery Program](gov/community/staking-masters.md)
* [Techne](gov/community/techne.md)
* [contribution](gov/contribution/README.md)
* [Filing a Bug Report](gov/contribution/bug-report.md)
* [docs](gov/contribution/docs.md)
* [Feedback](gov/contribution/feedback.md)
* [governance](gov/governance/README.md)
* [Collective Overview](gov/governance/collective.md)
* [Delegate Guide](gov/governance/delegate-guide.md)
* [The OBOL Token](gov/governance/obol-token.md)
* [The RAF](gov/governance/raf.md)
* [The Token House](gov/governance/token-house.md)
* [guides](guides/README.md)
* [walkthroughs](guides/walkthroughs/README.md)
* [Walkthrough Guides](guides/walkthroughs/walkthrough-guides.md)
* [learn](learn/README.md)
* [charon](learn/charon/README.md)
* [CLI Reference](learn/charon/charon-cli-reference.md)
* [Cluster Configuration](learn/charon/cluster-configuration.md)
* [Distributed Key Generation](learn/charon/dkg.md)
* [Introduction to Charon](learn/charon/intro.md)
* [futher-reading](learn/futher-reading/README.md)
* [Ethereum and Its Relationship With DVT](learn/futher-reading/ethereum_and_dvt.md)
* [Peer Score](learn/futher-reading/peer_score.md)
* [Useful Links](learn/futher-reading/resources.md)
* [testnet](learn/futher-reading/testnet.md)
* [intro](learn/intro/README.md)
* [Key Staking Concepts](learn/intro/key-concepts.md)
* [DV Launchpad](learn/intro/launchpad.md)
* [Obol Collective](learn/intro/obol-collective.md)
* [Obol vs Other DV Implementations](learn/intro/obol-vs-others.md)
* [run](run/README.md)
* [integrations](run/integrations/README.md)
* [Create a Lido CSM DV](run/integrations/lido-csm.md)
* [prepare](run/prepare/README.md)
* [Deployment Best Practices](run/prepare/deployment-best-practices.md)
* [How and Where To Run DVs](run/prepare/how_where_DVs.md)
* [running](run/running/README.md)
* [Monitoring Your Node](run/running/monitoring.md)
* [start](run/start/README.md)
* [obol-monitoring](run/start/obol-monitoring.md)
* [Quickstart Overview](run/start/quickstart_overview.md)
2 changes: 2 additions & 0 deletions docs/adv/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# adv

2 changes: 2 additions & 0 deletions docs/adv/advanced/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# advanced

2 changes: 2 additions & 0 deletions docs/adv/security/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# security

2 changes: 2 additions & 0 deletions docs/adv/troubleshooting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# troubleshooting

2 changes: 2 additions & 0 deletions docs/gov/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# gov

2 changes: 2 additions & 0 deletions docs/gov/community/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# community

21 changes: 10 additions & 11 deletions docs/gov/community/contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,23 @@ description: Earning Obol Contributions

# Obol Contributions Program

*Our aim is to encourage continuous participation and sustained support for Ethereum’s consensus. The Obol Contributions program is therefore designed to be fair and transparent, without arbitrary gimmicks promoting short-term interest at the cost of long-term participation. Obol Contributions are meant to acknowledge all of the actors in the staking stack for their contribution to Ethereum’s decentralisation.*
_Our aim is to encourage continuous participation and sustained support for Ethereum’s consensus. The Obol Contributions program is therefore designed to be fair and transparent, without arbitrary gimmicks promoting short-term interest at the cost of long-term participation. Obol Contributions are meant to acknowledge all of the actors in the staking stack for their contribution to Ethereum’s decentralisation. test test_

*Each Obol DV contributes 1% of the total staking reward it earns to the Obol Collective. This economic stream is the basis for recognized Contributions. By basing Contributions on staking rewards accumulated by validators (pubkeys), performance is factored in (i.e. effectiveness, uptime, etc.)*
_Each Obol DV contributes 1% of the total staking reward it earns to the Obol Collective. This economic stream is the basis for recognized Contributions. By basing Contributions on staking rewards accumulated by validators (pubkeys), performance is factored in (i.e. effectiveness, uptime, etc.)_

*Contributions are tracked in a centralised database off-chain, not on the blockchain as transferable or non-transferable tokens. Our [API endpoints](https://docs.obol.tech/api#tag/Address/operation/AddressController_getAddressContributions) enable users and protocols to query how much they have contributed. These endpoints are used to show individuals’ Contributions within the [Obol DV Launchpad](https://launchpad.obol.org) and partners’ staking platforms.*
_Contributions are tracked in a centralised database off-chain, not on the blockchain as transferable or non-transferable tokens. Our_ [_API endpoints_](https://docs.obol.tech/api#tag/Address/operation/AddressController_getAddressContributions) _enable users and protocols to query how much they have contributed. These endpoints are used to show individuals’ Contributions within the_ [_Obol DV Launchpad_](https://launchpad.obol.org) _and partners’ staking platforms._

## What is the Obol Contributions Program?

- An opportunity for every staker to participate in and get recognised for scaling and decentralising Ethereum by staking on Obol Distributed Validators (DVs).
- Stake deployed on Obol DVs will contribute 1% of staking rewards to the Obol Collective’s retroactive funding mechanism.
- Those contributions will be tracked and recognised, and serve as the basis for future governance and ownership in the Obol Collective.
* An opportunity for every staker to participate in and get recognised for scaling and decentralising Ethereum by staking on Obol Distributed Validators (DVs).
* Stake deployed on Obol DVs will contribute 1% of staking rewards to the Obol Collective’s retroactive funding mechanism.
* Those contributions will be tracked and recognised, and serve as the basis for future governance and ownership in the Obol Collective.

## How do I participate in the Obol Contributions Program?

You can participate in the Obol Contributions Program by:

1. **Running your own DV Cluster**: You can create and manage your own DV cluster using our [DV Launchpad](https://launchpad.obol.org), for example using a [DappNode](https://dappnode.com/). This allows you to directly participate in the network's decentralisation efforts and earn contributions. You can also visit our [Squad Staking](https://squadstaking.com) page for inspiration and to find squad members.

2. **Staking through Staking Partners**: By participating in staking through our partners, your staking rewards will also contribute to the Obol Collective. For the current list of staking partners, please visit [obol.org/contributions](https://obol.org/contributions).

## How can I track my contributions?
Expand All @@ -37,7 +36,7 @@ Contributions will serve as the basis for future ownership and governance of the

Contributions are based on 1% of validator rewards, which are contributed to the Obol Collective’s “1% for Decentralization” retroactive fund. (retroactivefunding.obol.eth) Contributions are calculated daily and tracked off-chain. This means that the higher the effectiveness and uptime of your validators, the more rewards (and thus contributions) you will generate.

If the total rewards \( R \) for a validator are split among operators with percentages \( p_1, p_2, ..., p_n \), the contributions \( C \) for each operator can be calculated as:
If the total rewards ( R ) for a validator are split among operators with percentages ( p\_1, p\_2, ..., p\_n ), the contributions ( C ) for each operator can be calculated as:

Cᵢ = R × pᵢ × 0.01 × 1.01

Expand All @@ -53,15 +52,15 @@ Obol Contributions are not a promise or indication of any future plans for an Ob

## What is the 1% for Decentralization retroactive funding program?

Users of Obol distributed validator (DV) clusters contribute 1% of their staking rewards to a retroactive funding program. These funds will reward projects and innovations which add value and drive impact towards Ethereum’s decentralisation. Read more on our blog or on obol.org/governance.
Users of Obol distributed validator (DV) clusters contribute 1% of their staking rewards to a retroactive funding program. These funds will reward projects and innovations which add value and drive impact towards Ethereum’s decentralisation. Read more on our blog or on obol.org/governance.

## Do I need to run my own validator to participate?

No, you can stake on DVs and track your contributions through the partners listed on [obol.org/contributions](https://obol.org/contributions). More partners are coming soon.

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

There is no penalty for exiting your validator. You simply stop accruing Contributions. The specific withdrawal policy will depend on the staking protocol used.
There is no penalty for exiting your validator. You simply stop accruing Contributions. The specific withdrawal policy will depend on the staking protocol used.

## What is the minimum amount of ETH needed to stake?

Expand Down Expand Up @@ -89,4 +88,4 @@ Distributed validators increase the security, resiliency, and decentralisation o

## How can I get support if I have issues?

Support is available through Obol’s [Discord](https://discord.gg/obol) and partners’ support channels.
Support is available through Obol’s [Discord](https://discord.gg/obol) and partners’ support channels.
2 changes: 2 additions & 0 deletions docs/gov/contribution/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# contribution

2 changes: 2 additions & 0 deletions docs/gov/governance/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# governance

2 changes: 2 additions & 0 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# guides

2 changes: 2 additions & 0 deletions docs/guides/walkthroughs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# walkthroughs

2 changes: 2 additions & 0 deletions docs/learn/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# learn

2 changes: 2 additions & 0 deletions docs/learn/charon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# charon

2 changes: 2 additions & 0 deletions docs/learn/futher-reading/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# futher-reading

2 changes: 2 additions & 0 deletions docs/learn/intro/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# intro

2 changes: 1 addition & 1 deletion docs/learn/intro/obol-collective.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
description: The Obol Collective
---

# Obol Collective

## What is the Obol Collective?
Expand Down
Loading