monero-ccs-proposals/monero-bash.md
2022-04-06 17:15:38 +00:00

4.5 KiB

layout title author date amount milestones payouts
wip monero-bash, a wrapper for monero written in bash, for Linux hinto-janaiyo March 24, 2022 10.0 XMR
name funds done status
Integrated P2Pool Mining 5 XMR unfinished
name funds done status
RPC/Daemon API integration 3.5 XMR unfinished
name funds done status
Mining quickstart commands 1 XMR unfinished
name funds done status
Automated encrypted wallet backup 0.25 XMR unfinished
name funds done status
Auto GPG key verification for binaries 0.25 XMR unfinished
date amount
date amount

Intro

Hi everyone, I'm hinto. This is my first CCS Proposal.

I would like to develop directly for Monero, but unfortunately: I cannot code. With that said, I've setup Monero nodes and miners on many machines for others and myself, and after a while, ended up making tons of Bash scripts to automate these processes.

I rewrote a couple scripts to make them usable by anyone and put them in the public:

I'd like to receive support through this CCS to continue on a more ambitious project: monero-bash

What

monero-bash is a wrapper for monero written in bash, for Linux.

monero-bash does what bash normally does: it glues together multiple programs in a more automatic fashion, in this case:

  • monerod
  • monero-wallet-cli
  • monero-rpc
  • (p2pool planned...)

monero-bash abstracts monero-cli commands into interactive prompts and linux-like syntax

while monero-bash is helpful for people who want everything automated, it's also just as powerful as monero-cli because:

it is essentially a bunch of bash scripts invoking monero-cli

and so, any monerod.conf or monero-wallet-cli.conf that may be in your .bitmonero folder, can be used by monero-bash

Features

currently implemented:

  • Automatic monero release upgrades, verified with SHA256SUMS
  • Software and wallet management
  • Easy wallet/daemon control
  • Price stats from API

to be added:

  • Automatic P2Pool mining
  • RPC/Daemon API integration
  • Mining quickstart commands
  • Encrypted wallet backups
  • GPG key verification for binaries

Issues

monero-bash runs into problems much like systemd: There are massive conveniences to having a single program manage and abstract everything for an end user, however, that funnels all the trust onto that single program. Although... systemd is a highly adopted system-manager on Linux, monero-bash is a niche script-system for Monero from some random person. So, the question might be asked:

But, Why?

I think something like monero-bash would give a nice and easy bootstrap to people who normally wouldn't have manually setup a node or setup P2P mining. Another (maybe selfish) reason is that I'm making this to actually use it myself! Running monerod, monero-wallet-cli, monero-rpc, XMRig and P2Pool on multiple headless machines makes me wish there were a more central program to manage it all.

Security

As the person who will be making this, I obviously have no problems using it, however, even I would be wary of using other's supposedly "safe" scripts to manage sensitive things like Monero. Thankfully since it's just Bash, anyone that uses Linux (or macOS,BSD) will most likely be able to audit everything. If there are spooky looking functions or variables, I'd be happy to explain its purpose and what it does. If something looks over-complicated, it's not on purpose, I'm just bad at bash.

End-Game & Proposal

I'd like for:

  • Running a Monero Node
  • Managing Wallets
  • Upgrading and Verifying Monero-CLI Binaries
  • Mining on P2Pool as the Default

to be as simple as running a couple commands.

I'll be working for however long it takes to satisfy these milestones:

  • 5.0 XMR: Integrated P2Pool Mining
  • 3.5 XMR: RPC/Daemon API integration
  • 1.0 XMR: Mining quickstart commands
  • 0.25 XMR: Automated encrypted wallet backup
  • 0.25 XMR: Auto GPG key verification for binaries

for a total of 10XMR, regardless of fiat pricing.

For full details of the current version, here is the GitHub. Feedback would be appreciated.