Skip to content

doc(readme): update to iliad, add cmd, markdown lint style #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 10, 2025
Merged

doc(readme): update to iliad, add cmd, markdown lint style #114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0557f8a
doc(readme): update to iliad, add cmd, markdown lint style
jdubpark Mar 3, 2025
a761607
fix testnet
jdubpark Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
## Story-Geth
# Story-Geth

Golang execution layer implementation of the Story.

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

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

## Building `story-geth`

Go version: 1.22.0

```
```shell
go build -v ./cmd/geth
mv ./geth $HOME/go/bin/story-geth
source $HOME/.bashrc
Expand All @@ -18,6 +19,12 @@ story-geth version

## Running `story-geth`

You can run the mainnet with `--story` flag attached. Here's an example command:

```shell
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
```

### Hardware Requirements

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

### A Full node on the Odyssey test network
### A Full node on the Aeneid test network

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

```shell
$ ./geth --odyssey --syncmode full
story-geth --aeneid --syncmode full
```

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

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

* Instead of connecting to the main Story network, the client will connect to the Odyssey
* Instead of connecting to the main Story network, the client will connect to the Aeneid
test network, which uses different P2P bootnodes, different network IDs and genesis
states.
* Instead of using the default data directory (`~/.story` on Linux for example), `story`
will nest itself one level deeper into a `story` subfolder (`~/.story/odyssey` on
* Instead of using the default data directory (`~/.story` on Linux for example), `story`
will nest itself one level deeper into a `story` subfolder (`~/.story/aeneid` on
Linux). Note, on OSX and Linux this also means that attaching to a running testnet node
requires the use of a custom endpoint since `geth attach` will try to attach to a
production node endpoint by default, e.g., `geth attach <datadir>/geth.ipc`.
This will connect you to the IPC server from which you can run some helpful queries:
* `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
* `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
* `eth.syncing` will return `true` if story-geth is in the process of syncing, `false` otherwise
production node endpoint by default, e.g., `geth attach <datadir>/geth.ipc`.

This will connect you to the IPC server from which you can run some helpful queries:
* `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
* `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
* `eth.syncing` will return `true` if story-geth is in the process of syncing, `false` otherwise

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

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

Loading