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.

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

Add doc improvements #2

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
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: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
# You can swap them out with your user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com

Expand All @@ -50,4 +50,4 @@ jobs:
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CICD_WEBHOOK }} # required



4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Solayer is building the restaking network natively on Solana. 

Solana serves as the internet layer, facilitating the seamless movement of data, trust, and money. Solayer leverages Solana’s economic security and superior execution capabilities as decentralized cloud infrastructure, enabling application developers to achieve a higher degree of consensus and blockspace customization.
Solana serves as the internet layer, facilitating the seamless movement of data, trust, and money. Solayer leverages Solana’s economic security and superior execution capabilities as a decentralized cloud infrastructure, enabling application developers to achieve a higher degree of consensus and block space customization.

To realize this, Solayer is a two-pronged approach: 
To realize this, Solayer uses a two-pronged approach: 

1. **Restaking**: ‌leverage the economic security of SOL to secure other systems.
2. **Shared Validator Network**: Solana-centric networks sharing Solana security and infrastructure.
2 changes: 1 addition & 1 deletion community/restaking-epochs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ layout:

# Restaking Epochs

The **Solayer Restaking Epochs are** designed to ensure the safety and security of our protocol developments while optimizing for the best user experience. Through these carefully managed phases we provide a secure and efficient environment for participants, facilitating smooth interactions and maximizing benefits. These epochs have already seen significant engagement, with millions in restaked deposits, demonstrating the robust interest and trust in our platform.
The **Solayer Restaking Epochs are** designed to ensure the safety and security of our protocol developments while optimizing for the best user experience. Through these carefully managed phases, we provide a secure and efficient environment for participants, facilitating smooth interactions and maximizing benefits. These epochs have already seen significant engagement, with millions in restaked deposits, demonstrating the robust interest and trust in our platform.

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

Expand Down
4 changes: 2 additions & 2 deletions community/restaking-epochs/epoch-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It is a 24-hour private access period, during which only members of the communit

1. We have allocated 100 private access codes to our earliest supporters.
2. Once an address is invited, it will receive two additional invite codes to share.
3. This program is limited to a 24-hour duration and with a maximum cap on of $20M deposit total value locked (TVL).
3. This program is limited to a 24-hour duration and with a maximum cap of $20M deposit total value locked (TVL).
4. Every invitee after accessing the platform will have 5 more invite codes to pass out.&#x20;

***
Expand All @@ -18,4 +18,4 @@ It is a 24-hour private access period, during which only members of the communit
3. Follow us on socials&#x20;
4. Enter invite code&#x20;
5. Restake&#x20;
6. Get your own invite code to invite 5 more friends&#x20;
6. Get your invite code to invite 5 more friends&#x20;
2 changes: 1 addition & 1 deletion community/restaking-epochs/epoch-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Epoch 1 of the Solayer launch continued the momentum built during Epoch 0, opening the doors to a broader audience and increasing the opportunities for participation.

Started on May 27th, Epoch 1 had a total value locked (TVL) cap of $50 million. This stage saw a significant increase in total depositors, reaching over 9,000 from Epoch 0 to the end of Epoch1. As of 15.06.2024, there are about $50 million locked.&#x20;
Starting on May 27th, Epoch 1 had a total value locked (TVL) cap of $50 million. This stage saw a significant increase in total depositors, reaching over 9,000 from Epoch 0 to the end of Epoch1. As of 15.06.2024, there are about $50 million locked.&#x20;

Unlike Epoch 0, there was no time limit imposed on Epoch 1, allowing participants ample time to engage with the restaking pool. However, native SOL deposits were prioritized to ensure the stability and growth of the platform. Withdrawals will be enabled starting at Epoch 3, providing participants with flexibility in managing their investments.

Expand Down
4 changes: 2 additions & 2 deletions community/solayer-valley-episodes/rewards-claiming-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rewards Claiming Guide

1. **If eligible, you will be able to enter the Valley in order to claim your rewards.**&#x20;
1. **If eligible, you will be able to enter the Valley to claim your rewards.**&#x20;

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

Expand All @@ -15,7 +15,7 @@

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

5. **Claim your Rewards (4/4):** get a mystery box that will be revealed after Episode 1.
5. **Claim your Rewards (4/4):** Get a mystery box that will be revealed after Episode 1.

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Unstaking Credit Deduction

The credit deduction mechanism is designed to manage the rewards earned through staked SOL, ensuring fair distribution and reward long term community members. Here's a detailed explanation of how it works.
The credit deduction mechanism is designed to manage the rewards earned through staked SOL, ensuring fair distribution and rewarding long-term community members. Here's a detailed explanation of how it works.

## Accounting Deduction

Expand Down Expand Up @@ -38,7 +38,7 @@ So, if you generated 1000 credits on the 10 SOL deposited, 50 credits will be de
* **Credits Earned:** 300 credits (assuming a mix of native SOL and LSTs, with appropriate multipliers)
* **Deduction: (10 / 50 \* 300) \* 0.5 = 30 credits**

In this case, if you generated 300 creditson the 10 SOL deposited, 30 credits will be deducted, leaving you with 270 credits.
In this case, if you generated 300 credits on the 10 SOL deposited, 30 credits will be deducted, leaving you with 270 credits.

### _**Example 3: Withdrawing 50% of Staked SOL**_

Expand Down
4 changes: 2 additions & 2 deletions developers-guides/for-builders/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

The restaking pool manager oversees the flow of assets into the protocol. When users deposit LST or SOL (which is first converted to sSOL-raw), they receive a fungible token representation in return. Collectively, we call them Solayer assets. Currently illiquid to facilitate points calculation for the liquidity reward program, this representation will become liquid in the future to encourage composability with DeFi.

Solayer assets at this layer won't have any unbonding lockups since they unwrap into the respective LSTs. The AVS unbonding process is separately managed by the delegation manager. To offer more flexibility, Solayer allows them to design their own unbonding process with a maximum unbonding period within 2 days. Solayer will also provide an emergency exit mechanism to release the bound stake from users should the AVS cease to function.
Solayer assets at this layer won't have any unbinding lockups since they unwrap into the respective LSTs. The AVS unbinding process is separately managed by the delegation manager. To offer more flexibility, Solayer allows them to design their unbinding process with a maximum unbinding period of 2 days. Solayer will also provide an emergency exit mechanism to release the bound stake from users should the AVS cease to function.

Stage 2 of our protocol development will enable users to pledge their Solayer assets to secure additional networks by delegating them to a Solayer operator responsible for managing the AVS nodes. Should an operator engage in malicious behavior, they will be subject to penalties, potentially resulting in a loss of the user's deposit. Consequently, users must exercise caution when selecting operators to delegate to, ensuring that they possess a trustworthy track record and fulfill the requisite criteria of the AVS.

Once delegation to SVNs and node operators is live, users will construct their restaking portfolio by selecting the node operators to delegate to and SVNs to secure. They will then be issued a non-fungible token. This token is non-fungible due to the idiosyncratic risks associated with the selected node operators and the SVNs.

Rewards accounting is calculated offline. Solayer has implemented a state watcher to keep track of deposits and withdrawals. Together with the invite relationship data, additional rewards will be applied to user accounts in real-time.
Rewards accounting is calculated offline. Solayer has implemented a state watcher to keep track of deposits and withdrawals. Together with the invite relationship data, additional rewards will be applied to user accounts in real time.

The Restake method on Solayer is permissioned and requires an additional signature from the server. This is to allow us to enforce deposit limits in the first few epochs. The Unstake method does not require an additional signature from Solayer.
4 changes: 2 additions & 2 deletions developers-guides/security/multisig-committee.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Solayer contract is inherently upgradable for several reasons. Firstly, stag

**Program**: sSo1iU21jBrU9VaJ8PJib1MtorefUV4fzC9GURa2KNn

The upgradability of the Solayer contract is overseen by trusted community leaders. Initially, we have selected 3 out of the 5 multisig seat holders, with one seat occupied by the Solayer core team. To maintain our commitment to transparency and a community-first approach, we will gather community feedback to appoint 1 more community member to the governing seat. Candidates will be evaluated diligently following a public forum, and more information will be released soon.
The upgradability of the Solayer contract is overseen by trusted community leaders. Initially, we selected 3 out of the 5 multisig seat holders, with one seat occupied by the Solayer core team. To maintain our commitment to transparency and a community-first approach, we will gather community feedback to appoint 1 more community member to the governing seat. Candidates will be evaluated diligently following a public forum, and more information will be released soon.

This multisig controls protocol-code upgrades. To modify our program, the multisig must have a 3 out of 5 quorum signing to approve any upgrade. Solayer core team may conduct a forum to discuss potential increase or decrease of seat holders and quorum threshold. This is to ensure no one can act maliciously and can be immediately stopped by others.&#x20;
This multisig controls protocol-code upgrades. To modify our program, the multisig must have a 3 out of 5 quorum signing to approve any upgrade. Solayer core team may conduct a forum to discuss potential increases or decreases of seat holders and quorum threshold. This is to ensure no one can act maliciously and can be immediately stopped by others.&#x20;

**Below are the first 3 community seat holders, out of 5 in total.**

Expand Down
4 changes: 2 additions & 2 deletions docs/Overview/additional-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ description: Hear about some useful features that are typically included in a re

### Liquid staking tokens

Liquid staking services are a wildly popular way for users who would like to stake their assets to receive a liquid token in exchange while their assets remain locked. These applications often serve an additional purpose as a way for users who don't have the minimum capital required to stake and become a validator to instead pool their capital with others to reach the minimum stake, and often also delegate operation of the validator software to a third party. Solayer, in addition to supporting users who provide native SOL for staking and restaking, supports the restaking of several liquid staking tokens linked to already-staked SOL. As of now, the supported liquid staking tokens are JitoSOL, mSOL, and bSOL.
Liquid staking services are a wildly popular way for users who would like to stake their assets to receive a liquid token in exchange while their assets remain locked. These applications often serve an additional purpose as a way for users who don't have the minimum capital required to stake and become a validator to instead pool their capital with others to reach the minimum stake, and often also delegate the operation of the validator software to a third party. Solayer, in addition to supporting users who provide native SOL for staking and restaking, supports the restaking of several liquid staking tokens linked to already-staked SOL. As of now, the supported liquid staking tokens are JitoSOL, mSOL, and bSOL.

### Delegated AVS operation

Running software to validate a variety of AVS protocols is a task that is best left for sophisticated users who are capable of running the software efficiently and reducing the risk of service distruption. Users simply looking to receive rewards for committing their assets to be restaked may not be sufficiently sophisticated operators of AVS software to operate it safely. Or, users might simply prefer to avoid the inconvenience of running AVS software themselves.
Running software to validate a variety of AVS protocols is a task that is best left to sophisticated users who are capable of running the software efficiently and reducing the risk of service disruption. Users simply looking to receive rewards for committing their assets to be restaked may not be sufficiently sophisticated operators of AVS software to operate it safely. Or, users might simply prefer to avoid the inconvenience of running AVS software themselves.

In any case, it is possible for users restaking their assets to delegate the operation of AVS software to a sophisticated entity willing to operate the AVS software on their behalf.

Expand Down
10 changes: 5 additions & 5 deletions docs/Overview/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ description: Get up to speed on what restaking is about

There exists a design space of distributed applications that require active validation of their rules in ways that cannot be sufficiently implemented using smart contracts on programmable blockchains. These are services like data availability systems, oracle networks, cross-chain bridges, and more. This kind of distributed application is commonly referred to as an *actively validated service*, or AVS, a term coined by the EigenLayer team.

AVSs face several major challenges to the security of their protocols. For instance, each must bootstrap an independent network of protocol participants and incentivize honest behavior. Often this involves the creation of a digital asset native to the AVS network or heavy permissioning, both approaches having a myriad of challenges on their own. In cases where several AVSs are secured by their own native assets, they do not share their security. This means that this approach to distributed applications results in weaker, more fragmented economic security than the traditional approach of smart contracts running on one blockchain network.
AVSs face several major challenges to the security of their protocols. For instance, each must bootstrap an independent network of protocol participants and incentivize honest behavior. Often this involves the creation of a digital asset native to the AVS network or heavy permissioning, both approaches have a myriad of challenges on their own. In cases where several AVSs are secured by their native assets, they do not share their security. This means that this approach to distributed applications results in weaker, more fragmented economic security than the traditional approach of smart contracts running on one blockchain network.

Restaking is a mechanism which offers solutions to these problems, enabling AVSs to share economic security and collectively leverage the security of established proof-of-stake networks.
Restaking is a mechanism that offers solutions to these problems, enabling AVSs to share economic security and collectively leverage the security of established proof-of-stake networks.

### What is restaking?

On decentralized blockchain networks secured by proof-of-stake, such as Ethereum and Solana, participants have the ability to *stake* some of their assets into the network. In exchange, they receive the opportunity to validate that the activity on the network behaves according to some set of rules that comprise the network's protocol. If one of these validators attempts to declare spurious activity as genuine, other validators can destroy the dishonest validator's staked assets. Validators are rewarded with more digital assets by the protocol for their contribution to the security of the network.
On decentralized blockchain networks secured by proof-of-stake, such as Ethereum and Solana, participants can *stake* some of their assets into the network. In exchange, they receive the opportunity to validate that the activity on the network behaves according to some set of rules that comprise the network's protocol. If one of these validators attempts to declare spurious activity as genuine, other validators can destroy the dishonest validator's staked assets. Validators are rewarded with more digital assets by the protocol for their contribution to the security of the network.

On some of these proof-of-stake networks, validators can use an application-layer *restaking* system to opt-in to validate activity against additional sets of rules that define additional protocols. These protocols can provide validators with more rewards than they would otherwise earn by solely validating for the network's base protocol. If validators break the additional rules they agreed to, other participants in the restaking system can destroy their restaked assets.

Constructing an AVS as a protocol secured by a restaking system sidesteps many of the hurdles it might face, as outlined in the previous section. This reduces the barriers to entry for new AVSs, creating the conditions for exiciting innovation to happen.
Constructing an AVS as a protocol secured by a restaking system sidesteps many of the hurdles it might face, as outlined in the previous section. This reduces the barriers to entry for new AVSs, creating the conditions for exciting innovation to happen.

### Why restake on Solana?

AVSs built on top of the security of restaked Solana receive a great deal of indirect benefit from Solana's high throughput and cheap blockspace. When these services need to signal or settle anything on-chain, they can do so quickly and cheaply. This opens up greater possibilities for the kinds of services that can be built when compared against similar restaking solutions built on less performant networks like Ethereum.
AVSs built on top of the security of restaked Solana receive plenty of indirect benefits from Solana's high throughput and cheap block space. When these services need to signal or settle anything on-chain, they can do so quickly and cheaply. This opens up greater possibilities for the kinds of services that can be built when compared against similar restaking solutions built on less performant networks like Ethereum.
Loading