mirror of
https://github.com/logos-storage/ethcc-demo.git
synced 2026-01-03 05:33:09 +00:00
195 lines
4.0 KiB
Markdown
195 lines
4.0 KiB
Markdown
# ethcc-demo
|
|
|
|
This demo app shows past and real-time Codex storage request events on the Codex
|
|
testnet.
|
|
|
|
## Running the demo
|
|
|
|
### First, clone this repo
|
|
|
|
```shell
|
|
git clone https://github.com/codex-storage/ethcc-demo && cd ethcc-demo
|
|
```
|
|
|
|
### Then, create a private key to run codex
|
|
|
|
Create an Ethereum public/private key pair using a [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>
|
|
|
|
```shell
|
|
# Example
|
|
Private key: 0xacec4df7549199708a9f66b151aea7bf41b4d30bd325b96b26f017246226e1a3
|
|
Public address: 0x1C408C8572ce7d5E79a3a6D353e5FC2E8E2c49ce
|
|
```
|
|
|
|
### Mint testnet tokens
|
|
|
|
Before you can use the marketplace functionality of Codex, you will need to
|
|
obtain some tokens in the testnet.
|
|
|
|
1. Join the [Codex Discord server](https://discord.gg/codex-storage)
|
|
2. Go to the `#bot` channel.
|
|
3. Give your public key to the bot using `set` command.
|
|
|
|
4. Ask it politely to mint some tokens for you using `mint` command.
|
|
|
|
|
|
### Copy private key to the setup directory
|
|
|
|
Before we run a codex instance, we need to ensure our private key is saved on
|
|
disk for the Codex instance to use. Copy your private key to
|
|
`path/to/demo/codex-setup/eth.key`:
|
|
|
|
```shell
|
|
# copy your private key to eth.key
|
|
echo 0xacec4df7549199708a9f66b151aea7bf41b4d30bd325b96b26f017246226e1a3 >> ./codex-setup/eth.key
|
|
chmod 0600 ./codex-setup/eth.key
|
|
```
|
|
|
|
### Build codex and setup your environment
|
|
|
|
We need to build a Codex instance from source before running it. In a separate
|
|
terminal, run:
|
|
|
|
```shell
|
|
cd .. && git clone https://github.com/codex-storage/nim-codex && cd nim-codex
|
|
export CODEX_PATH=$(pwd)
|
|
make -j12 update && make -j12
|
|
```
|
|
|
|
Note: the parameter `-j12` specifies the number of logical cores your CPU has,
|
|
change to match your CPU. If unknown, use `-j2`.
|
|
|
|
### Run codex
|
|
|
|
In a new terminal, run codex:
|
|
|
|
```shell
|
|
chmod +x codex.sh
|
|
./codex.sh
|
|
```
|
|
|
|
### Finally, run the demo app
|
|
|
|
Back in the original terminal, run the demo app:
|
|
|
|
```shell
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
## Recommended IDE Setup
|
|
|
|
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
|
|
|
|
## Customize configuration
|
|
|
|
See [Vite Configuration Reference](https://vitejs.dev/config/).
|
|
|
|
## Project Setup
|
|
|
|
```sh
|
|
yarn
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
yarn dev
|
|
```
|
|
|
|
### Compile and Minify for Production
|
|
|
|
```sh
|
|
yarn build
|
|
```
|
|
|
|
### Lint with [ESLint](https://eslint.org/)
|
|
|
|
```sh
|
|
yarn lint
|
|
```
|