MRR Tools Guide

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

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

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: not required by the current version; reserved for future rental-management functions.

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.

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

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

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

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.

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

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.

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;
• 💬 — message sent after automatic compensation;
• ⏱ — automatic compensation extension.

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.

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.

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.

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 compensation 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 compensation 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 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.

About 15 minutes before rental end, MRR Tools checks average performance. Below 96.5%, it calculates compensation as:

The calculation considers the original duration, current MRR data, renter and owner extensions, previous MRR Tools extensions and persistent local records. Time already added by the renter is subtracted from the outstanding compensation.

Long rentals may be recalculated more than once. An automatic extension produces one automatic event and is not duplicated as a manual-extension notification.

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 auto extension is a per-rig override and is checked by default until the user explicitly enables the feature.

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.

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.

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.

Every account always has two human-readable text logs:

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.

General settings

Main menu → General settings… controls refresh, sound and tray behaviour. By default, minimizing hides MRR Tools in the notification area and new log events blink its icon; automatic window restoration is off. The tray menu can reopen the window at its previous size and position, toggle sound or exit. Starting MRR Tools again activates the existing instance instead of launching duplicate monitoring and automation.

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.

Add an account

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

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.

• MRR API credentials are stored locally as one Windows DPAPI-encrypted pair.
• They are bound to the current Windows user and installation.
• MRR credentials are never uploaded to the website or Telegram relay.
• 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.