1
- ## Story-Geth
1
+ # Story-Geth
2
2
3
3
Golang execution layer implementation of the Story.
4
4
5
5
[ ![ Discord] ( https://img.shields.io/badge/discord-join%20chat-blue.svg )] ( https://discord.gg/StoryProtocol )
6
6
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 ) .
8
8
9
9
## Building ` story-geth `
10
+
10
11
Go version: 1.22.0
11
12
12
- ```
13
+ ``` shell
13
14
go build -v ./cmd/geth
14
15
mv ./geth $HOME /go/bin/story-geth
15
16
source $HOME /.bashrc
@@ -18,6 +19,12 @@ story-geth version
18
19
19
20
## Running ` story-geth `
20
21
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
+
21
28
### Hardware Requirements
22
29
23
30
Minimum:
@@ -34,7 +41,7 @@ Recommended:
34
41
* High-performance SSD with at least 1TB of free space
35
42
* 25+ MBit/sec download Internet service
36
43
37
- ### A Full node on the Odyssey test network
44
+ ### A Full node on the Aeneid test network
38
45
39
46
Transitioning towards developers, if you'd like to play around with creating Story
40
47
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
43
50
the main network, but with play-IP only.
44
51
45
52
``` shell
46
- $ ./ geth --odyssey --syncmode full
53
+ story- geth --aeneid --syncmode full
47
54
```
48
55
49
56
The ` console ` subcommand has the same meaning as above and is equally
50
57
useful on the testnet too.
51
58
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:
53
60
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
55
62
test network, which uses different P2P bootnodes, different network IDs and genesis
56
63
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
59
66
Linux). Note, on OSX and Linux this also means that attaching to a running testnet node
60
67
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
67
74
68
75
* Note: Although some internal protective measures prevent transactions from
69
76
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
105
112
106
113
Find more information and setup instructions here:
107
114
[ Story-Localnet GitHub Repository] ( https://github.com/piplabs/story-localnet ) .
108
-
0 commit comments