diff --git a/README.md b/README.md
index 2ee56ff18..508702c95 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,31 @@
-
+
+[](https://github.com/spacemeshos/smapp/actions/workflows/codeql-analysis.yml)
+[](http://chat.spacemesh.io/)
+[](https://spacemesh.io)
+
ย
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.**
-
-
-)
-
-
-)
+**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.
@@ -49,7 +47,9 @@ To build and pack the application:
- `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.
@@ -64,12 +64,13 @@ Smapp can be started with additional arguments:
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 updates the software updates and new config.
- If new config arrived โ it automatically merges it with the custom User settings and
+ 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
```
@@ -77,35 +78,42 @@ 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
- > ```
+> 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.
#### Sentry
+
```
SENTRY_DSN='collection errors/logs url taken from sentry'
SENTRY_LOG_LEVEL=boolean # enables debug information
@@ -114,7 +122,7 @@ SENTRY_AUTH_TOKEN='special auth token for sentry cli integration'
### Building Artifacts in CI
-Smapp uses two workflows. Both of them build an application for all supported platforms: Windows, macOS, Linux.
+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.
@@ -130,17 +138,18 @@ Smapp uses two workflows. Both of them build an application for all supported pl
CI prepares a draft release with links to the artifacts.
---
-- [Roadmap & product details](https://product.spacemesh.io/)
+
+- [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```
+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``
---
@@ -148,46 +157,42 @@ For the Ubuntu platform Electron has an issue with setup, if you want to run it
### 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.
+- 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.
+- 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).
+- 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:
+Additionally:
-### Windows:
+### 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```
+ ``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
+ ``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:
+### 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```
+ ``/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
+ ``~/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
@@ -196,34 +201,37 @@ Additionally:
- The following directories should be removed in case of reinstallation from scratch:
- ```/Applications/Spacemesh``` or your installation path
-
- ```~/Library/Application\ Support/Spacemesh```
+ ``/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
+ ``~/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.
diff --git a/resources/medium_black_avatar_icon.png b/resources/medium_black_avatar_icon.png
new file mode 100644
index 000000000..e5f9979df
Binary files /dev/null and b/resources/medium_black_avatar_icon.png differ
diff --git a/resources/smapp_app_wallet.png b/resources/smapp_app_wallet.png
index 7e7560f6e..c21f0919c 100644
Binary files a/resources/smapp_app_wallet.png and b/resources/smapp_app_wallet.png differ
diff --git a/resources/transparentbg.gif b/resources/transparentbg.gif
new file mode 100644
index 000000000..b6cce979a
Binary files /dev/null and b/resources/transparentbg.gif differ