Skip to content

Commit 711c194

Browse files
committed
Update README and refactor local scripts
The README file is updated to improve project description and guidance. Local environment setup and command scripts have also been refactored and moved to the 'scripts' directory.
1 parent 4ea8f58 commit 711c194

4 files changed

Lines changed: 38 additions & 65 deletions

File tree

Readme.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,55 @@
1-
# stationevm
2-
**stationevm** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli).
1+
# EVM station
32

4-
## Get started
3+
## Introduction
54

6-
```
7-
ignite chain serve
8-
```
5+
The Ethereum Virtual Machine (EVM)-based Cosmos Chain represents a groundbreaking platform in the blockchain sphere, specifically designed for the creation and deployment of decentralized applications (DApps) and smart contracts. This platform is a harmonious blend of the scalability provided by the Cosmos network and the adaptability and widespread acceptance of the Ethereum Virtual Machine (EVM). It is engineered to cater to blockchain developers who are seeking a robust and flexible environment for their innovations.
96

10-
`serve` command installs dependencies, builds, initializes, and starts your blockchain in development.
7+
At its core, this platform offers a unique proposition: it combines the high-performance infrastructure of Cosmos, known for its inter-blockchain communication and scalability, with the powerful and versatile programming capabilities of the EVM. This integration allows developers to build sophisticated and efficient DApps and smart contracts that can leverage the best of both worlds.
118

12-
### Configure
139

14-
Your blockchain in development can be configured with `config.yml`. To learn more, see the [Ignite CLI docs](https://docs.ignite.com).
10+
## Prerequisites
11+
The project requires:
1512

16-
### Web Frontend
13+
- [Go](https://golang.org/dl/) (Version 1.22 or later)
14+
- [jq](https://stedolan.github.io/jq/download/): A lightweight and flexible command-line JSON processor.
1715

18-
Ignite CLI has scaffolded a Vue.js-based web app in the `vue` directory. Run the following commands to install dependencies and start the app:
1916

17+
## Getting Started
18+
19+
- To begin using this project, firstly clone this repository to your local machine.
20+
```shell
21+
git clone https://github.com/airchains-network/evm-station
22+
cd evm-station;
23+
go mod tidy;
2024
```
21-
cd vue
22-
npm install
23-
npm run serve
24-
```
2525

26-
The frontend app is built using the `@starport/vue` and `@starport/vuex` packages. For details, see the [monorepo for Ignite front-end development](https://github.com/ignite/web).
2726

28-
## Release
29-
To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created.
3027

28+
## Running the project
29+
30+
- To setup the project, execute the following command:
31+
```shell
32+
/bin/bash ./scripts/local-setup.sh
3133
```
32-
git tag v0.1
33-
git push origin v0.1
34+
35+
- To Start the station, execute the following command:
36+
```shell
37+
/bin/bash ./scripts/local-start.sh
3438
```
3539

36-
After a draft release is created, make your final changes from the release page and publish it.
40+
- To Get the Private Keys of the EVM Chain, execute the following command:
41+
```shell
42+
/bin/bash ./scripts/local-keys.sh
43+
```
3744

38-
### Install
39-
To install the latest version of your blockchain node's binary, execute the following command on your machine:
4045

41-
```
42-
curl https://get.ignite.com/username/station-evm@latest! | sudo bash
43-
```
44-
`username/station-evm` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer).
4546

46-
## Learn more
47+
## Contributing
48+
Contributions are greatly appreciated. You can make contributions by creating issues, fixing bugs, or suggesting new features. Feel free to fork this repository and create pull requests to affect changes.
49+
50+
51+
## License
52+
This project is licensed under the MIT license - see the [LICENSE](LICENSE) file for more information.
4753

48-
- [Ignite CLI](https://ignite.com/cli)
49-
- [Tutorials](https://docs.ignite.com/guide)
50-
- [Ignite CLI docs](https://docs.ignite.com)
51-
- [Cosmos SDK docs](https://docs.cosmos.network)
52-
- [Developer Chat](https://discord.gg/ignite)
54+
## Contact
55+
For any inquiries or constructive feedback, please contact this email contact@airchains.io

privateKey.sh renamed to scripts/local-keys.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
CHAINID="${CHAIN_ID:-aircaiks_9000-1}"
3+
CHAINID="${CHAIN_ID:-stationevm_9000-100}"
44
MONIKER="localtestnet"
55
# Remember to change to other types of keyring like 'file' in-case exposing to outside world,
66
# otherwise your balance will be wiped quickly
@@ -24,5 +24,4 @@ GENESIS=$HOMEDIR/config/genesis.json
2424
TMP_GENESIS=$HOMEDIR/config/tmp_genesis.json
2525
VAL_KEY="mykey"
2626

27-
2827
./build/station-evm keys unsafe-export-eth-key "$VAL_KEY" --keyring-backend "$KEYRING"

local.sh renamed to scripts/local-setup.sh

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ HOMEDIR="$HOME/.evmosd"
1313
# to trace evm
1414
#TRACE="--trace"
1515
TRACE=""
16-
1716
# feemarket params basefee
1817
BASEFEE=1000000000
19-
18+
VAL_KEY="mykey"
2019
# Path variables
2120
CONFIG=$HOMEDIR/config/config.toml
2221
APP_TOML=$HOMEDIR/config/app.toml
@@ -83,43 +82,15 @@ if [[ $overwrite == "y" || $overwrite == "Y" ]]; then
8382
# Remove the previous folder
8483
rm -rf "$HOMEDIR"
8584

86-
# Set client config
87-
# evmosd config keyring-backend "$KEYRING" --home "$HOMEDIR"
88-
# evmosd config
89-
90-
# myKey address 0x7cb61d4117ae31a12e393a1cfa3bac666481d02e | evmos10jmp6sgh4cc6zt3e8gw05wavvejgr5pwjnpcky
91-
VAL_KEY="mykey"
92-
VAL_MNEMONIC="gesture inject test cycle original hollow east ridge hen combine junk child bacon zero hope comfort vacuum milk pitch cage oppose unhappy lunar seat"
93-
94-
# dev0 address 0xc6fe5d33615a1c52c08018c47e8bc53646a0e101 | evmos1cml96vmptgw99syqrrz8az79xer2pcgp84pdun
95-
USER1_KEY="dev0"
96-
USER1_MNEMONIC="copper push brief egg scan entry inform record adjust fossil boss egg comic alien upon aspect dry avoid interest fury window hint race symptom"
97-
98-
# dev1 address 0x963ebdf2e1f8db8707d05fc75bfeffba1b5bac17 | evmos1jcltmuhplrdcwp7stlr4hlhlhgd4htqh3a79sq
99-
USER2_KEY="dev1"
100-
USER2_MNEMONIC="maximum display century economy unlock van census kite error heart snow filter midnight usage egg venture cash kick motor survey drastic edge muffin visual"
101-
102-
# dev2 address 0x40a0cb1C63e026A81B55EE1308586E21eec1eFa9 | evmos1gzsvk8rruqn2sx64acfsskrwy8hvrmafqkaze8
103-
USER3_KEY="dev2"
104-
USER3_MNEMONIC="will wear settle write dance topic tape sea glory hotel oppose rebel client problem era video gossip glide during yard balance cancel file rose"
105-
106-
# dev3 address 0x498B5AeC5D439b733dC2F58AB489783A23FB26dA | evmos1fx944mzagwdhx0wz7k9tfztc8g3lkfk6rrgv6l
107-
USER4_KEY="dev3"
108-
USER4_MNEMONIC="doll midnight silk carpet brush boring pluck office gown inquiry duck chief aim exit gain never tennis crime fragile ship cloud surface exotic patch"
109-
11085
# Import keys from mnemonics
11186
echo "$VAL_MNEMONIC" | ./build/station-evm keys add "$VAL_KEY" --keyring-backend "$KEYRING" --algo "$KEYALGO" --home "$HOMEDIR"
11287

11388
echo "$HOMEDIR"
11489
# Set moniker and chain-id for Evmos (Moniker can be anything, chain-id must be an integer)
11590
./build/station-evm init $MONIKER -o --chain-id "$CHAINID" --home "$HOMEDIR"
116-
11791
# Change parameter token denominations to aevmos
11892
jq '.app_state["staking"]["params"]["bond_denom"]="aevmos"' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
11993
jq '.app_state["gov"]["deposit_params"]["min_deposit"][0]["denom"]="aevmos"' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
120-
121-
122-
12394
# Set gas limit in genesis
12495
jq '.consensus_params["block"]["max_gas"]="400000000"' "$GENESIS" >"$TMP_GENESIS" && mv "$TMP_GENESIS" "$GENESIS"
12596

File renamed without changes.

0 commit comments

Comments
 (0)