Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 5.55 KB

README.md

File metadata and controls

103 lines (71 loc) · 5.55 KB
Raw

Foxy-Farmer

Foxy-Farmer is a simplified farmer for the chia blockchain using the Foxy-Pool chia farming gateway to farm without a full node running on your machine.

  • NFT and OG pooling are both supported!
  • Bladebit compressed plots are supported!
  • Gigahorse compressed plots are supported!
  • DrPlotter compressed plots are supported!

Note

If you can run a full node, you should!

Foxy-Farmer is useful in the following scenarios:

  • You are replotting your OG pooling farm to compressed NFT plots but do not want to run two full nodes
  • You want to run a DrPlotter setup on a single machine
  • Your hardware does not support running a full node
  • You do not want to manage/run a full node

If you are migrating from FlexFarmer please check out this guide.

The docs can be found here.

Installing

Using the binary

  1. On Linux ensure you have ocl-icd-libopencl1 installed when using the gigahorse backend

  2. Download the latest binary zip for your OS from the releases page

  3. Run the binary and follow the first run wizard, it will create a foxy-farmer.yaml in the current directory based on your inputs.

    Note: You can join the pool at any time, just run ./foxy-farmer join-pool. You can add --fee to supply a fee in case the mempool is full.

  4. (Optional) Edit the foxy-farmer.yaml to your liking and restart foxy-farmer

  5. Profit!

Running from source

  1. On Linux ensure you have ocl-icd-libopencl1 installed when using the gigahorse backend

  2. Clone the git repo and cd into it: git clone https://github.com/foxypool/foxy-farmer && cd foxy-farmer

  3. Create a venv:

    python3 -m venv venv

  4. Install the dependencies:

    venv/bin/pip install .

  5. Run using venv/bin/foxy-farmer (or activate the venv using source venv/bin/activate and then just use foxy-farmer) and follow the first run wizard, it will create a foxy-farmer.yaml in the current directory based on your inputs.

    Note: You can join the pool at any time, just run foxy-farmer join-pool. You can add --fee to supply a fee in case the mempool is full.

  6. (Optional) Edit the foxy-farmer.yaml to your liking and restart foxy-farmer

  7. Profit!

Using docker

A docker image based on the provided Dockerfile is available via ghcr.io/foxypool/foxy-farmer:latest and foxypool/foxy-farmer:latest. For specific tags see this list. A docker-compose.yaml example is available as well, to get started.

Currently, this requires you to have a working foxy-farmer.yaml already available to mount into the container. See this example configuration for reference. If you do not have a .chia_keys directory from a previous chia install, you can set the CHIA_MNEMONIC environment variable to your 24 words and it will create they keyring accordingly. Please unset it again once done.

Note: To execute the join-pool command please first exec into the running container with

docker exec -it <name of your container> bash

Then you can run foxy-farmer join-pool inside the container.

Updating

Using the binary

Just download the latest version of the binary from here like you did on install and replace the existing binary, that's it.

Running from source

  1. Open a terminal in the foxy-farmer directory which you cloned during install.
  2. Run git pull
  3. Run venv/bin/pip install --upgrade .

Using docker

Pull the latest image using docker pull ghcr.io/foxypool/foxy-farmer:latest and recreate the container using docker compose up -d.

Are my keys safe?

Yes, Foxy-Farmer itself is open source and uses the og pooling patched chia-blockchain client under the hood which is open source as well, so you can verify yourself nothing funky happens. When using the gigahorse backend the Gigahorse Farmer and Harvester from madMAx43v3r are used under the hood which are closed source, however. As such the farming topology has not changed, your locally running farmer still signs your blocks, same as when running a local full node. Your keys do not leave your machine.

Can i use the Foxy-Pool chia farming gateway without pooling in Foxy-Pool?

Yes, using the chia farming gateway without pooling in Foxy-Pool is supported, but a 1% fee is charged when farming a block with a Pool Public Key or Launcher Id which is not pooling with Foxy-Pool.

Using remote harvesters

You can use remote harvesters with foxy-farmer, just make sure to use the port 18447 and use the ssl ca directory from .foxy-farmer. A make_harvester_installer.ps1 and run_harvester.ps1 script is provided to simplify this for Windows users, especially when running gigahorse remote harvesters already. Just run the make_harvester_installer.ps1 script and copy the resulting foxy-harvester directory onto the remote harvesters and run run_harvester.ps1 on them.

License

GNU GPLv3 (see LICENSE)