-
Notifications
You must be signed in to change notification settings - Fork 172
Add Mordor Mining Guide #588
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
Open
chris-mercer
wants to merge
17
commits into
etclabscore:master
Choose a base branch
from
mordortestnet:local
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
69ec94d
Update build-from-source.md
chris-mercer 87897c5
Update installation.md
chris-mercer 8de9a4a
Add files via upload
chris-mercer baeeaf7
Update build-from-source.md
chris-mercer 5dfec4a
Update mordor-guide.md
chris-mercer 88f9ece
Update build-from-source.md
chris-mercer e722f39
Update mordor-guide.md
chris-mercer 1ec2161
Update installation.md
chris-mercer a3bc323
Update mordor-guide.md
chris-mercer 083caf8
Update docs/getting-started/mordor-guide.md
chris-mercer f7e868c
Update docs/getting-started/mordor-guide.md
chris-mercer d2bcbf6
Update docs/getting-started/mordor-guide.md
chris-mercer 5a0da02
Update docs/getting-started/mordor-guide.md
chris-mercer c651f3e
Update docs/getting-started/mordor-guide.md
chris-mercer 58388be
Update docs/getting-started/installation.md
chris-mercer 132e9e5
Update docs/getting-started/installation.md
chris-mercer 915f1db
Update docs/getting-started/installation.md
chris-mercer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
title: Mordor Testnet Guide | ||
--- | ||
|
||
!!! tip "Mordor Testnet" | ||
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. | ||
|
||
## Summary: | ||
|
||
+ Install Core-geth https://etclabscore.github.io/core-geth/getting-started/installation/ | ||
+ Create an account on --mordor | ||
+ Run --mordor with --mine enabled | ||
+ Create a Script to mine Mordor METC | ||
|
||
## Install Core-geth | ||
|
||
https://etclabscore.github.io/core-geth/getting-started/installation/ | ||
|
||
## Mordor Testnet Mining Guide | ||
|
||
You can visit the Core-geth documentation for more installation options. I’m using Ubuntu 22.04 LTS. | ||
|
||
If you just want to download and run `geth --mordor` or any of the other tools here, this is the quickest and simplest way. | ||
|
||
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! | ||
|
||
When running Core-geth use `--mordor` flag for Ethereum Classic testnet. | ||
|
||
```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 | ||
$ geth --help # Lists available options | ||
$ geth --mordor # Runs Ethereum Classic's testnet Mordor | ||
``` | ||
|
||
## Account Creation | ||
|
||
You'll need an account with an address (0x...) to receive your mETC mining rewards. Here is how you make an address and keystore file with core-geth. You'll be able to import the keystore file into wallets like MetaMask. Backup this file. You'll mine your mordor rewards to it. | ||
|
||
```shell | ||
$ geth --mordor account new # Creates a new account with a public address and keystore file | ||
$ geth --mordor account list | ||
$ geth --mordor # Runs Ethereum Classic's testnet Mordor | ||
``` | ||
|
||
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 Enabled | ||
|
||
```shell | ||
$ geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087 | ||
``` | ||
|
||
Check Mordor Balance on Blockscout | ||
|
||
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 (Optional) | ||
|
||
You can use your keystore file to import your wallet into a wallet application such as MetaMask. In MetaMask | ||
|
||
* Add the Ethereum Classic mainnet to your MetaMask by visiting https://chainlist.org/chain/61 and clicking the "Add to MetaMask" button. | ||
* Add the Mordor testnet to your MetaMask by visiting https://chainlist.org/chain/63 and clicking the "Add to MetaMask" button. | ||
* Under your account profile select import account > select type (JSON) > upload your keystore file. You may need to enter the account password. | ||
|
||
## Mordor Mining Script | ||
|
||
One way to avoid typing or copy and pasting this same text block is creating a shell script file. | ||
|
||
```shell | ||
$ geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087 | ||
``` | ||
|
||
Enter the following in a new terminal window (ctrl + alt + t): | ||
|
||
```shell | ||
echo "geth --mordor --mine --minerthreads 1 --miner.etherbase 0x_INSERT_YOUR_ADDRESS_HERE_3a087" >start-mordor.sh && chmod +x start-mordor.sh | ||
``` | ||
|
||
Create or truncate the script file and echo the command into it, then make it executable. | ||
|
||
Enter the following in a new terminal window (ctrl + alt + t): | ||
|
||
```shell | ||
./start-mordor.sh | ||
``` | ||
|
||
Great job! You are mining on Ethereum Classic's testnet. | ||
|
||
## Donate Mined mETC to a Community Faucet for Pubic Use | ||
|
||
https://faucet.mordortest.net | ||
|
||
A faucet is a developer tool that gives users testnet tokens to use when testing smart contracts or interacting with DApps on test networks. https://faucet.mordortest.net gives Mordor testnet ETC to test smart contracts before pushing them to production on the Ethereum Classic mainnet. Faucets like this allow network users and developers to interact with the Mordor network without the prerequisite of mining mETC via a client node. To donate mETC to this public faucet, please send your mETC to address `0x51Cb0EA27f03e56d84E9EB1879F131393a6769bA`. | ||
|
||
## Video Mordor Guide | ||
|
||
https://www.youtube.com/watch?v=0hutSdb-dV8 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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.