Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Latest commit

 

History

History
155 lines (108 loc) · 6.06 KB

README.md

File metadata and controls

155 lines (108 loc) · 6.06 KB
Raw

Subspace Desktop

Standalone Desktop application for farming on Subspace Network (includes both node and farmer). Download and run this application to be a farmer on Subspace Network (currently on testnet).

Archive Notice ⚠️

As of 01-22-2024, this project has been archived and is no longer actively maintained.

What does this mean

  • No Updates: The repository will not be receiving any updates or accepting pull requests. The code is provided as-is.
  • Read-Only: The repository is now read-only. You can still fork, download, or star the repository.
  • No Support: We will no longer be responding to issues or questions regarding this project. However, you may still find community support through existing issues or outside forums.

Why is this project archived?

This project is being archived due to the lack of a sustainable user community and our decision to concentrate our resources on more widely-used projects that are critical to our roadmap towards mainnet.

We believe that focusing our efforts on projects with a broader user base and strategic importance will allow us to make a more significant impact and deliver better value to our community.

Looking Forward

While this project is being archived, we encourage our vibrant community to take the reins! If you've found value in this project and have ideas for its evolution, we wholeheartedly support and encourage you to fork and develop your own versions. This is an opportunity for innovation and creativity – your contributions could lead to something even more impactful.

For those who are looking for alternatives to this project, we recommend exploring Space Acres, which provides similar functionalities. Additionally, we invite you to follow our ongoing projects, which continue to build on the foundations we've laid here. Stay tuned for exciting developments on our journey towards mainnet!

We extend our deepest gratitude to everyone who has contributed to and supported this project. Your engagement and feedback have been invaluable, and we look forward to seeing how the community takes these ideas forward in new and exciting directions.

OS Requirements

Below is not necessarily strict boundaries, but rather what we have tested and confirmed so far.

  • Windows 10 and 11
  • Ubuntu 20.04 and 22.04
  • macOS 11 and 12

How to Install

  1. Download the latest release for your preferred platform.
  2. Install the program.
  3. Open subspace-desktop application.
  4. Click the This is my first time farming option (or, if you want to use an existing reward address, click I've run a farmer before and still have my keys).
  5. Select how much space you want to pledge
  6. When you click start plotting, it may prompt you to store your seed phrase, if you did not import a reward address.
  7. The network will begin to sync and plotting will start. While you wait you can click hints to open up the what is plotting page, and join our online communities from the social links displayed in there!
  8. Once the node fully syncs you will be taken the the Farmer Dashboard which will show you the network/plot status, and your total earned rewards.

How to Upgrade

Upgrade from previous version of Subspace Desktop

  1. Simply uninstall the old application from your computer
  2. Download the latest release for your preferred platform (make sure to select "Latest" release with green label and not "Pre-release")
  3. Install new version of Subspace Desktop
  4. Run the application, it should detect your old plot and continue farming as usual

UNLESS STATED OTHERWISE IN THE RELEASE NOTES:

  • You don't need to delete your existing plot
  • You don't need to create a new identity
  • You don't need to delete the config and log files

Upgrade from CLI (subspace-node + subspace-farmer)

These instructions are for upgrading installation that followed official guide, if you followed unofficial one, ask guide author for proper upgrade steps.

  1. Remove old data to free space used by CLI: 
    # Replace `FARMER_FILE_NAME` with the name of the node file you downloaded from releases
./FARMER_FILE_NAME wipe
# Replace `NODE_FILE_NAME` with the name of the node file you downloaded from releases
./NODE_FILE_NAME purge-chain --chain testnet
    Make sure to replace FARMER_FILE_NAME and NODE_FILE_NAME with actual file names
  2. Delete those files FARMER_FILE_NAME and NODE_FILE_NAME
  3. Install Subspace Desktop
  4. Choose I've run a farmer before and still have my keys on the first screen and use the same reward address (that you used for CLI) there

Development

Prerequisites

  • nodejs 14+
  • yarn
  • rustc

Linux

On Linux you'll have to install development version of libwebkit2gtk-4.0 and libappindicator packages, which can be done on Ubuntu with:

sudo apt update && sudo apt install libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    libssl-dev \
    libgtk-3-dev \
    libappindicator3-dev \
    patchelf \
    librsvg2-dev
  • libappindicator: needed to use the system tray feature.
  • patchelf and librsvg: needed to bundle AppImage.

Stuck?

https://tauri.studio/en/docs/getting-started/intro

Install the dependencies

yarn

Start the app in development mode

Terminal 1

yarn quasar dev

Terminal 2

yarn tauri dev

Build the app for production (Builds Quasar and Tauri)

yarn build

Build the app for production with opencl support (Builds Quasar and Tauri)

yarn build -c ./src-tauri/tauri.conf.opencl.json

Access Tauri or Quasar specific commands

yarn quasar --help
yarn tauri --help

Customize Quasar config

https://v2.quasar.dev/quasar-cli/quasar-conf-js

Customize Tauri config

https://tauri.studio/en/docs/api/config

Contribute to development

Review the ARCHITECTURE.md document for an overview of the application design.