Skip to content

quicksmesh/QuickSmesh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QuickSmesh 🏃‍♂️

A quick and easy way to mine Spacemesh.

QuickSmesh has been developed to simplify the process of Smeshing (mining for Spacemesh). Unlike other tools like Smapp and go-spacemesh, QuickSmesh aims to provide a user-friendly interface with sensible defaults to make Smeshing super easy.

Please try out QuickSmesh, report any issues you have, and contribute to the project to help make it even better!

Quick Start

Simply download the latest release, unzip and launch the quicksmesh application.

How do I use QuickSmesh?

QuickSmesh provides an easy to use UI which wraps the existing go-spacemesh tools. In order to start Smeshing you will need to run a Spacemesh node and a PoST miner. The two tabs within the interface easily allow to configure and run these two services.

screenshot

Note that QuickSmesh is not a wallet app and cannot store your keys and identities, you will still need to use a separate Spacemesh wallet for this.

Gotchas

QuickSmesh is still in its early stages, so there are a few things to keep in mind:

  • Be very careful of equivocation! Make sure you never run multiple nodes simultaneously which use the same PoST data, this will result in your PoST data's identity being permanently banned by the network. Soon QuickSmesh will warn you if this might happen.
  • QuickSmesh currently does not support generating your own PoST data so at the moment you will need to point QuickSmesh to your pre-existing data. This feature is on our roadmap.
  • You currently will have to manually copy across your PoST data's identity.key file into you Spacemesh node identities directory. In the future QuickSmesh will do this automatically.

Roadmap

Make sure to stay tuned for new future updates!

Progress so far:

  • Configure and run Spacemesh nodes
  • Configure and run PoST service miners
  • View active process logs
  • Automatically configure identity files
  • Use profiler for proof generation settings
  • Setup quick sync
  • Generate PoST data
  • Send GRPC queries and view node status
  • 24 hour network support
  • Dark mode
  • Anything else you can think of!

Contributing

If you would like to contribute please go ahead and create a new pull request!

Transparency

We want QuickSmesh to be trusted and safe to use, and we think transparency is key! Please let us know by raising an issue if you feel like our transparency can be improved.

What are the risks?

QuickSmesh is basically a wrapper for the go-spacemesh tools and there should be no added risks over simply using these tools on their own. The application is self-hosted and does not communicate with any other services on the internet (apart from though go-spacemesh). Please check out the source code to see exactly what the application does!

How do I trust the release binaries?

All release binaries are produced using publicly available GitHub actions within this repo. You can view past builds, download their artifacts and compare these to the corresponding release binaries to verify that they are indeed the same. If you prefer not to use the pre-built binaries you can always run the backend directly using Python or build from source yourself by following these instructions. Note that we do not sign binaries with Microsoft certificates which means you may get "unknown publisher" pop-up warnings on Windows.

What are the links with quicksmesh.com?

quicksmesh.com is a service which provides PoST data downloads aimed at people who don't have easy access to high-end GPUs. You don't have to use quicksmesh.com in order to use the QuickSmesh application as they two separate projects. They do however share the same developers!