Skip to content

Commit

Permalink
Fix typos (#35)
Browse files Browse the repository at this point in the history
* fix typos deployed-contracts.md

* fix typos faq.md

* fix typos glossary.md

* fix typos intro.md

* fix typos modules.md

* fix typos nlrt.md

* fix typos overview.md
  • Loading branch information
nnsW3 authored Jun 24, 2024
1 parent bd9f058 commit 22953b7
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/deployed-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Puffer's smart contracts are located in two repos:
> Visit the [technical documentation](https://github.com/PufferFinance/pufETH/tree/main/docs) for more information.
### [PufferFinance/PufferPool](https://github.com/PufferFinance/PufferPool)
> This repo contains the core contracts for Puffer's protocol. The core fuctionality is to:
> This repo contains the core contracts for Puffer's protocol. The core functionality is to:
- allow for users to permissionlessly run Ethereum validators
- interface with EigenLayer's contracts to enable native restaking and delegation

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ slug: /reference/faq
> In the context of liquid staking, centralized protocols with permissioned validators do not require their operators to put down collateral. Rather, they rely on reputation to ensure they behave honestly. In practice, some operators run tens of thousands of validators each. For a decentralized liquid staking protocol, running this many validators requires operators to have tens of thousands of ETH.
>
> Puffer's goal is to break this cycle by empowering decentralized validators with higher rewards while lowering thier barrier to entry.
> Puffer's goal is to break this cycle by empowering decentralized validators with higher rewards while lowering their barrier to entry.
### 🦈 How does Puffer help address some of these pain points?

Expand Down
4 changes: 2 additions & 2 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ An ERC20 token. Each Validator Ticket allows operating a validator on the Puffer
An amount of pufETH a NoOp must lend to the protocol during the time of running their validator node. They may lose some or all of this bond if they misbehave or are slashed. NoOps may retrieve this bond after proving they have exited their validator node from the beacon chain

### `Puffer Module`
A contract which defines a set of AVSs which NoOps opting into the module will delegate their ETH funds to running. These NoOps will receive corresponding rewards in return by participating in this Puffer Module
A contract that defines a set of AVSs which NoOps opting into the module will delegate their ETH funds to running. These NoOps will receive corresponding rewards in return by participating in this Puffer Module

### `Restaking Operator`
AKA ReOp: A NoOp that is delegated funds to operate an AVS on behalf of other NoOps, as part of a Puffer Module
Expand All @@ -80,4 +80,4 @@ AKA ReOp: A NoOp that is delegated funds to operate an AVS on behalf of other No
A software developed by Puffer that helps prevent validators from being slashed. It utilizes Trusted Execution Environments (TEEs) such as Intel SGX

### `Proof of Rewards`
This refers to the process by which NoOps prove and receive the rewards generated as a result of running their validator node
This refers to the process by which NoOps prove and receive the rewards generated as a result of running their validator node
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Together, stakers and NoOps create a flywheel effect that allows Puffer to outpa


The protocol is driven by **Stakers** and **Node Operators** (NoOps):
- **NoOps** can join *any* Puffer [module](/protocol/puffer-modules) by locking [Validator Tickets](/protocol/validator-tickets) and 1 ETH as collateral. In exchange, they get to operate a 32 ETH validator and keep 100% of its PoS rewards until they run out of VTs. NoOps can boost their rewards by joining [restaking](/reference/glossary#Restaking) modules and delegating the validator's ETH to a [restaking operator](/protocol/puffer-modules#restaking-operators) in exchange for restaking rewards commission.
- **NoOps** can join *any* Puffer [module](/protocol/puffer-modules) by locking [Validator Tickets](/protocol/validator-tickets) and 1 ETH as collateral. In exchange, they get to operate a 32 ETH validator and keep 100% of their PoS rewards until they run out of VTs. NoOps can boost their rewards by joining [restaking](/reference/glossary#Restaking) modules and delegating the validator's ETH to a [restaking operator](/protocol/puffer-modules#restaking-operators) in exchange for restaking rewards commission.


- **Stakers** can deposit any amount of ETH to help fund the protocol's 32 ETH NoOp-controlled validators. In exchange, they receive the pufETH [native Liquid Restaking Token](/protocol/nlrt#what-is-an-lst) (nLRT) which grows in value as the protocol mints validator tickets and receives restaking rewards.
Expand Down
4 changes: 2 additions & 2 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ When NoOps deploy their validators to PufferModules they automatically earn rest
Restaking Operators (ReOps) are operators whose job is to perform all the required AVS duties on behalf of a given restaking module. ReOps may also be NoOps within their own or other modules. ReOps are expected to perform well to maximize restaking rewards for their own benefit and that of the NoOps in their module and pufETH holders downstream. In the Puffer protocol, ReOps operate through [RestakingOperator](https://github.com/PufferFinance/PufferPool/blob/master/docs/RestakingOperator.md) contracts, which allows governance to decide their AVS selections through the [PufferModuleManager](https://github.com/PufferFinance/PufferPool/blob/master/docs/PufferModuleManager.md) contract.

### Joining a module 👈
To hold strong to our alignment to Ethereum's ethos, it is **always permissionless** for NoOps to join a module and deploy an Ethereum validator.
To hold strong to our alignment with Ethereum's ethos, it is **always permissionless** for NoOps to join a module and deploy an Ethereum validator.

:::tip
It is permissionless for NoOps to deploy validators to modules.
Expand Down Expand Up @@ -64,4 +64,4 @@ As Eigenlayer, AVSs, and Puffer’s anti-slashing mechanisms mature, proven NoOp

As an open platform, EigenLayer allows anyone to deploy an AVS. Thus, allowing PufferModules to service any AVS would expose the stakers and NoOps to too much slashing risk.

To mitigate this risk, Puffer requires the DAO to onboard new modules, carefully vet the allowed AVSs, and manage the allocation of modules to AVSs.
To mitigate this risk, Puffer requires the DAO to onboard new modules, carefully vet the allowed AVSs, and manage the allocation of modules to AVSs.
4 changes: 2 additions & 2 deletions docs/nlrt.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Fundamentally, an nLRT is an LST that delivers traditional PoS rewards and boost

nLRTs generate their restaking rewards through [native restaking](https://docs.eigenlayer.xyz/restaking-guides/restaking-user-guide/#liquid-vs-native-restaking) on Eigenlayer, where Ethereum PoS validator ETH is the staked asset. This sets them apart from Liquid Restaking Tokens (LRTs). An LRT tokenizes restaked LSTs within a Liquid Restaking Protocol (LRP). While the LRP yields rewards from restaking services, these are distinct from PoS rewards.

Although the core concept aligns with LSTs, LRTs focus solely on rewards from restaking services. At Puffer, we've observed that LRTs might intensify the [decentralization challenges](https://twitter.com/dannyryan/status/1688644951230267392?s=46&t=bsdBaPIHlTHEWDDdVUJW4g) associated with LSTs in Ethereum. In constrast, nLRTs actively promote decentralization, integrating new validators into PoS while also enhancing their profitability. Importantly, this is why Puffer has been dedicated to launching with a permissionless validator set from day one.
Although the core concept aligns with LSTs, LRTs focus solely on rewards from restaking services. At Puffer, we've observed that LRTs might intensify the [decentralization challenges](https://twitter.com/dannyryan/status/1688644951230267392?s=46&t=bsdBaPIHlTHEWDDdVUJW4g) associated with LSTs in Ethereum. In contrast, nLRTs actively promote decentralization, integrating new validators into PoS while also enhancing their profitability. Importantly, this is why Puffer has been dedicated to launching with a permissionless validator set from day one.

### pufETH

Expand Down Expand Up @@ -69,4 +69,4 @@ At the protocol’s inception, Bob stakes $10$ ETH and receives $10$ pufETH. The

Assuming Charlie decides to stake $1$ ETH, he would mint $\frac{1}{1.2} = 0.83$ pufETH due to the increased conversion rate. Since Charlie deposited instead of adding rewards, the conversion rate remains unchanged at $\frac{11 + 2 - 0}{10.83} = 1.2$ ETH per pufETH.

Bob can redeem his $10$ pufETH for $10*1.2=12$ ETH, given there is enough liquidity in the PufferVault and the daily withdrawal limit has not been reached.
Bob can redeem his $10$ pufETH for $10*1.2=12$ ETH, given there is enough liquidity in the PufferVault and the daily withdrawal limit has not been reached.
4 changes: 2 additions & 2 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The provisioning step will create a new validator within the EigenPod whose ETH

---
### 4️⃣ PoS Rewards
Once their validator activates, the NoOp is eligible to validate for as many days as validator tickets they have deposited. Throughout this duration, the NoOp keeps 100% of the generated PoS rewards. Their [execution rewards](/reference/glossary#execution-rewards) are immediately deposited to their wallets, while their [consensus rewards](/reference/glossary#consensus-rewards) accrue in the module's EigenPod and can be withdrawn following the NoOp withdrawal process.
Once their validator activates, the NoOp is eligible to validate for as many days as the validator tickets they have deposited. Throughout this duration, the NoOp keeps 100% of the generated PoS rewards. Their [execution rewards](/reference/glossary#execution-rewards) are immediately deposited to their wallets, while their [consensus rewards](/reference/glossary#consensus-rewards) accrue in the module's EigenPod and can be withdrawn following the NoOp withdrawal process.

Since NoOps receive 100% of the PoS rewards they generate, they are [incentivized](/protocol/validator-tickets#why--noop-incentives) to maximize their validator performance, helping protect staker ETH.

Expand All @@ -61,4 +61,4 @@ By participating in a restaking module, NoOps bear additional risks to their col

---
### ️6️⃣ Exiting Validators
When a NoOp wishes to exit the protocol, they must first ensure their associated validator has exited the beacon chain. Once they present verifiable proof of their validator's exit, the contract tallies any penalties related to inactivity or slashing that the validator might have incurred. The corresponding pufETH amount, equivalent to the ETH penalties, is burned from the NoOp's locked collateral and the remainder is returned to the NoOp. This process ensures that stakers are appropriately compensated for any potential ETH losses that might have occurred during the validator lifecycle. Additionally, any unused validator tickets will be returned to the NoOp.
When a NoOp wishes to exit the protocol, they must first ensure their associated validator has exited the beacon chain. Once they present verifiable proof of their validator's exit, the contract tallies any penalties related to inactivity or slashing that the validator might have incurred. The corresponding pufETH amount, equivalent to the ETH penalties, is burned from the NoOp's locked collateral and the remainder is returned to the NoOp. This process ensures that stakers are appropriately compensated for any potential ETH losses that might have occurred during the validator lifecycle. Additionally, any unused validator tickets will be returned to the NoOp.

0 comments on commit 22953b7

Please sign in to comment.