Skip to content

Commit

Permalink
More documentation corrections (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
buffalu authored Aug 2, 2024
1 parent 773bb65 commit a4b2160
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/advanced/building_ncn.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Building an AVS
title: Building a Node Consensus Network (NCN)
---

These documents will be filled out shortly as the software is dogfooded internally.
2 changes: 1 addition & 1 deletion docs/advanced/building_vrt.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Building an LRT
title: Building a Vault Receipt Token (VRT)
---

These documents will be filled out shortly as the software is dogfooded internally.
Binary file modified docs/assets/staked_venn_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions docs/concepts/restaking_program.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,45 @@ title: Restaking Program

### About the program

The restaking program acts as a registry for AVS, operators, and relationships between AVS, operators, and vaults.
The restaking program acts as a registry for NCNs, operators, and relationships between NCNs, operators, and vaults.

It allows users to do the following:

- Registers AVS, operators, and their configurations.
- Stores relationships between AVS, operators, and vaults.
- Registers NCN, operators, and their configurations.
- Stores relationships between NCN, operators, and vaults.

The restaking program does not store any funds; it is purely used as a registry and relationship manager between
entities in the system.

### AVS
### Node Consensus Network (NCN)

AVS are services that provide infrastructure to the network, such as validators, oracles, keepers, bridges, L2s, and
NCN are services that provide infrastructure to the network, such as validators, oracles, keepers, bridges, L2s, and
other services that require a staking mechanism for security.

Actively Validated Services (AVS) can be registered through the restaking program.
NCN can be registered through the restaking program.

There are several things one can do after registering an AVS:
There are several things one can do after registering an NCN:

- Add and remove support for operators participating in the AVS validator set.
- Add and remove support for operators participating in the NCN operator set.
- Add and remove support for vaults
- Add and remove support for slashers
- Withdraw funds sent to the AVS from rewards, airdrops, and other sources.
- Withdraw funds sent to the NCN from rewards, airdrops, and other sources.

### Operator

Operators are entities responsible for running AVS software.
Operators are entities responsible for running NCN software.

Operators can register through the restaking program and configure several variables:

- Add and remove support for vaults
- Add and remove support for AVS
- Add and remove support for NCN
- Change voter keys
- Withdraw funds sent to the operator from rewards, airdrops, and other sources.

### Relationships

The Jito Restaking protocol requires mutual opt-in from all parties entering stake agreements: vaults, operators, and
AVS.
NCNs.

It leverages the concept of entity tickets, which are PDAs representing opt-in from one party to another. These tickets
are created on-chain and can be used to track relationships between AVS, operators, and vaults. In addition to entity
Expand Down
36 changes: 18 additions & 18 deletions docs/concepts/vault_program.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ title: Vault Program

## About the program

The vault program manages the liquid restaking tokens (LRTs) and associated deposits. The program stores deposited funds
and handles the minting and burning of tokenized stake.
The vault program manages the vault receipt tokens (VRTs) and associated deposits.
The program stores deposited funds and handles the minting and burning of tokenized stake.

The vault program allows users to do the following:

- Create LRTs (staked assets)
- Deposit assets and receive LRTs in return
- Burn LRTs to withdraw assets
- Create VRTs (staked assets)
- Deposit assets and receive VRTs in return
- Burn VRTs to withdraw assets
- Manage delegations to operators
- Handle slashing events

The vault program stores user funds and is responsible for the issuance and redemption of LRTs.
The vault program stores user funds and is responsible for the issuance and redemption of VRTs.
Funds do not leave the program under any conditions unless they are withdrawn by the user or a slashing takes place.

## Vault
Expand All @@ -26,23 +26,23 @@ Several operations can be performed with a vault:

- Initialize a new vault with specific parameters
- Add and remove support for operators
- Add and remove support for AVS
- Add and remove support for NCNs
- Manage delegations to operators
- Process deposits and withdrawals
- Handle slashing events

## LRT (Liquid Restaking Token)
## Vault receipt token (VRT)

LRTs represent a user's share in the vault's assets.
VRTs are a receipt token representing a user's pro-rata share of assets in the vault.
They are minted when users deposit and burned when users withdraw.

## Relationships

The vault program interacts with other entities in the Jito Restaking protocol:

- Operators: The vault delegates to operators and manages these relationships
- AVS: The vault interacts with AVS for slashing and other protocol-specific operations
- Users: Deposit assets and receive LRTs, or burn LRTs to withdraw assets
- NCN: The vault interacts with NCN for slashing and other protocol-specific operations
- Users: Deposit assets and receive VRTs, or burn VRTs to withdraw assets

The vault program uses similar ticket structures as the restaking program to manage these relationships, ensuring mutual
opt-in from all parties involved. Those tickets include:
Expand Down Expand Up @@ -119,7 +119,7 @@ The vault program handles slashing events, which may occur if an operator misbeh
- Processing slash instructions from authorized slashers
- Adjusting the vault's total assets and individual delegations
- Ensuring the integrity of the LRT exchange rate
- Respects the maximum slashing conditions set by the AVS
- Respects the maximum slashing conditions set by the NCN

## Tracking State

Expand All @@ -128,17 +128,17 @@ To reason about the state of stake at any given time, one can reference the char

Assets are considered staked iff:

- The AVS has opted-in to the operator
- The operator has opted-in to the AVS
- The NCN has opted-in to the operator
- The operator has opted-in to the NCN
- The operator has opted-in to the vault
- The vault has opted-in to the operator
- The vault has opted-in to the AVS
- The AVS has opted-in to the vault
- The vault has opted-in to the NCN
- The NCN has opted-in to the vault
- The Vault is delegated to that operator

When assets are staked and the following conditions are met, the vault can be slashed by a given slasher:

- The AVS has opted in to a slasher for the given vault.
- The vault has agreed to the conditions set by the AVS for slashing the vault.
- The NCN has opted in to a slasher for the given vault.
- The vault has agreed to the conditions set by the NCN for slashing the vault.

![img.png](../assets/staked_venn_diagram.png)

0 comments on commit a4b2160

Please sign in to comment.