Skip to content

Commit e7277fc

Browse files
jdubparkstevemilk
authored andcommitted
doc(readme): update to iliad, add cmd, markdown lint style (#114)
* doc(readme): update to iliad, add cmd, markdown lint style * fix testnet
1 parent 7e238fe commit e7277fc

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

+22-16
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
## Story-Geth
1+
# Story-Geth
22

33
Golang execution layer implementation of the Story.
44

55
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/StoryProtocol )
66

7-
Binary archives are published at https://github.com/piplabs/story-geth/releases.
7+
Binary archives are published at [https://github.com/piplabs/story-geth/releases](https://github.com/piplabs/story-geth/releases).
88

99
## Building `story-geth`
10+
1011
Go version: 1.22.0
1112

12-
```
13+
```shell
1314
go build -v ./cmd/geth
1415
mv ./geth $HOME/go/bin/story-geth
1516
source $HOME/.bashrc
@@ -18,6 +19,12 @@ story-geth version
1819

1920
## Running `story-geth`
2021

22+
You can run the mainnet with `--story` flag attached. Here's an example command:
23+
24+
```shell
25+
story-geth --story --datadir="/story/geth/" --verbosity="3" --http --http.corsdomain="*" --http.vhosts="*" --http.addr=127.0.0.1 --http.port="8545" --http.api=web3,debug,eth,txpool --ws --ws.addr=127.0.0.1 --ws.port="8546" --ws.origins="*" --ws.api=debug,eth,txpool --syncmode=full --maxpeers=100
26+
```
27+
2128
### Hardware Requirements
2229

2330
Minimum:
@@ -34,7 +41,7 @@ Recommended:
3441
* High-performance SSD with at least 1TB of free space
3542
* 25+ MBit/sec download Internet service
3643

37-
### A Full node on the Odyssey test network
44+
### A Full node on the Aeneid test network
3845

3946
Transitioning towards developers, if you'd like to play around with creating Story
4047
contracts, you almost certainly would like to do that without any real money involved until
@@ -43,27 +50,27 @@ network, you want to join the **test** network with your node, which is fully eq
4350
the main network, but with play-IP only.
4451

4552
```shell
46-
$ ./geth --odyssey --syncmode full
53+
story-geth --aeneid --syncmode full
4754
```
4855

4956
The `console` subcommand has the same meaning as above and is equally
5057
useful on the testnet too.
5158

52-
Specifying the `--odyssey` flag, however, will reconfigure your `story-geth` instance a bit:
59+
Specifying the `--aeneid` flag, however, will reconfigure your `story-geth` instance a bit:
5360

54-
* Instead of connecting to the main Story network, the client will connect to the Odyssey
61+
* Instead of connecting to the main Story network, the client will connect to the Aeneid
5562
test network, which uses different P2P bootnodes, different network IDs and genesis
5663
states.
57-
* Instead of using the default data directory (`~/.story` on Linux for example), `story`
58-
will nest itself one level deeper into a `story` subfolder (`~/.story/odyssey` on
64+
* Instead of using the default data directory (`~/.story` on Linux for example), `story`
65+
will nest itself one level deeper into a `story` subfolder (`~/.story/aeneid` on
5966
Linux). Note, on OSX and Linux this also means that attaching to a running testnet node
6067
requires the use of a custom endpoint since `geth attach` will try to attach to a
61-
production node endpoint by default, e.g., `geth attach <datadir>/geth.ipc`.
62-
63-
This will connect you to the IPC server from which you can run some helpful queries:
64-
* `eth.blockNumber` will print out the latest block story-geth is sync’d to - if this is `undefined` there is likely a peer connection or syncing issue
65-
* `admin.peers` will print out a list of other `story-geth` nodes your client is connected to - if this is blank there is a peer connectivity issue
66-
* `eth.syncing` will return `true` if story-geth is in the process of syncing, `false` otherwise
68+
production node endpoint by default, e.g., `geth attach <datadir>/geth.ipc`.
69+
70+
This will connect you to the IPC server from which you can run some helpful queries:
71+
* `eth.blockNumber` will print out the latest block story-geth is sync’d to - if this is `undefined` there is likely a peer connection or syncing issue
72+
* `admin.peers` will print out a list of other `story-geth` nodes your client is connected to - if this is blank there is a peer connectivity issue
73+
* `eth.syncing` will return `true` if story-geth is in the process of syncing, `false` otherwise
6774

6875
*Note: Although some internal protective measures prevent transactions from
6976
crossing over between the main network and test network, you should always
@@ -105,4 +112,3 @@ To simplify local development and testing, developers can use the **Story-Localn
105112

106113
Find more information and setup instructions here:
107114
[Story-Localnet GitHub Repository](https://github.com/piplabs/story-localnet).
108-

0 commit comments

Comments
 (0)