Adding some example command to make user friendly the shadowharvester

[dulovics]

Hi,

First, thank you for creating this tool.
I am wondering, if you can add some user guide with some example commands how to use the CLI after build.

Considering, how to configure the donation address, how can be the address type verified if it fulfil the (bech32) format.

When I tried to use address from the lace wallet I always received 403 error, and having some difficulties to with the initial configuration.

Thanks for reading and considering the suggestion.

[leeeroyd]

Usage is pretty clear, one thing I would be curious to see visibility into is how to actually make claims (after the scavenger phase is complete) via a mnemonic used to mine with Shadow. If necessary I would pay a fee to disassembler for this information, especially since the format has changed with improvements to the miner.

[dulovics]

Maybe I had a false assumption when I tried to run the shadowharvester, based on how I interpreted the cli and the help informations.
I tried to use the following flags in the cli with the Lace wallet destination address.

shadow-harvester --api-url 'https://scavenger.prod.gd.midnighttge.io' --accept-tos --ephemeral-key --donate-to  addr1...

I assumed by using ephemeral-key and donation address would, the miner generate short lived credential while solving the challenge and the night reward will donated the Lace wallet address, so in multiple cycle different temp addresses will created and its reward sign to the donated address.
However with this combination I always received 403 error, this could be that the used address format was not bech32 as only copy paster from the lace wallet browser plugin.

Also do we need to define the --address as well while initialising the miner ?

As I am quite new for this I am also interested what is actually is doing the --mnemonic flag , how the address generation would work and can claim the reward later.

[greenwolf86]

Dulovics, I'm in a similar situation to you. I'm not a programmer/developer by trade, but I know enough to hack things together. I have it working for one address at a time using the same CLI as you but without the 'donate-to.' I know from the discussion over on the Midnight Discord that the API function isn't working yet, so I assumed it was not working here.

For me, I can get it to run and solve one address, and then it hangs after submitting the receipt to the SLED. Still digging through the code, but something is happening in the SubmitSolution loop. Removing the donate piece seems to fix the 403 error though.

[dulovics]

greenwolf86 If you don't mind can you share what parameters did you use during the shadow-harvester execution ?
Did you use --address or --payment-key?

[disassembler]

please create a PR to improve the documentation :) Just make sure to keep the warning from the current README. I'll happily merge documentation contributions!

Here's how I run it:

nix run .\#shadow-harvester -- --api-url https://scavenger.prod.gd.midnighttge.io --accept-tos --mnemonic-file wallet.mnemonic

If you haven't created a wallet, here's how I do that:

cardano-address recovery-phrase generate > wallet.mnemonic

There's always risk with using plain text mnemonics. For midnight, I don't care so much because I have no value other than what I'm mining in the wallet, and once glacier drop is done, everything will be moved to my hardware wallet or in a smart contract generating dust.

Note that ephemeral key shouldn't be used. You're throwing away random keys right now because donate-to endpoint isn't active, and the key is never written to disk. It was a cool idea, but I had to pivot to mnemonic when I found out the donate-to wasn't functioning. Hopefully they get it functioning before the end of the challenge.

If you just want to mine with a single key:

nix run .\#shadow-harvester -- --api-url https://scavenger.prod.gd.midnighttge.io --accept-tos --payment-key "YOURED25519PRIVATEKEY"

[leeeroyd]

Curious if you could point to where the derivation path is in the code so I can re-create the list of addresses via cardano-cli? I'm just working to figure out how I'll be able to make claims with the mnemonic I used along with shadowharvester once the scavenger phase is complete.

[dulovics]

Thanks for the running information, and the additional steps how I can create a wallet with CLI.

I summarised your answer and added alternative build and run command by using cargo.

Connected PR:

• Update README.md with build and run instructions #16

[leeeroyd]

thanks!