Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lagunovsky/raiko-sn
https://github.com/lagunovsky/raiko-sn
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/lagunovsky/raiko-sn
- Owner: lagunovsky
- License: apache-2.0
- Created: 2024-05-17T12:50:57.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T16:01:05.000Z (about 2 months ago)
- Last Synced: 2024-11-16T17:17:17.013Z (about 2 months ago)
- Language: Shell
- Size: 53.7 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple raiko node
This project includes a set of scripts and configurations to set up and manage a [Raiko][raiko] instance.
Prerequisites can be found in the [README_Docker_and_RA.md][raiko-readme-docker-and-ra].
Supports mainnet and holesky networks.
## Setup
#### 1. Subscribing to Intel PCS Service
To use ECDSA Attestation, you need to subscribe to the [Intel PCS service][intel-pcs-service], following the steps
in [Intel's how-to guide][intel-dcap-install-howto]. After subscribing to the service, you will receive two keys: a
primary API key and a secondary API key.
#### 2. Clone the repository
```bash
git clone https://github.com/lagunovsky/raiko-sn.git
```
#### 3. Run the setup script
```bash
cd simple-raiko-node
./manage setup
```
- You may have to log in again. If this happens, just run the command again.
- PCCS password can be left empty if you do not have one.
### Non-interactive setup
```bash
HISTIGNORE="manage setup" \
DEBIAN_FRONTEND=noninteractive \
INTEL_API_KEY= \
PRIVATE_KEY= \
./manage setup
```
Available variables
| Variable | Optional | Available Value | Default |
|-------------------------|----------|------------------------------|------------------------------------------------------------------|
| INTEL_API_KEY | No | | |
| PRIVATE_KEY | No | | |
| RAIKO_SN_RAIKO_IMAGE | Yes | | `raiko` |
| RAIKO_SN_PCCS_IMAGE | Yes | | `pccs` |
| RAIKO_SN_IMAGES_TAG | Yes | | `latest` |
| RAIKO_SN_RAIKO_PORT | Yes | | `8080` |
| SPECIFY_NETWORK | Yes | `Y` / `N` | `Y` |
| RAIKO_SN_L1_NETWORK | Yes | `holesky` / `ethereum` | `holesky` |
| RAIKO_SN_NETWORK | Yes | `taiko_a7` / `taiko_mainnet` | `taiko_a7` |
| RAIKO_SN_ETHEREUM_RPC | Yes | | |
| RAIKO_SN_ETHEREUM_BEACON_RPC | Yes | | |
| RAIKO_SN_HOLESKY_RPC | Yes | | |
| RAIKO_SN_HOLESKY_BEACON_RPC | Yes | | |
| RAIKO_SN_TAIKO_MAINNET_RPC | Yes | | |
| RAIKO_SN_TAIKO_A7_RPC | Yes | | |
| COLLECT_METRICS | Yes | `Y` / `N` | `Y` |
| RAIKO_SN_PROMETHEUS_PORT | Yes | | `9090` |
| RAIKO_SN_GRAFANA_PORT | Yes | | `3000` |
| REGISTER_AGAIN | Yes | `Y` / `N` | `N` |
| BUILD_AGAIN | Yes | `Y` / `N` | `N` |
| PULL_AGAIN | Yes | `Y` / `N` | `N` |
| L1_RPC | Yes | | `https://rpc.ankr.com/eth[_holesky]` (depends on RAIKO_SN_L1_NETWORK) |
| GAS_PRICE | Yes | | |
## Switching to simple-raiko-node
If Raiko is already installed by instructions from the [README_Docker_and_RA.md][raiko-readme-docker-and-ra], all you
need is to stop the running raiko instance by `docker compose down`.
## Available commands
- `./manage setup` - prepare, check, configure, and register in one command
- `./manage prepare` - install dependencies
- `./manage check` - check FMSPC
- `./manage configure` - generate configuration files (.env, certificates, etc.)
- `./manage register` - register your node onchain (can be used for re-registration)
- `./manage verify` - verify that your raiko instance is running properly
- `./manage reset` - removes all user data and restores the source code to its original state
[raiko]: https://github.com/taikoxyz/raiko
[raiko-readme-docker-and-ra]: https://github.com/taikoxyz/raiko/blob/main/docs/README_Docker_and_RA.md
[intel-dcap-install-howto]: https://www.intel.com/content/www/us/en/developer/articles/guide/intel-software-guard-extensions-data-center-attestation-primitives-quick-install-guide.html
[intel-pcs-service]: https://api.portal.trustedservices.intel.com/products#product=liv-intel-software-guard-extensions-provisioning-certification-service