Skip to content

Latest commit

 

History

History
247 lines (208 loc) · 7.87 KB

README.md

File metadata and controls

247 lines (208 loc) · 7.87 KB

Ultimate Proxy

Downloads Discord General badge

Features

  • Huge bandwidth usage reduction
  • Stable job distributions
  • Remote dashboard statistics, regroup all your proxies/workers (paused for now)
  • Ratio switch (Switch between pool on defined intervals, can be combined with SmartSwitch)
  • Smart switch (Profit, Reward, Difficulty, TimeToBlock) [Thanks to Minerstat for providing such an awesome API for free]
  • Control and monitor all your workers at one place
  • End-to-end encryption
  • Solo mining directly to node (Only ETHW/ETC for now)
  • Switch between pools and/or node without restarting miners
  • Switch between wallets without restarting miners
  • Track workers uptime and reconnection, total and per-pool accepted/rejected shares, calculated hashrate, and response time
  • Unlimited number of failover pools

Some users find it useful for:

  • Mining on unMineable and switch between coins
  • Mining on pools most of the time and try their luck on solo the rest of the time (or the opposite)
  • Mining on different wallets for charging hosting fee
  • Mining on different wallets for splitting rewards in case of sharing rig/farm
  • Control workers using different OS at a single place
  • Mining farm with a poor internet connection

Supported coins and algorithms

If your favorite coin is not listed use one of the algo name (will not work for SmartSwitch and coin name should always be used if available), or come ask about it on discord

  • Autolykos: ERG
  • Equihash125: FLUX
  • Equihash144: BTCZ, BTG
  • Equihash192: YEC, ZCL, ZER
  • Equihash: ARR, HUSH, KMD, ZEC, ZEN
  • Etchash: ETC
  • Ethash: BTN, CAU, CLO, ETHW, EXP, OCTA, QKC, UBQ
  • Firopow: FIRO
  • Kawpow: CLORE, RVN, MEWC, NEOX
  • kHeavyHash: KAS
  • Nexapow: NEXA
  • Octopus: CFX
  • Scrypt: LTC, DOGE, DGB
  • Sha512256d: RXD
  • Sha256: BTC, BCH, BSV, DGB, XEC
  • VerusHash: VRSC

Usage

  1. Download Ultimate Proxy
  2. Edit config.json according to your needs (Please use a high difficulty port)
  3. Either double click on the .exe file, or in your terminal use one of the following command:

Load the default config (config.json if found, or switch-config.json if found, else create config.json)

chmod +x            # Linux, you may need to do that once to give it permision to run
./UltimateProxyV2   # Linux
UltimateProxyV2.exe # Windows

Load specified config file name (Eitheir a coin config file or a switch-config.json file)

./UltimateProxyV2 ConfigName.json   # Linux
UltimateProxyV2.exe ConfigName.json # Windows
  1. Now instead of pointing you workers to the pool address, change it to your proxy IP
  2. Enjoy 😎

To achieve 100% Uptime I strongly recommend one of the following:

  • PM2 process manager: Quick start
  • Docker: You can find a prebuilt example maintained by a community member here

Config file examples

Coin config example

Click to show example
{
  "allowedAddresses": [
    "0.0.0.0"	// This allow every IP to connect to proxy, please remove it before adding only needed IPs
  ],
    "poolList": [
    {
      "address": "de.ethw.herominers.com",
      "port": 1147,
      "ssl": true,	// SSL Pool
      "ratio": 98	// Will mine for 98% of RatioWindowTimeHours before switching
    },
    {
      "address": "de.ethw.herominers.com",
      "port": 1147,
      "ratio": 1,	// Will mine for 1% of RatioWindowTimeHours before switching
      "wallet": "solo:ANOTHER WALLET",	// Will use this wallet instead of global Wallet (Note: "solo:" is used to solo mine on herominers)
      "password": "ANOTHER PASS"	// Will use this password instead of global Password
    },
    {
      "address": "192.168.1.30",
      "port": 8545,
      "node": true,	// Solo mining to node
      "ratio": 1	// Will mine for 1% of RatioWindowTimeHours before switching
    },
    {
      "address": "ethw.2miners.com",	// Will be only used as failover since no ratio is set
      "port": 2020
    }
  ],
  "Protocol": "Stratum", // The mining protocol used (Ethproxy/Stratum/Nicehash)
  "Coin": "ETHW",	// The coin you want to mine
  "Wallet": "YOUR WALLET HERE",	// Your mining wallet
  "Worker": "UltimateProxy",	// Proxy worker name
  "Password": "x",	// Proxy password
  "RatioWindowTimeHours": 1,  // Used for ratio switch strategie, minimum 1H maximum 24H
  "ProxyPort": 4444,	// Proxy port
  "ProxyCert": "",	// Set it if you want your workers to connect to proxy using SSL (See "Docs" folder create a .pfx file)
  "PrintStats": true,	// Display workers/pools stats
  "StatsIntervalSeconds": 60,	// Delay between PrintStats
  "NodeGetWorkIntervalMs": 500,	// Delay between node solo getWork requests
  "PrintJobs": true,	// Print new jobs or not
  "AllowDuplicateWorkerNames": false, // If you use duplicate worker names (workers will be deleted from stats table on disconnection)
  "SendStaleShares": true, // If we should send stale shares to pool
  "ForceWorkersReconnect": false // Reconnect workers on switch, NEED to be turned on if you use Stratum/Nicehash protocol and that your miner doesn't support set.extranonce request
}

Smart Switch config example (Ethash)

Click to show example
{
  "Coins": [
    "ETHW",
    "EXP",
    "QKC",
    "CLO"
  ],
  "Mode": "PROFIT",
  "MinimumTimeSeconds": 900,
  "MinimumDifferencePercent": 1,
  "ConfigList": [
    {
      "Coin": "ETHW",
      "FileName": "config-ETHW.json"
    },
    {
      "Coin": "EXP",
      "FileName": "config-EXP.json"
    },
    {
      "Coin": "QKC",
      "FileName": "config-QKC.json"
    },
    {
      "Coin": "CLO",
      "FileName": "config-CLO.json"
    }
  ]
}

Smart Switch config example (ETHW vs Nicehash ethash)

Click to show example
{
  "Coins": [
    "ETHW",
    "NH Ethash"
  ],
  "Mode": "PROFIT",
  "MinimumTimeSeconds": 900,
  "MinimumDifferencePercent": 1,
  "ConfigList": [
    {
      "Coin": "ETHW",
      "FileName": "config-ETHW.json"
    },
    {
      "Coin": "NH Ethash",
      "FileName": "config-NH-Ethash.json"
    }
  ]
}

Non-exhaustive list of compatible services

Mining softwares

Pools


Don't hesitate to:

  • Ask questions
  • Report bugs
  • Give ideas
  • Criticize anything

Thank you for reading all this, and happy mining !


Note

The software contain a 0.8% DevFee (30s every hour)