diff --git a/README.md b/README.md index 1f9e578..5d0521c 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,61 @@ your own risk.** An application that uses AshMaize PoW algorithm to scavenge for night. +# Building from source with 'cargo', if you don't have nix + + +```bash +cargo build --release +``` + +If you encounter issue with the build try to run `cargo fix --bin "shadow-harvester"` + +Run + +```bash +cargo run --release -- +``` +OR + + +```bash +./target/release/shadow-harvester +``` + +# Usage +The below commands will use `nix` for running the command, if you don't use nix you can use `cargo` or just build `./target/release/shadow-harvester ` + + +## Running with a Mnemonic File + +To run Shadow Harvester with a mnemonic file: + +```bash +nix run .\#shadow-harvester -- --api-url https://scavenger.prod.gd.midnighttge.io --accept-tos --mnemonic-file wallet.mnemonic +``` + +## Creating a Wallet + +If you haven't created a wallet yet, you can generate a recovery phrase using `cardano-address`: + +```bash +cardano-address recovery-phrase generate > wallet.mnemonic +``` + +**Security Note:** There is always a security risk when using plain text mnemonics. For Midnight, it is recommended that you transfer your NIGHT tokens to your preferred secure wallets after the glacier drop period concludes. + +## Running with a Single Payment Key + +If you just want to mine with a single key: + +```bash +nix run .\#shadow-harvester -- --api-url https://scavenger.prod.gd.midnighttge.io --accept-tos --payment-key "YOURED25519PRIVATEKEY" +``` + +**Note on Ephemeral Keys** + +Ephemeral keys are not recommended for use. Currently, the donate-to endpoint is not active, which means any keys generated ephemerally are discarded and never persisted to disk. While this approach was initially considered, the implementation was switched to mnemonic-based keys due to the non-functional donate-to endpoint. Use mnemonic files or payment keys instead until the donate-to functionality becomes available. + # License This project is licensed under either of the following licenses: