Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spacemeshos/smapp

Spacemesh App (Smesher + Wallet) 🏦📊
https://github.com/spacemeshos/smapp

dashboard electron javascript react wallet

Last synced: about 18 hours ago
JSON representation

Spacemesh App (Smesher + Wallet) 🏦📊

Host: GitHub
URL: https://github.com/spacemeshos/smapp
Owner: spacemeshos
License: apache-2.0
Created: 2019-02-05T14:03:04.000Z (about 6 years ago)
Default Branch: develop
Last Pushed: 2024-05-22T08:44:04.000Z (9 months ago)
Last Synced: 2024-05-22T10:35:43.254Z (9 months ago)
Topics: dashboard, electron, javascript, react, wallet
Language: TypeScript
Homepage: https://spacemesh.io
Size: 329 MB
Stars: 128
Watchers: 22
Forks: 37
Open Issues: 89
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

![Latest Release](https://img.shields.io/github/v/release/spacemeshos/smapp)
[![CodeQL](https://github.com/spacemeshos/smapp/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/spacemeshos/smapp/actions/workflows/codeql-analysis.yml)
[![Discord](https://img.shields.io/discord/623195163510046732?label=discord&logo=discord)](http://chat.spacemesh.io/)
[![made by](https://img.shields.io/badge/madeby-spacemeshos-blue.svg)](https://spacemesh.io)
![GitHub License](https://img.shields.io/github/license/spacemeshos/smapp)

Smapp - the Spacemesh App 🏦📊

Smesher UI + Wallet

This repo includes the source code for the `Spacemesh App`. A desktop application for Windows 10, OS X, and Linux which includes a Smesher and a basic wallet. The main artifacts of this repo are the app and an app installer for all supported platforms.

**Important note: Currently, Smapp does not support Hardware Wallets. This feature will be implemented in the future, but until then we highly recommend using [SMCLI](https://github.com/spacemeshos/smcli) to generate the necessary keys for your ledger setup.**

**Also, the Wallet-only mode is temporarily disabled.**

## Installation & Quick Start

Download the latest Smapp release from [Spacemesh Website](https://spacemesh.io/start/).

For the installation guide, [follow this link.](https://spacemesh.io/start/#spacemesh-app)

### Building from Source

Smapp is written in TypeScript and bundled within Electron. You need Node.js (v12) and Yarn to build from the source. Make sure they are available on your system.

1. Clone the repository
2. Read `node/use-version` file: this is the version of `go-spacemesh` that should be used
3. Download the specified version from [Go-spacemesh Releases](https://github.com/spacemeshos/go-spacemesh/releases)
4. Put the binary in either `node/windows`, `node/mac`, or `node/linux` folder, depending on your platform
5. Run `yarn` to install dependencies
6. Run `yarn start` to start the application in development mode

To build and pack the application:

1. Run `yarn build`
2. Run one of the commands depending on your platform:
- `yarn package-win`
- `yarn package-mac`
set env variable `DONT_SIGN_APP=1` to skip notarizing the app,
- `yarn package-linux`

### Arguments

Smapp can be started with additional arguments:

- `--discovery` (string)
_e.g._ `./Spacemesh --discovery=http://localhost:8000/networks.json`
Specifies custom url to a custom networks list. It makes it possible for Smesher to connect to custom networks.
Env variable alias: `DISCOVERY_URL`
- `--pprof-server` (boolean)
_e.g._ `./Spacemesh --pprof-server`
It makes Smapp runs go-spacemesh with the `--pprof-server` flag.
Env variable alias: `PPROF_SERVER`
- `--test-mode` (boolean)
_e.g._ `./Spacemesh --test-mode`
It runs Smapp and the Node under the hood in standalone mode, making it much easier to test and debug the application.
Env variable alias: `TEST_MODE`
- `--check-interval` (number)
_e.g._ `./Spacemesh --check-interval=60` to check for updates every 60 seconds
Smapp checks every N seconds for the software updates and new config.
If a new config arrived — it automatically merges it with the custom User settings and
restarts the Node.
Default: `3600` seconds, or every hour

To run the application in dev mode with the same behavior set env variables instead:

```
PPROF_SERVER=1 DISCOVERY_URL=http://localhost:8000/networks.json yarn start
```

### Environment Variables

#### Connect to custom networks:

```
DISCOVERY_URL=http://localhost:8000/networks.json yarn start
```

Alias for `--discovery` argument.

Deprecated

> To run the application against DevNet you have to set URL to the config file to env variable `DEV_NET_URL`:
>
> ```
> DEV_NET_URL=https://.../config.json yarn start
> ```
>
> To run the application against DevNet in the Wallet Only mode you have to also set the URL (or list of URLs separated by commas) to GRPC API provider to env variable `DEV_NET_REMOTE_API`:
>
> ```
> export DEV_NET_REMOTE_API=https://192.168.0.1:31030
> export DEV_NET_URL=https://.../config.json
> yarn start
> ```

#### Profiling Node

```
PPROF_SERVER=1 yarn start
```

Alias for `--pprof-server` argument.

#### Building Artifacts in CI

Smapp uses two workflows. Both of them build an application for all supported platforms: Windows, macOS, and Linux.

- **PR builds**
Triggered by open Pull Request and any further changes on the branch.
For testing and development purposes only.
Unsigned and can not be trusted.
Artifacts and links a temporary.
Links to artifacts posted by the bot in comments.
- **Release builds**
Triggered by tag `v*`.
Public releases of Smapp.
Signed for macOS and Windows platforms.
Artifacts and links should be permanent.
CI prepares a draft release with links to the artifacts.

---

- [Roadmap & product details](https://product.spacemesh.io/)
- [Platform documentation](https://platform.spacemesh.io/)
- [Spacemesh improvement proposals](https://github.com/spacemeshos/SMIPS)

### Run the Spacemesh app on Ubuntu

We recommend choosing AppImage as it is not possible to embed certain features in the .deb package.
For the Ubuntu platform Electron has an issue with setup, if you want to run it on the Ubuntu > 22.04 platform, please provide ``--no-sandbox`` flag

**command:**
``/opt/Spacemesh/spacemesh_app --no-sandbox``

---

## Troubleshooting

### The first thing to check if you encounter any issues with Smapp

- Check the Release Notes on GitHub - you might find there the information about the known issues and workarounds to them.
- We recommend visiting https://status.spacemesh.io/, to see if Spacemesh Team is already working on this issue.
- Check the Smapp version -it should always come from the official source and be the latest released package, update it if needed.
- If you have the latest version, restart Smapp and check if the issue remains.
- The GPU drivers should be up to date; please check if you have the latest release. For NVIDIA, it should be version 525 (currently).
- Check our [Discord](https://discord.com/channels/623195163510046732/691261757921951756) chats, the issue might have been discussed there.

Additionally:

### Windows:

- The following directories should be removed in case of reinstallation from scratch:

``C:\Users\{USERNAME}\AppData\Local\Programs\Spacemesh`` or your installation path

``C:\Users\{USERNAME}\AppData\Roaming\Spacemesh``
- Remove the PoS data directory if you want to remove/recreate PoS data:

``C:\Users\{USERNAME}\post\{GENESIS_ID}`` or your PoS directory path

Where `{GENESIS_ID}` is first 8 chars from the HexString. Eg `7c8cef2b`
- The latest Visual C++ Redist should be installed
- Check the Firewall settings, and amend them if needed

### Linux:

- The following directories should be removed in case of reinstallation from scratch:

``/opt/Spacemesh`` (deb) or ``~/Applications/Spacemesh-...`` (AppImage) or your installation path

``~/.config/Spacemesh``
- Remove the PoS data directory if you want to remove/recreate PoS data:

``~/post/{GENESIS_ID}`` or your PoS directory path

Where `{GENESIS_ID}` is first 8 chars from the HexString. Eg `7c8cef2b`
- We recommend using AppImage as some features cannot be embedded into a .deb package.
- If you are using Ubuntu, check the OS version. We recommend at least 22.04
- Glibc and other libraries should be up to date

### macOS:

- The following directories should be removed in case of reinstallation from scratch:

``/Applications/Spacemesh`` or your installation path

``~/Library/Application\ Support/Spacemesh``
- Remove the PoS data directory if you want to remove/recreate PoS data:

``~/post/{GENESIS_ID}`` or your PoS directory path

Where `{GENESIS_ID}` is first 8 chars from the HexString. Eg `7c8cef2b`
- Check if the incoming connections aren’t blocked for go-spacemesh

## CLI-tools

These tools are created for debugging and development purposes.
They are not supposed to be used in the production (on real and valuable data).
So use it at your own risk.

### `yarn script:composeTx`

Compose the transaction (and sign if needed).

### `yarn script:decomposeTx`

Decompose the transaction (byte array) to the human-readable structure (JSON)

### `yarn script:readSecrets`

Read secrets from the wallet file.
For example, if you need to export private keys or mnemonics.

### `yarn script:addViewAccount`

Add a public key to the wallet file.
It makes it possible to track someone else transactions and rewards.
Pay attention that Smapp does not fully support such kinds of accounts.
So in case you try to sign a message or publish a transaction — unhandled exceptions will occur.