Skip to content

Latest commit

 

History

History
189 lines (173 loc) · 4.88 KB

CUSTOM_MINER.MD

File metadata and controls

189 lines (173 loc) · 4.88 KB
Raw

Custom miner setup for mmpOS

You can make any executable as custom miner in mmpOS.
All miners are unarchived in directory /opt/mmp/miners/custom-$(echo -n "your-download-url/miner.tar.gz" | sha256sum | cut -c1-5)

mmp-external.conf

This file is considered generic for storing miner name and version.
It is used entirely for your information purpose, we do not display anything it contains.
General content:

# The name of the miner ex. myfirstminer  
EXTERNAL_NAME=myfirstminer
# Miner version  
EXTERNAL_VERSION=1.0
mmp-stats.sh

Stats collector file used by mmp agent.

This script is used by mmp agent to push stats to mmp dashboard.
A few rules to follow:

  • PCI Bus or Index count must always match Hashrate count as busid.
  • Index can be removed when you provide PCI Bus Ids as index.
  • PCI Bus must be argjson and should either be decimal or hex as busid.
  • For FPGA monitoring you either provide USB Bus id or Serial as uid.
  • For CPU monitoring you mark busid as arg and name it cpu. - see CPU example:
  • Hashrate format is either float or integer in argjson as hash.
  • Units can be hs, khs, mhs, ghs, ths as units
  • air means Accepted, Invalid, Rejected and its in arg format.

Example GPU json output:

{
  "busid": [
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "hash": [
    111.0,
    112.0,
    113.0,
    114.0,
    115.0,
    116.0
  ],
  "units": "hs",
  "air": [
    "5",
    "1",
    "2"
  ],
  "miner_name": "myfirstminer",
  "miner_version": "1.0"
}

Example CPU json output:

{
  "busid": [
    "cpu"
  ],
  "hash": [
    111.0,
  ],
  "units": "hs",
  "air": [
    "5",
    "1",
    "2"
  ],
  "miner_name": "myfirstminer",
  "miner_version": "1.0"
}

You can mix cpu and gpu hashrate but first you should provide cpu as busid followed by GPU busids.

Example FPGA json output:

{
  "uid": [
  "50241A29CNC9",
  "50241A29CR9T",
  "153300000944",
  "153300000791",
  "XFL1WCO4STQT",
  "TH53M0809009"
  ],
  "hash": [
    111.0,
    112.0,
    113.0,
    114.0,
    115.0,
    116.0,
  ],
  "units": "hs",
  "air": [
    "5",
    "1",
    "2"
  ],
  "miner_name": "myfirstminer",
  "miner_version": "1.0"
}

Since 10th of October we now support per device share monitoring. Here's additional json data that can be added to current json format:

  "shares": {
    "accepted": [ // Accepted shares per device(current example is for 6 devices)
      1, // Matches index/bus of first device
      0,
      0,
      0,
      0,
      1 // Matches index/bus of last device
    ],
    "rejected": [ // This will be shown as rejected %
      0,
      0,
      0,
      0,
      0,
      0
    ],
    "invalid": [ // This will display error rate per device on dashboard.
      0,
      0,
      0,
      0,
      0,
      0
    ]
  }

NOTE! Currentlu ar/air is required also to show total shares per hour. So don't forget to include it too.
Here are some example mmp-stats.sh files:

Make sure mmp-stats.sh is executable and it contains:

#!/usr/bin/env bash
or
#!/bin/bash
DEVICE_NUM=$1 # -- This indicates the number of devices agent seeks stats for.
LOG_FILE=$2 # -- This gives the log file provided by agent on call.

header

How to pack your custom miner:

Must be packed in tar.gzip format or meaning .tar.gz or .tgz inside directory.
Name of the directory is not relevant because our agent already renames it to custom-$(echo -n "your-download-url/miner.tar.gz" | sha256sum | cut -c1-5)

Sample command to create miner archive

tar -czf myfirstminer-1.0.tgz myfirstminer

How to use your custom miner:

After you've packed and uploaded your miner somewhere, you are ready to take the next step - using it!

Create miner profile and select custom miner, place your url as listed below:
Custom

Make sure to select proper pool too.

Move to advanced settings:
Custom

In arguments field you provide proper arguments supported by your custom miner, you can point directly to miner binary or create abstract executable like miner.sh

Sample miner.sh executable script.

#!/usr/bin/env bash
trap 'while killall myminerbinary > /dev/null 2>&1;do sleep 1;done;exit 0' SIGTERM
    ./myminerbinary --api-port 5001

Final step after successful setup of your custom miner:

Now its time to share it with other mmpOS users :)
Click on your newly created miner profile and click on export button - see example below.
Custom

Et Voila!