Skip to content
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.

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

Add Mordor Mining Guide #588

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

chris-mercer
Copy link

  • Update Build from Source: Go version and Installation instructions
  • Update Installation: Fix broken link, Add --classic flags and Installation instructions
  • Add Mordor Mining Guide


```shell
$ wget https://github.com/etclabscore/core-geth/releases/download/v1.12.17/core-geth-linux-v1.12.17.zip # Update to the most current release version
$ sudo unzip core-geth-linux-v1.12.17.zip -d /bin/ # Update to the most current release version
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally the best place for user-installed programs is in /usr/local/bin.

https://unix.stackexchange.com/questions/8656/usr-bin-vs-usr-local-bin-on-linux

Suggested change
$ sudo unzip core-geth-linux-v1.12.17.zip -d /bin/ # Update to the most current release version
$ sudo unzip core-geth-linux-v1.12.17.zip -d /usr/local/bin # Update to the most current release version

Here and other places.


Binary archives are published at https://github.com/etclabscore/core-geth/releases. Find the latest one for your OS, download it, (check the SHA sum), unarchive it, and run!

Tip: When running Core-geth use `--classic` flag for Ethereum Classic mainnet.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we use the markdown !!! tips instead for these Tip:s?

Suggested change
Tip: When running Core-geth use `--classic` flag for Ethereum Classic mainnet.
!!! tip "Run Ethereum Classic"
When running Core-geth use `--classic` flag for Ethereum Classic mainnet.

@@ -3,14 +3,31 @@ title: Installation
---

!!! tip "Build from Source"
Instructions to build from source can be found [here](core-geth/developers/build-from-source/).
Instructions to build from source can be found [here](https://etclabscore.github.io/core-geth/developers/build-from-source/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will it work to use a relative path instead? That'd be a little less brittle.

Suggested change
Instructions to build from source can be found [here](https://etclabscore.github.io/core-geth/developers/build-from-source/)
Instructions to build from source can be found [here](./core-geth/developers/build-from-source/)

---

!!! tip "Mordor Testnet"
Mordor is a PoW Ethereum Classic testnet. A testnet allows developers to perform specific tests. Developers may want to test protocol changes, test a smart contract, or interact with the network in anyway that does not require real EthClassic (ETC)—just don’t test on mainnet, mainnet is for production.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Mordor is a PoW Ethereum Classic testnet. A testnet allows developers to perform specific tests. Developers may want to test protocol changes, test a smart contract, or interact with the network in anyway that does not require real EthClassic (ETC)—just don’t test on mainnet, mainnet is for production.
Mordor is a PoW Ethereum Classic testnet. A testnet allows developers to test transactions before deploying them with real value on the mainnet. Developers may want to test protocol changes, test a smart contract, or interact with the network in any way that does not require real EthClassic (ETC)—just don’t test on mainnet, mainnet is for production.

$ source ~/.bash_profile
$ go version
```

Copy link
Member

@meowsbits meowsbits Jan 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All three of these paragraphs are Go installation instructions. I'd prefer to defer simply to one -- the official Go docs -- rather than provide 3 redundant options which will need updating. The important part here -- and thanks for updating it :) -- is the minimum Go version.


You’ll notice listing the account will print the keystore file location.For example:keystore:///home/USER/.ethereum/mordor/keystore/UTC...

## Run Mordor with Mining Enable
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Run Mordor with Mining Enable
## Run Mordor with Mining Enabled


So, you’re running a Mordor node and mining testnet mETC. Woohoo! An easy way to double check you’re actually growing a Mordor testnet balance is on [Blockscout](https://etc-mordor.blockscout.com). Just search the account address you created earlier.

## Add your Mordor Account to a Wallet?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Add your Mordor Account to a Wallet?
## Add your Mordor Account to a Wallet (Optional)

Enter the following in a new terminal window (ctrl + alt + t):

```shell
touch start-mordor.sh && echo "geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087" >start-mordor.sh && chmod +x start-mordor.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

> will create (and truncate) the file if it does not already exist.

Suggested change
touch start-mordor.sh && echo "geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087" >start-mordor.sh && chmod +x start-mordor.sh
echo "geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087" >start-mordor.sh && chmod +x start-mordor.sh

touch start-mordor.sh && echo "geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087" >start-mordor.sh && chmod +x start-mordor.sh
```

touch start-mordor.sh to create the file && echo “the contents” into the shell script file && add chmod executable+x permissions to the file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
touch start-mordor.sh to create the file && echo the contents” into the shell script file && add chmod executable+x permissions to the file.
Create or truncate the script file and echo the command into it, then make it executable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants