codex-storage/codex-testnet-starter
1
0
Fork 0
mirror of https://github.com/codex-storage/codex-testnet-starter.git synced 2025-02-22 15:18:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'workshop-scripts'

Browse Source
This commit is contained in:
Ben 2024-06-24 15:19:48 +02:00
commit a91f808875
No known key found for this signature in database
GPG Key ID: 541B9D8C9F1426A1
18 changed files with 219 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
README.md
View File

@ -1,19 +1,6 @@
# Codex Testnet Starter
Hit the ground running with Codex.
1. [Overview](#overview)
2. [How to start](#how-to-start)
3. [How to get ready](#how-to-get-ready)
4. [How to use](#how-to-use)
5. [How to stop](#how-to-stop)
6. [How to stop and delete everything](#how-to-stop-and-delete-everything)
7. [Troubleshooting](#troubleshooting)
## [Overview](#codex-testnet-starter)
![Overview](/docs/overview.png)
Using the Testnet Starter, you can run a (mostly preconfigured) Codex node on your machine. You always have the option to build and run Codex from sources [Here](https://github.com/codex-storage/nim-codex/).
### Links
- Codex Website - [codex.storage](https://codex.storage)
- Codex Whitepaper - [codex.storage](https://codex.storage)
@ -22,183 +9,3 @@ Using the Testnet Starter, you can run a (mostly preconfigured) Codex node on yo
- Block explorer - [explorer.testnet.codex.storage](https://explorer.testnet.codex.storage)
- Web wallet - [wallet.testnet.codex.storage](https://wallet.testnet.codex.storage)
## [How to start](#codex-testnet-starter)
1. [Have Docker with compose installed](https://docs.docker.com/engine/install/)
2. Clone this repo
```shell
git clone https://github.com/codex-storage/codex-testnet-starter && cd codex-testnet-starter
```
3. Create an Ethereum public/private key pair using [web wallet](https://wallet.testnet.codex.storage) or consider other local methods
<details>
<summary>Use Docker</summary>
```shell
# Generate keypair
docker run --rm gochain/web3 account create
```
</details>
<details>
<summary>Use MetaMask</summary>
1. [Accounts and Addresses](https://support.metamask.io/hc/en-us/sections/4471975962907-Accounts-and-Addresses)
2. [How to export an account's private key](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key)
</details>
<details>
<summary>Use Python code</summary>
1. Create a venv
```shell
pip3 install virtualenv
venv=codex-eth-key
mkdir $venv && cd $venv
python3 -m venv env
source env/bin/activate
```
2. Install required packages
```shell
pip3 install web3
```
3. Create a script
```shell
vi eth-keys.py
```
```python
from eth_account import Account
def generate_ethereum_keypair():
# Generate a new Ethereum account
account = Account.create()
# Get the private key
private_key = account._private_key.hex()
# Get the public key (Ethereum address)
public_key = account.address
return private_key, public_key
# Generate the Ethereum key pair
private_key, public_key = generate_ethereum_keypair()
# Print the keys
print("Private Key:", private_key)
print("Public Key (Ethereum Address):", public_key)
```
4. Generate the keys
```shell
python3 eth-keys.py
```
5. Cleanup
```shell
deactivate
cd .. && rm -rf $venv
```
</details>
```
# Example
Private key: 0xacec4df7549199708a9f66b151aea7bf41b4d30bd325b96b26f017246226e1a3
Public address: 0x1C408C8572ce7d5E79a3a6D353e5FC2E8E2c49ce
```
4. Define variables
```shell
export PRIV_KEY=0xacec4df7549199708a9f66b151aea7bf41b4d30bd325b96b26f017246226e1a3
export CODEX_LISTEN_ADDRS=/ip4/0.0.0.0/tcp/8070
export CODEX_DISC_PORT=8090
# export CODEX_ETH_PROVIDER=https://rpc.testnet.codex.storage
# export CODEX_LOG_LEVEL=TRACE
#
# export GETH_DISCOVERY_PORT=8547
# export GETH_PORT=8548
# export GETH_NAT=extip:1.1.1.1
# export GETH_VERBOSITY=3
```
5. Run local nodes
```shell
docker-compose up -d
```
6. Setup port forwarding on your router for Codex, based on defined values
```
TCP - CODEX_LISTEN_ADDRS=/ip4/0.0.0.0/tcp/8070
UDP - CODEX_DISC_PORT=8090
```
## [How to get ready](#codex-testnet-starter)
When starting the Testnet Starter for the first time, (or restarting after a long pause) please keep in mind:
- Your local Geth node will need time to sync.
- Geth checker will wait until Geth is in sync and only then Codex will start.
Before you can use the marketplace functionality of Codex, you will need to obtain some tokens in the Testnet.
1. Use web faucets
- ETH - [faucet-eth.testnet.codex.storage](https://faucet-eth.testnet.codex.storage)
- TST - [faucet-tst.testnet.codex.storage](https://faucet-tst.testnet.codex.storage/)
2. Or join the [Codex Discord server](https://discord.gg/codex-storage)
<details>
<summary>Get tokens on Discord server faucet</summary>
1. Find the `#bot` channel.
2. Give your public key to the bot using `set` command.
<details>
<summary>example</summary>
![Bot-Set](/docs/bot-set.png)
</details>
3. Ask it politely to mint some tokens for you using `mint` command.
<details>
<summary>example</summary>
![Bot-Mint](/docs/bot-mint.png)
</details>
(It may or may not happen in the future that testnet participation will be rewarded automatically with Discord server roles.)
</details>
## [How to use](#codex-testnet-starter)
Once running, Codex exposes a web-api at the API port. (default: 8080)
To read more about how to use the API, go [Here](/USINGCODEX.md)
## [How to stop](#codex-testnet-starter)
- `docker-compose down`
## [How to stop and delete everything](#codex-testnet-starter)
- `docker-compose down --rmi all -v`
## [Troubleshooting](#codex-testnet-starter)
### Geth
```shell
# List peers
docker exec -it geth geth attach --exec net.peerCount /data/geth.ipc
# Connected peers
docker exec -it geth geth attach --exec admin.peers /data/geth.ipc
# Add a peer
docker exec -it geth geth attach --exec 'admin.addPeer("enode://cff0c44c62ecd6e00d72131f336bb4e4968f2c1c1abeca7d4be2d35f818608b6d8688b6b65a18f1d57796eaca32fd9d08f15908a88afe18c1748997235ea6fe7@159.223.243.50:40010")' /data/geth.ipc
# Sync status
docker exec -it geth geth attach --exec eth.syncing /data/geth.ipc
# Geth own enode
docker exec -it geth geth attach --exec admin.nodeInfo.enode /data/geth.ipc
```

51
WORKSHOPSETUP.mb Normal file
View File

@ -0,0 +1,51 @@
# Workshop Setup
With these instructions you can set up a Codex node on your machine, to use during the Brussels 2024 workshop. If you run into trouble and need help, ask a nearby Codexer!
## Local network
Switch to the workshop wifi:
- SSID: `codex`
- Password: `ethcc2024`
## Clone this repository
```
git clone https://github.com/codex-storage/codex-testnet-starter.git
```
Open a terminal in the scripts folder for your platform:
- `scripts/linux`
- `scripts/mac`
- `scripts/windows`
## Download Codex
Run `download` script.
## Generate an Eth key-pair
Run `generate` script.
Keep your public key at hand. Update the file named `eth.key` with your private key. You may need to change the permissions for this file. See the README.md in your platform specific folder.
## Start Codex node
Determine your local IP address. Use `ifconfig` or `ipconfig`, depending on your platform.
Set local IP environment variable
- Bash: `export LOCALIP="192.168.179.999"`
- Batch: `set LOCALIP="192.168.179.999"`
Run `run_client` script.
## Acquire tokens
You can acquire tokens in one of two ways: Discord bot or faucet.
### Discord bot
- Join the Codex discord server: https://discord.gg/codex-storage.
- Go to the "bot" channel, in the category "codex-bot".
- Use `/set` command to enter your public key.
- Use `/mint` command to receive some tokens.
### Faucet
- Follow instructions on https://faucet-eth.testnet.codex.storage to get some Eth.
- Follow instructions on https://faucet-tst.testnet.codex.storage to get some test tokens.
You will need both Eth and test tokens to use Codex.
## Use Codex
You can now proceed to use your Codex node. Follow the instructions [here](./USINGCODEX.md)

6
scripts/linux/README.md Normal file
View File

@ -0,0 +1,6 @@
# Permissions
To fix the permissions of your eth.key file:
`chmod 600 eth.key`
# Additional requirements for prover
`sudo apt-get install libzip-dev unzip`

5
scripts/linux/download.sh Executable file
View File

@ -0,0 +1,5 @@
curl -o codex-v0.1.0-linux-amd64.tar.gz -L https://github.com/codex-storage/nim-codex/releases/download/v0.1.0/codex-v0.1.0-linux-amd64.tar.gz
tar -xvzf codex-v0.1.0-linux-amd64.tar.gz
chmod +x codex-v0.1.0-linux-amd64

5
scripts/linux/download_prover.sh Executable file
View File

@ -0,0 +1,5 @@
curl -o codex-prover-v0.1.0-linux-amd64.zip -L https://github.com/codex-storage/nim-codex/releases/download/v0.1.0/codex-prover-v0.1.0-linux-amd64.zip
unzip codex-prover-v0.1.0-linux-amd64.zip
chmod +x codex-v0.1.0-prover-linux-amd64

1
scripts/linux/eth.key Normal file
View File

@ -0,0 +1 @@
0x292db809944ca4f5ca818066c85c30c9eaee3c6871ba49259f6d4bc9ba1786a6

1
scripts/linux/generate.sh Executable file
View File

@ -0,0 +1 @@
curl -sX POST https://api.blockcypher.com/v1/eth/main/addrs

14
scripts/linux/run_bootstrap.sh Executable file
View File

@ -0,0 +1,14 @@
LOCALIP="192.168.178.138"
./codex-v0.1.0-linux-amd64 \
--data-dir=data_bootstrap \
--nat=${LOCALIP} \
--api-port=8080 \
--disc-port=8090 \
--listen-addrs=/ip4/0.0.0.0/tcp/8070 \
&
sleep 5
curl http://localhost:8080/api/codex/v1/debug/info > bootstrap.info

20
scripts/linux/run_client.sh Executable file
View File

@ -0,0 +1,20 @@
LOCALIP=192.168.178.138
BOOTSPR=spr:CiUIAhIhAteA6IVIcN3egB_1rPz3HpFKVVO4emfRRcRzvyf0ES11EgIDARo8CicAJQgCEiEC14DohUhw3d6AH_Ws_PcekUpVU7h6Z9FFxHO_J_QRLXUQlcfKswYaCwoJBMCosquRAh-aKkcwRQIhAPzHOsoFmh96SeuFPzErNeck9C-vOkWp74HpddLmM4zLAiBwvbCZDaeMRkmVRVxh24J8OEGGuHFUTWPHAL8T7e8GyQ
./codex-v0.1.0-linux-amd64 \
--data-dir=data_client \
--storage-quota=11811160064 \
--nat=${LOCALIP} \
--api-port=8080 \
--disc-port=8090 \
--listen-addrs=/ip4/0.0.0.0/tcp/8070 \
--bootstrap-node=${BOOTSPR} \
persistence \
--eth-private-key=eth.key \
--eth-provider=https://rpc.testnet.codex.storage \
--marketplace-address=0x9C88D67c7C745D2F0A4E411c18A6a22c15b37EaA \
&
sleep 5
curl http://localhost:8180/api/codex/v1/debug/info

31
scripts/linux/run_host.sh Executable file
View File

@ -0,0 +1,31 @@
LOCALIP=192.168.178.138
BOOTSPR=$(curl http://localhost:8080/api/codex/v1/spr | cut -d '"' -f4)
# Quota = 11 GB
# Availability = 10 GB
./codex-v0.1.0-prover-linux-amd64 \
--data-dir=data_host \
--circuit-dir=circuit \
--storage-quota=11811160064 \
--nat=${LOCALIP} \
--api-port=8180 \
--disc-port=8190 \
--listen-addrs=/ip4/0.0.0.0/tcp/8170 \
--bootstrap-node=${BOOTSPR} \
persistence \
--eth-private-key=eth.key \
--eth-provider=https://rpc.testnet.codex.storage \
--marketplace-address=0x9C88D67c7C745D2F0A4E411c18A6a22c15b37EaA \
prover \
&
sleep 30
curl http://localhost:8180/api/codex/v1/debug/info
sleep 5
curl --request POST --url http://localhost:8180/api/codex/v1/sales/availability --header "Content-Type: application/json" --data "{\"totalSize\": \"10737418240\", \"duration\": \"86400\", \"minPrice\": \"1\", \"maxCollateral\": \"9999999999\"}"

14
scripts/windows/README.md Normal file
View File

@ -0,0 +1,14 @@
# Permissions
To fix the permissions of your eth.key file in Windows:
- Right-click 'eth.key' file
- Properties
- Security
- Advanced
- Add -> Select a principal -> Advanced -> Find now
- Select you user from the list
- OK -> OK
- Check: "Full control", "Modify", "Read&exe", "Read", "Write"
- OK
- Disable inheritance -> Confirm warning
- Apply and close
- Apply and close

2
scripts/windows/download.bat Normal file
View File

@ -0,0 +1,2 @@
curl -O -L https://github.com/codex-storage/nim-codex/releases/download/v0.1.0/codex-v0.1.0-windows-amd64.zip
unzip codex-v0.1.0-windows-amd64.zip

2
scripts/windows/download_prover.bat Normal file
View File

@ -0,0 +1,2 @@
curl -O -L https://github.com/codex-storage/nim-codex/releases/download/v0.1.0/codex-prover-v0.1.0-windows-amd64.exe.zip
unzip codex-prover-v0.1.0-windows-amd64.exe.zip

1
scripts/windows/eth.key Normal file
View File

@ -0,0 +1 @@
0x292db809944ca4f5ca818066c85c30c9eaee3c6871ba49259f6d4bc9ba1786a6

1
scripts/windows/generate.bat Normal file
View File

@ -0,0 +1 @@
curl -sX POST https://api.blockcypher.com/v1/eth/main/addrs

14
scripts/windows/run_bootstrap.bat Normal file
View File

@ -0,0 +1,14 @@
set LOCALIP="192.168.178.138"
start /b codex-v0.1.0-windows-amd64.exe ^
--data-dir=data_bootstrap ^
--nat=%LOCALIP% ^
--api-port=8080 ^
--disc-port=8090 ^
--listen-addrs=/ip4/0.0.0.0/tcp/8070
timeout 5
cls
curl http://localhost:8080/api/codex/v1/debug/info

21
scripts/windows/run_client.bat Normal file
View File

@ -0,0 +1,21 @@
set LOCALIP="192.168.178.138"
set BOOTSPR="spr:CiUIAhIhAteA6IVIcN3egB_1rPz3HpFKVVO4emfRRcRzvyf0ES11EgIDARo8CicAJQgCEiEC14DohUhw3d6AH_Ws_PcekUpVU7h6Z9FFxHO_J_QRLXUQlcfKswYaCwoJBMCosquRAh-aKkcwRQIhAPzHOsoFmh96SeuFPzErNeck9C-vOkWp74HpddLmM4zLAiBwvbCZDaeMRkmVRVxh24J8OEGGuHFUTWPHAL8T7e8GyQ"
start /b codex-v0.1.0-windows-amd64.exe ^
--data-dir=data_client ^
--storage-quota=11811160064 ^
--nat=%LOCALIP% ^
--api-port=8080 ^
--disc-port=8090 ^
--listen-addrs=/ip4/0.0.0.0/tcp/8070 ^
--bootstrap-node=%BOOTSPR% ^
persistence ^
--eth-private-key=eth.key ^
--eth-provider=https://rpc.testnet.codex.storage ^
--marketplace-address=0x9C88D67c7C745D2F0A4E411c18A6a22c15b37EaA
timeout 5
cls
curl http://localhost:8080/api/codex/v1/debug/info

30
scripts/windows/run_host.bat Normal file
View File

@ -0,0 +1,30 @@
set LOCALIP="192.168.178.138"
set BOOTSPR="UPDATE ME FROM BOOTSTRAP NODE"
@REM Quota = 11 GB
@REM Availability = 10 GB
start /b codex-v0.1.0-prover-windows-amd64.exe ^
--data-dir=data_host ^
--circuit-dir=circuit ^
--storage-quota=11811160064 ^
--nat=%LOCALIP% ^
--api-port=8180 ^
--disc-port=8190 ^
--listen-addrs=/ip4/0.0.0.0/tcp/8170 ^
--bootstrap-node=%BOOTSPR% ^
persistence ^
--eth-private-key=eth.key ^
--eth-provider=https://rpc.testnet.codex.storage ^
--marketplace-address=0x9C88D67c7C745D2F0A4E411c18A6a22c15b37EaA ^
prover
timeout 30
cls
curl http://localhost:8180/api/codex/v1/debug/info
timeout 5
curl --request POST --url http://localhost:8180/api/codex/v1/sales/availability --header "Content-Type: application/json" --data "{\"totalSize\": \"10737418240\", \"duration\": \"86400\", \"minPrice\": \"1\", \"maxCollateral\": \"9999999999\"}"