- Notifications
You must be signed in to change notification settings - Fork38
autonomys/space-acres
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Space Acres is an opinionated GUI application for farming onAutonomys Network.
Current status of the project is Beta.
This means that it should generally work, most happy paths and edge cases are handled, many error cases have reasonablerecovery options, etc.
Current version supports Autonomys Mainnet chain only and doesn't allow to select anything else. It supports upgradingexisting installations from Gemini 3h.
Current features:
- Configuration (reward address, node location, multiple farms, P2P ports and some advanced options)
- Node sync with displayed progress, speed and ETA, network connections
- Farmer plotting/farming piece cache/plotting/replotting progress display and speed calculation
- Farmer auditing/proving performance indicators
- Farmer sector state visualization
- Desktop notifications with rewards and other notable events
- Very easy to use
Upcoming features/capabilities: see open issues, also consider contributing if something is missing!
Seedocs/INSTALLATION.md for details
The project at high level is structured in a few large modules:
backend
handles all the backend functionalityconfig
contains configuration data structure with ability to read, write and validate itfarmer
contains farmer implementation with a wrapper data structure that abstracts away its internalsnetworking
contains networking stack that is shared betweenfarmer
andnode
with a wrapper data structurethat abstracts away its internalsnode
contains consensus node with a wrapper data structure that abstracts away its internalsutils
contains some low-level utilities
frontend
handles majority of frontend logic with each module corresponding to a major application screen/view orfeatureres
contains various non-code resources required for application operation and/or packagingapp.css
contains a few small non-critical tweaks for presentation, it will likely be necessary to ship a GTK4theme with the app in the future to ensure consistent looklinux
contains Linux-specific resourcesmacos
contains macOS-specific resourcestranslations
contains translations to various languageswindows
contains Windows-specific resources
main.rs
handles CLI, instantiates frontend and backend, wiring everything together
Application supports bare minimum configuration and doesn't support operator functionality (not yet anyway).
In order to build this app you'll need to install both dependencies necessary for buildingSubspace andGTK4, including the optionallibrsvg
. Follow their documentation for details.
Then simplycargo run
will get you where to want to be.
Contributions of various kinds are welcome and appreciated.
Zero-Clause BSD
About
Space Acres is an opinionated GUI application for farming on Autonomys Network