mirror of
https://github.com/wmitsuda/one-liner-archive.git
synced 2026-01-10 06:17:59 -05:00
Add instructions, license
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 Willian Mitsuda
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# What's this?
|
||||
|
||||
Do you want to run an archive node + block explorer in your machine using only 1 command and (_almost_) no devops knowledge?
|
||||
|
||||
This repo provides a series of pre-configured docker-compose files that spin-up a Prysm (consensus layer client) + Erigon (execution layer archive node; alpha series) + Otterscan (block explorer).
|
||||
|
||||
Just follow the instructions, fill in the gaps and run it. Or customize it for your needs. Or improve it and contribute it back, it's all opensource.
|
||||
|
||||
> The twitter 🧵 that originated this project: https://twitter.com/wmitsuda/status/1535148383555530757
|
||||
|
||||
# Run it
|
||||
|
||||
## Post-merge ropsten
|
||||
|
||||
1. Clone this repo
|
||||
2. Create empty dirs for erigon (`<erigon-data-dir>`) and prysm (`<prysm-data-dir>`) databases
|
||||
3. Run: `PRYSM_DATA="<prysm-data-dir>" ERIGON_DATA="<erigon-data-dir>" docker-compose -f ropsten.yml up`
|
||||
4. Wait 1-2 days until the archive node finishes syncing ropsten
|
||||
5. You should be able to access Otterscan block explorer to browse your archive by accessing: http://localhost:3000/
|
||||
|
||||
> Remember that ropsten is deprecated and will have no more upgrades after the merge
|
||||
|
||||
## Sepolia
|
||||
|
||||
1. Clone this repo
|
||||
2. Create an empty dir for erigon (`<erigon-data-dir>`) database
|
||||
3. Run: `ERIGON_DATA="<erigon-data-dir>" docker-compose -f sepolia.yml up`
|
||||
4. Wait a few hours until the archive node finishes syncing sepolia
|
||||
5. You should be able to access Otterscan block explorer to browse your archive by accessing: http://localhost:3000/
|
||||
|
||||
> This script will be updated soon as clients gets updated to the upcoming sepolia merge
|
||||
Reference in New Issue
Block a user