SETUP · MONITOR · AUTOMATE

MRR Tools Guide

Everything needed to connect your MiningRigRentals accounts, understand performance alerts and safely configure messaging, Telegram notifications and automation.

01

GETTING STARTED

First launch

MRR Tools uses a MiningRigRentals API key and secret. It never asks for your MRR account password.

MRR Tools is a Windows application. As a bonus for Linux users, its Windows EXE can also run under Wine; this is not a native Linux build. Keep the EXE in a writable folder so local data can be stored beside it.

Create an MRR API key

  1. 1
    Sign in to MiningRigRentals and open API Key Management.
  2. 2
    Create a separate API key for MRR Tools.
  3. 3
    Configure the permissions below and save them before copying the key and secret.

Required API permissions

PermissionMinimumRecommendedRule
Balance / WithdrawReadReadWrite and None are prohibited
RentalsReadWriteRead works now; Write prepares the key for future versions
RigsReadWriteRead enables monitoring; Write enables rig-management features; None is prohibited
Balance / Withdraw must always remain Read.

MRR Tools never needs withdrawal Write access. A key with Balance / Withdraw: Write is rejected and is not saved.

Minimum: Read / Read / Read · Full functionality: Read / Write / Write

Rentals: Read is sufficient for monitoring and communication; Write is required to purchase extensions for rigs you rent. Rigs: Read enables monitoring, while Write is required for features that change an owned rig or add owner-funded compensation time. None is not accepted for any category.

Features by permission level

  • Read / Read / Read: monitoring, Telegram alerts, rental messages, event logs, hashrate and rental history, graphs and local automation.
  • Rigs: Write: changing rental availability, editing owned-rig properties and adding automatic compensation time.
  • Rentals: Write: purchasing single or Mass Actions extensions for rigs you rent.

Complete the first-run window

  1. 1
    Read the local credential-storage disclaimer.
  2. 2
    Enter the MRR API key and API secret.
  3. 3
    Choose the refresh interval and whether event sounds are enabled.
  4. 4
    Accept the local-storage responsibility and select Verify & create.

The defaults are a 90-second refresh interval and enabled event sounds. The minimum interval is 30 seconds; excessive API polling may cause temporary API or public IP restrictions.

What verification checks

  • the API key and secret are valid;
  • the permission combination is safe and sufficient;
  • the MRR username can be obtained;
  • the account can be created without exposing credentials.

Permissions are checked while MRR Tools is running

MRR Tools rechecks every account’s API permissions every 2 minutes. If permissions are changed later on the MiningRigRentals website, the change is recorded in the local event log and only the affected functions are restricted.

  • Rigs: Read keeps read-only monitoring available, but every function requiring Rigs: Write—including automatic compensation extensions—is forcibly disabled.
  • Rentals: None restricts rental monitoring and communication.
  • Rigs: None restricts rig monitoring and every rig-management operation.
  • Balance / Withdraw: Write triggers the safety suspension for the entire account until the permission is returned to Read.

Operations that write to MRR perform an additional fresh permission check immediately before the request. Changing permissions outside MRR Tools therefore cannot silently enable an unsafe or unsupported operation.

After the first update, the account tab, Active account status, My rigs, Rented rigs and refresh countdown should appear.

02

OPTIONAL CONNECTION

Telegram notifications

Receive selected MRR Tools events in a private Telegram chat through the server-side relay.

OFFICIAL ALERT BOTMRR Tools Alert Bot@MRRToolsAlertbot
Open bot
  1. 1
    Open MRR Tools Alert Bot, press Start or send /start.
  2. 2
    Copy the pairing code returned by the bot. It is valid for 10 minutes.
  3. 3
    In MRR Tools, open Main menu → Telegram notifications…
  4. 4
    Paste the code into Pairing code and click Pair.
  5. 5
    Wait for Paired, select Send test, then enable the desired alert categories and save.

Available categories

My rigs events

Events related to rigs you own.

Rented rigs events

Events related to rigs you rent.

Rental extensions

Manual and automatic extension events.

Performance alerts

Timed red, yellow and degradation alerts.

Alert disabled rigs

For disabled owned rigs, only Disabled → Ready is relevant.

Category switches affect Telegram delivery only. Local monitoring and readable logs remain active.

Telegram Mini App (0.5b)

With MRR Tools 0.5b paired to the bot, open MRR Tools from Telegram's menu button to view My rigs and My rents, switch between linked MRR accounts, and change the five automation controls for owned rigs. The dashboard refreshes once a minute; a control change is synchronized immediately.

The home screen also shows confirmed and unconfirmed balances from MRR, with coin amounts and a separate approximate USDT total for each. USDT estimates use Binance quotes. Older desktop versions retain the existing pairing and unpairing flow but do not send the data required by the Mini App. The Mini App itself is served from the website and loads its published version in Telegram; desktop EXE updates are separate and require the user to download the new release.

Telegram data sharing

When the Mini App is enabled, MRR Tools sends the dashboard values needed to display rig and rental status, automation states, balances and exchange quotes through the relay. MRR API credentials are not sent.

Remove pairing or troubleshoot

Use Remove pairing to revoke the installation token. If pairing fails, request a new code with /start, confirm it is less than 10 minutes old and check that the bot is not blocked.

03

WORKSPACE

Main window

Every MRR account has a separate workspace with its own rigs, rentals, logs and layout.

ACCOUNT TABS

Multi-account by design

Account tabs use the first ten username characters and can be rearranged by dragging.

RIG TABS

Two clear views

My rigs and Rented rigs can also be rearranged independently.

PER-ACCOUNT LAYOUT

Your preferred balance

Each account remembers its own splitter position between the rig table and event log.

NEW EVENTS

Red means unread

A red exclamation mark appears for an inactive tab with new events and disappears after that tab is opened.

The top status line shows the active account, rented-out count, current rentals, that account’s refresh countdown and the global Performance messages, Greeting, Farewell and automatic-extension states. Event sounds play regardless of which account tab is active.

Rig tables

Tables show rig ID, name, status, conversation state, advertised speed, current speed, effective automation state, algorithm and remaining rental time. Adv. speed is the rig’s advertised hashrate. Speed keeps its rental view (current / average / percentage) during an active rental. Outside a rental it shows one current value, coloured against Adv. speed using the same red, yellow, green and purple performance palette. Cells are read-only: their content can be selected and copied, but not edited.

Main menu → Hide offline rigs or Ctrl+H instantly hides or restores offline rows in My rigs. The filter never affects Rented rigs, monitoring or stored data, and its state is remembered between launches.

In My rigs, double-click the Status cell to enable or disable that rig for rental. MRR Tools shows a 10-second confirmation dialog and makes no change unless you choose Yes. After a successful change, the same rig cannot be switched again for 10 minutes.

Double-click elsewhere in a My rigs row to view its listing, rental limits, advertised speed and BTC, LTC, DOGE, BCH or ETH pricing. With Rigs: Read, the window clearly opens in read-only mode and has no Update button. Rigs: Write enables editing and saving; pool assignments are not changed.

Mass Edit is available for My rigs. Use the # column to select two or more visible rigs; the raised Mass Edit button then appears beside the ID heading. Only checked fields are changed. Before each update, MRR Tools downloads that rig’s current settings and applies the selected values one rig at a time, so unselected values are not overwritten. Price and advertised-speed controls are available only when all selected rigs use one algorithm.

Rented rigs shows the original payment currency and the rig’s current price in that currency. The current price is white inside the configured tolerance, red after a significant increase and green after a significant decrease. Change the tolerance under General settings → Rented-rig price highlight; the default is 2%. If the owner disables that currency or extensions, the row clearly reports that extension is unavailable.

Use the first # column to select two or more rented rigs. The raised Mass Actions button then appears beside ID. It can calculate and purchase the same extension duration for the selected rentals, or send identical text as a separate message to every Rental ID. Separate delivery keeps each rental’s evidence and conversation complete.

Auto column

For My rigs, the Auto column is a compact five-button control. It shows the effective state and lets you change an individual rig without opening its context menu:

  • ! — performance messages;
  • 👋 — welcome message at rental start;
  • 🏁 — farewell message shortly before rental end;
  • 💬 — Extend message, sent after MRR Tools adds time;
  • ⏱ — Extend, the automatic addition of compensation time.

A bright green pressed button is active, a dark recessed button is off, and red means the action is blocked by unavailable API permission. Hover over any button to see its name, effective state, reason and available action. A global switch remains authoritative: enable it in Automatic messages… or Automatic rental extensions… before enabling an individual rig.

04

TIMED EVALUATION

Performance zones

GreenAcceptable performance
YellowReduced performance
RedMajor performance problem

Startup checks

  • Red for 20 minutes after rental start creates a red startup alert.
  • Outside green for 30 minutes after rental start creates a yellow startup alert.
  • A yellow startup message is not sent while the rig remains red.

Drop from green

After a rig reaches green, remaining in yellow or red for 30 minutes creates a degradation event. Brief drops do not immediately disturb the user.

After automatic compensation for poor performance, repeated warnings are suppressed until the rig returns to green.

Hashrate history and recovery analysis

View hashrate history… is available for every owned rig, including disabled and offline rigs. Collection can be disabled globally or per rig in Hashrate history manager…; offline rigs are sampled no more than once every 30 minutes.

The history is hybrid: numeric MiningRigRentals graph points are preferred when available, while local samples provide continuity. The two sources are never interleaved into one line. During an active rental, opening the chart automatically selects the current rental from 10 minutes before its start through the present and refreshes it from MRR. Without an active rental, the normal 6-hour, 24-hour, 3-day and 7-day ranges remain available.

  • range sliders zoom the beginning and end of the visible period;
  • Refresh from MRR performs an immediate manual refresh;
  • active-rental MRR history is refreshed in the background every 30 minutes;
  • Export graph as PNG… saves the visible graph;
  • the history manager can delete one rig’s data, an older period or the complete local database.

The owned-rig recovery analysis never contacts the renter. At 40 minutes it records only a candidate using minutes 10–40. At 60 minutes it confirms the candidate only when a separate 40–60 minute window is also at least 15% below the pre-rental level and at least 70% of samples from minutes 10–60 remain below that threshold. Brief dips disappear without a log or Telegram alert. Confirmed sustained drops are marked by red points directly on the cyan actual-hashrate graph.

After rental end the analysis observes recovery for up to one hour. Protected rental data is not removed before 12 hours after the actual end time, while ordinary graph history may be retained for seven days.

Verified overhash

Overhash verification is disabled by default and can be enabled for an owned rig from its context menu. MRR Tools evaluates the long-term average for the current rental, or an independent three-hour measurement while the rig is idle. A first threshold crossing starts a 60-minute verification period without contacting the user. At its end, the result is always written to the event log; Telegram is notified only when sustained overhash is confirmed.

For a confirmed result, an upward arrow beside Advertised speed shows the recommended speed that would bring the observed average toward the compensation target selected in General Settings.

Rental history and rental cards

Rental history… in an owned rig’s context menu opens the saved rentals for that rig. The list can be filtered to 7, 30 or 90 days, or all locally saved records, and exported as CSV. Double-clicking a row opens a rental card with its duration, available local performance result, confirmed-drop state, recorded MRR Tools timeline and the same corrected interactive graph used by the main history window.

The card can export its graph as PNG and open the MRR conversation for that completed or active rental. If historical measurements were not retained, the card says that no measurements are available instead of substituting a zero value.

05

PRIVATE LOCAL REPUTATION

Rental Notebook and scoring

Rental Notebook lets you build a private reputation history independently of public MRR ratings. Right-click a current or historical rental and choose Add / edit rental note… to assign a score from 1 to 10 and save a free-form note.

  • 1–4: poor, shown in red;
  • 5–7: neutral, shown in white;
  • 8–9: good, shown in green;
  • 10: excellent, shown in cyan.

Use Menu → Tools → Rental notebook… to review all records. Rental scoring… groups them by rented rig, owner or renter and calculates the local average. Records stay on this computer and can be copied to CSV.

Date ranges are saved per account. If Date to is today, it follows the current day after restarting and across midnight; a past end date stays fixed. The Month button selects a moving calendar month. Editing dates manually preserves the chosen start date. Hover over Date to to see whether it follows today.

06

ACCOUNT LEDGER

Transaction History

Every account has a Transaction history tab. Select a date range and optional Type, Currency or Status filters. Balance and Expected balance are loaded directly from MRR.

The account-specific cache is built and updated in the background. The progress line reports completion while the rest of the interface remains available.

  • Double-click a Rig or Rental ID to open its card.
  • Double-click a TXID to open the built-in explorer view.
  • Right-click a TXID to copy the identifier or explorer link.
  • Use Export CSV… to choose the period, fields and field order, inspect the preview and save the report.
07

RENTAL WORKFLOW

Rent rigs and manage profiles

Rent rigs

Open Menu → Tools → Rent rigs… to search the MRR market, build a Rental List and rent one or several compatible rigs. Possible owner rigs… shows other listings that may belong to the same owner.

Pool profiles

Pool profiles… manages saved pools and their order inside MRR profiles. Algorithms with configured profiles are placed first. Mining Profile assignments for owned rigs and Pool Profile assignments for rented rigs are available from the context menu. The selection window shows the chosen profile's pool servers, worker logins and passwords. Passwords stay hidden until you choose to reveal them with the eye button. Profiles are refreshed from MRR whenever the selection window or editor opens.

My MRR score

My MRR score (RPI)… displays the official MRR RPI for each owned rig and sorts by score or Rig ID. RPI is separate from private Rental Notebook scoring.

08

RENTAL COMMUNICATION

Automatic and manual messages

Automatic performance messages

Automatic performance messages are persisted across application restarts, recorded in the event log and optionally mirrored to Telegram.

  • no more than one message per hour;
  • no duplicate after restarting MRR Tools;
  • up to three messages during one long degradation cycle;
  • a new cycle begins only after recovery to green;
  • log entries include rig ID, rig name and rental ID.

For new owned rigs, Disable performance messages is enabled by default. This per-rig override takes priority over the global switch.

Welcome, farewell and Extend messages

Owned rigs can automatically thank the renter when a rental starts and send a farewell about one minute before it ends, including the current average performance. Both courtesy-message types are enabled by default and can be controlled globally or per rig.

After MRR Tools adds compensation time, it can send a separate automatic Extend message. This message has its own global and per-rig switch. All automatic message types use persistent delivery records so restarting the application does not send the same event twice.

Send a message manually

Use Send message to renter under My rigs or Send message to owner under Rented rigs. Choose:

RED — big performance problemYELLOW — some performance problemCustom

Red and Yellow are generated from current rental data. The last Custom message is remembered. The editable message is limited to 1,000 characters.

The footer is always visible below the editor, starts on a new line and cannot be edited or removed. Successful sends are logged; manual-message results are not sent to Telegram. After a successful send, the result window counts down for five seconds and then closes the complete message workflow.

Rental conversations

The communication indicator opens a read-only conversation history with sender names, timestamps, a reply editor, templates and the locked footer. Up to 40 messages are loaded.

PA

INCOME ANALYSIS

Profit Analyzer

Open Tools → Profit Analyzer to analyze selected owned rigs of the active account, or right-click an owned rig and choose Profit Analyzer for its individual report. A report opened from a rig starts calculating immediately for the saved period.

Select Yesterday, Week, Month or Custom. Month starts in the previous month on the day immediately before today's day number: for example, 17 September starts on 16 August; the first day starts on the previous month's final day. Missing dates are clamped to that month's final day. Dates are inclusive UTC dates. Click Calculate; progress appears while the report loads in the background.

Show every transaction displays source payments below the results. Include crossing rentals includes their proportional income using the analyzer's allocation rules. Crossing source payments are labeled separately; their full amounts are not the allocated income. Apply this choice with Calculate. Report choices and rig selections are saved per account.

The report shows cryptocurrency income, historical USDT value, utilization and an estimated comparison with pool mining in USDT and percent. When enough data is available, the result also shows an estimated tolerance in percentage points. If a reliable tolerance cannot be calculated, it is marked unavailable rather than invented. Missing prices or rental data are reported explicitly; an unavailable comparison is not zero profit. Account percentages compare combined income against the combined pool estimate.

09

OWNER COMPENSATION

Automatic extensions

Rigs: Write is required.

Automatic compensation is unavailable with a read-only Rigs permission.

About 15 minutes before rental end, MRR Tools checks the average performance for the complete rental. If it is below the target selected in General Settings, the program calculates the time required to reach that target.

ADDITIONAL TIME(target % − current average %) ÷ 100 × rental duration

The configured target is used everywhere; it is not hard-coded in the compensation calculation.

Compensation has no more than two stages: one primary extension and one control adjustment. The control stage recalculates the remaining time from the updated total rental duration and the latest complete-rental average. A five-minute safety buffer is included when additional time is required.

An optional automatic message can tell the renter how many compensation minutes were added and show the current average performance. It has separate global and per-rig controls.

Disable Extend is a per-rig override and is checked by default until the user explicitly enables the feature.

If the rig remains at zero speed during the checks from 15 through 10 minutes before the end, its behaviour depends on If rig speed is zero before rental end in General Settings. Finish rental and disable Extend adds no time, lets the current rental finish and switches off Extend for that rig. Extend rental by measured offline time keeps Extend enabled and repeatedly adds only the measured offline time; its adjacent Maximum repeats field accepts 1–30 or Unlimited (0). These repeats use their own counter and do not consume the primary or control-adjustment compensation stages available after recovery.

Manual owner-rental extension

Right-click an active rental on My rigs and choose Manual extend…. The dialog shows the current average, configured target, calculated time and projected result before submitting the extension to MRR.

10

LOCAL INTEGRATION

Automation hooks

MRR Tools can launch trusted external programs when an owned-rig rental begins or ends. Start and End hooks are configured separately for each MRR account and run with the current Windows user’s permissions.

Data available to your program

MRR Tools always passes the values below as process environment variables. The optional Arguments field can also pass selected values to the program as positional command-line arguments by using {VARIABLE_NAME} placeholders.

VariableExampleMeaning
MRR_EVENTrental_startedrental_started or rental_ended
MRR_TEST01 for a Test-button run, otherwise 0
MRR_ACCOUNT_IDaccount UUIDLocal MRR Tools account identifier
MRR_ACCOUNT_NAMEnorthgridMiningRigRentals username
MRR_RIG_ID503211MiningRigRentals rig ID
MRR_RIG_NAMEAtlas PrimeRig name at the time of the event
MRR_RENTAL_ID7812042MiningRigRentals rental ID
MRR_ALGORITHMsha256Rental algorithm
MRR_RENTAL_HOURS_LEFT6.25Hours remaining when observed
MRR_RENTAL_STARTISO 8601 timeObserved rental start time
MRR_RENTAL_ENDISO 8601 timeCurrent rental end time
MRR_OBSERVED_ATISO 8601 timeTime MRR Tools detected the event
MRR_TOOLS_DIRC:\MRRToolsDirectory containing MRR Tools

Use placeholders in the Arguments field

Enter placeholders in the order expected by your program. MRR Tools replaces each placeholder immediately before launch and safely quotes every inserted value for Windows.

ARGUMENTS FIELD{MRR_RIG_ID} {MRR_RENTAL_ID} {MRR_EVENT}
VALUES RECEIVED BY THE PROGRAM503211 7812042 rental_started

For a name as an additional fourth argument, use {MRR_RIG_ID} {MRR_RENTAL_ID} {MRR_EVENT} {MRR_RIG_NAME}. You do not need to add quotes around placeholders; MRR Tools handles values containing spaces or special characters.

Read the same values from the environment

CMD and BAT files use %MRR_RIG_ID%. PowerShell scripts use $env:MRR_RIG_ID. EXE and COM programs can read the same values from their process environment even when the Arguments field is empty.

Execution behaviour

  • Start and End hooks run in a background worker, so monitoring and interface updates continue while the external program is running.
  • The first scan after MRR Tools starts establishes the current-rental baseline. It does not launch false Start hooks for rentals that were already active.
  • Each Start or End event is reserved in persistent local state before launch, preventing the same hook from running again after an application restart.
  • The hook’s working directory is the folder containing the selected executable or script.
  • Standard input is disabled. Standard output and error output are captured together; the final result and a compact tail of available output are written to the owned-rig event log.
  • The Test buttons use the same execution path, set MRR_TEST=1 and record the result without pretending that a real rental event occurred.
Only run files you trust.

Python source files are not launched directly. Use a supported executable or command wrapper. Hooks run without a visible console window and have a 180-second limit. On timeout, MRR Tools terminates the complete process tree and records the result in the local log.

11

READABLE HISTORY

Event logs

Every account always has two human-readable text logs:

%username%.myrigs.log%username%.rentedrigs.log

Logs include rental starts and completions, status changes, performance alerts, message results, communication events, extensions, settings changes and automation results. Rental completion includes the final average speed.

Double-clicking an on-screen log event containing a rig ID highlights the matching rig in the upper table and scrolls it into view. Only the latest selected rig remains highlighted; events for missing or deleted rigs do nothing.

Logs contain events, not API credentials. Historical event colours are restored when MRR Tools starts again.

Use the search field above either event log to filter visible records; the adjacent cross clears the filter. General settings… can remove records older than a selected number of days. Set Keep logs to 0 for indefinite retention, or use Delete older entries now for immediate cleanup.

12

CONTROL

Settings and accounts

General settings

Crash recovery (0.5b) can restart MRR Tools automatically after an abnormal exit. The default limit is 3 restarts within 10 minutes; both values and automatic recovery can be changed in General settings. Each restart waits 20 seconds. Once initialization completes and the interface runs for 60 seconds, all restart counters reset. Normal closing does not restart the program. If the limit is reached, recovery stops and displays the location of mrrtools-crash.log; native fault diagnostics are recorded in mrrtools-fault.log.

Main menu → General settings… controls refresh, sound, tray behaviour, rented-rig price highlighting, the compensation target, zero-speed behaviour near rental end, the maximum number of offline-time extensions and log retention. Hover over a setting name or control for a description. By default, zero speed lets the current rental finish and switches off Extend for that rig; minimizing hides MRR Tools in the notification area and new log events blink its icon; automatic window restoration is off.

Ctrl+S toggles sound globally and confirms both states with a beep. New configurations use a 90-second refresh interval. Accounts are polled sequentially on independent schedules; if they cannot fit safely, the interval is rounded upward and the adjustment is reported.

Connectivity and updates

Internet availability is confirmed against public network targets first; an MRR API failure alone is not treated as a lost internet connection. MRR Tools checks for a new version once a day and shows a blinking indicator when one is available. Use Main menu → Check for updates… for an immediate check: an up-to-date result closes automatically after 10 seconds, while an available update offers to open the download page. This check only notifies you and opens the download page; the desktop EXE is never downloaded, installed or replaced automatically. You receive a new desktop version only by downloading it yourself.

Add an account

Every account goes through the same credential, permission and security checks as the first account.

Replace API credentials

Use Manage accounts → Replace API credentials… when an account key or secret changes. The new pair is verified before replacement, so the account and its local settings do not need to be recreated.

Remove an account

Removing an account from the interface can preserve its files. Selecting local-data deletion permanently removes its encrypted credentials, configuration, logs, saved notification and automation state, and interface settings.

Local-data deletion is irreversible.

The deletion checkbox is off by default. Review the selected account carefully before confirming.

13

LOCAL BY DESIGN

Security notes

  • MRR API credentials are stored locally as one Windows DPAPI-encrypted pair.
  • They are bound to the current Windows user and installation.
  • MRR API keys and secrets are never uploaded to the website or Telegram relay. Version 0.5b sends the dashboard values needed by the Telegram Mini App, including rig and rental status, automation states, balances and exchange quotes.
  • The Telegram bot token stays on the server; the PC stores only a revocable encrypted relay token.
  • Balance / Withdraw Write access is rejected during verification.
  • API permissions are rechecked every 2 minutes, and write operations perform an additional check immediately before execution.

The user remains responsible for Windows account security, backups, API permission selection, configured automation files and messages sent through the connected MRR account.

YOU ARE NOT ON YOUR OWN

Still not working?
We will help.

If a key will not verify, Telegram will not pair or a feature behaves differently than expected, the MRR Tools support channel is always ready to help you find the answer.

Notification bot: @MRRToolsAlertbot · Support: @mrrtoolssupport