Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RohitAudit/ssv-service
You can use this to repo to act as backend of your ssv staking solution
https://github.com/RohitAudit/ssv-service
Last synced: about 1 month ago
JSON representation
You can use this to repo to act as backend of your ssv staking solution
- Host: GitHub
- URL: https://github.com/RohitAudit/ssv-service
- Owner: RohitAudit
- License: mit
- Created: 2022-10-08T11:59:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T10:08:49.000Z (over 1 year ago)
- Last Synced: 2024-06-09T01:36:07.234Z (3 months ago)
- Language: Python
- Size: 44.9 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssv-service (GARUDA)
You can use this to repo to act as backend of your ssv staking solution
### External Libraries used
- [SSV-KEYS](https://github.com/bloxapp/ssv-keys.git) : Used to split ethereum validator keys.
- [Ethereum-staking-cli](https://github.com/ethereum/staking-deposit-cli.git) : Used to generate ethereum validators keys
### Demo Contracts on Goerli
- Staking Pool Contract: [0x0B3382A006DD7F03ED1333c6C7472857fFFB6778](https://goerli.etherscan.io/address/0x0B3382A006DD7F03ED1333c6C7472857fFFB6778#code)
- Keys-manager Contract: [0x2b54244C61346DcD14CB77f8642CeA941Aa82664](https://goerli.etherscan.io/address/0x2b54244C61346DcD14CB77f8642CeA941Aa82664#code)
- RoETH Contract: [0xCe24cc06357Ee4960f802D8D44004F2cb84D4d4c](https://goerli.etherscan.io/address/0xCe24cc06357Ee4960f802D8D44004F2cb84D4d4c#code)
- Common Contract: [0xCe24cc06357Ee4960f802D8D44004F2cb84D4d4c](https://goerli.etherscan.io/address/0xCe24cc06357Ee4960f802D8D44004F2cb84D4d4c#code)
### How it works?
#### User Actions
- User stakes their eth to a staking contract through which he is given a liquid staked derivative token called roETH.
- That's it!! User can just relax and wait for their roETH to compound over time and till then use the same tokens in other DeFi protocols
#### Protocol
- The backend of garuda keeps a close eye on stakingpool contract.
- As soon as the balance reaches 32 eth, it triggers few actions:
- Creates a ethereum validator key and gives it to stakingpool for depositing for activation
- Generates keyshares from the validator keystore and stakes them the SSV nodes
- Saves the keystore and keyshares for verification at a later stage
- Garuda also keeps eye on the SSV balance of stakingpool contract. If its less than the amount needed to register keys shares it will transfer some from your whitelist account.
### How to deploy the system?
#### deploying smart contracts
- make the script executable
```
chmod +x setup.sh
```
- run the script, it'll install all dependencies.
```
./setup.sh
```
- In the scripts/deploy.js change the following:
- withdrawal credential you want for your validators
- operator-ids with your operators
- whitelist address to make tx to staking pool and keysmanager
- Go to demo contract folder and run the script for deployment
```
npx hardhat run scripts/deploy.js --network goerli
```
The contract addresses will be logged on console. You can use them while running the backend
```
NOTE: If you are deloying the system on Local you'll need to deploy Deposit Contract for validator activation for Ethereum and SSV contracts to interact
```
#### Using the scripts
- For options use
```
python main.py -h
```
- There are two options
- stake: use this to start the backend service for the staking pool
- create-keys: use this to create validator keys and key-shares for operators separately
- To deploy the backend for staking pool install requirements for python
```
pip install -r requirements.txt
```
- Following arguments are needed to run the script
- PRIVATE_KEY(-priv): private key for the whitelisted address in the contracts to do the transaction
- STAKING_POOL(-st): staking pool contract address
- SSV_CONTRACT(-ssv): ssv network contract address
- SSV_TOKEN(-token): ssv token contract address
- ETH_RPC(-eth): rpc endpoint for ethereum node
```
python main.py stake -eth -priv -st -token -ssv
```
**NOTE: The private key you are giving should have SSV token and Eth to make transactions**
- To create keys
- OPERATOR_IDS: operator ids for keyshares
- KEY_COUNT: no. of validator keys to create
- WITHDRAWAL_CREDENTIALS: withdrawal credentials for validator keys
- KEYSTORE_PASSWORD: keystore password for validator keys
```
python main.py create-keys -id -n -wc -pass
```
### LICENSE
MIT License