Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 4.95 KB

README.md

File metadata and controls

79 lines (54 loc) · 4.95 KB
Raw

license

SLIMWALLET

A Portal into the Kobole and Kahawa networks. Provides a view and interaction layer from a browser.

This can be accessed as a hosted application via https://kahawa-testnet.net

Important If you are a chain developer and would like to add support for your chain to the UI, all the local configuration (API types, settings, logos) can be customized in the apps-config package, complete with instructions of what goes where.

overview

The repo is split into a number of packages, each representing an application. These are -

  • apps This is the main entry point. It handles the selection sidebar and routing to the specific application being displayed.
  • apps-electron Desktop app running apps.
  • page-accounts A basic account management app.
  • page-address-book A basic address management app.
  • page-democracy A basic voting app, allowing votes on activate proposals and referenda.
  • page-explorer A simple block explorer. It only shows the most recent blocks, updating as they become available.
  • page-extrinsics Submission of extrinsics to a node.
  • page-js An online code editor with @slimwallet-js/api access to the currently connected node.
  • page-settings A basic settings management app, allowing choice of language, node to connect to, and theme
  • page-staking A basic staking management app, allowing staking and nominations.
  • page-storage A simple node storage query application. Multiple queries can be queued and updates as new values become available.
  • page-toolbox Submission of raw data to RPC endpoints and utility hashing functions.
  • page-transfer A basic account management app, allowing transfer of Units/KOBOs between accounts.

In addition the following libraries are also included in the repo. These are to be moved to the @polkadot/ui repository once it reaches a base level of stability and usability. (At this point with the framework being tested on the apps above, it makes development easier having it close)

  • react-components A reactive (using RxJS) application framework with a number of useful shared components.
  • react-signer Signer implementation for apps.
  • react-query Base components that use the RxJS Observable APIs

Development

Contributions are welcome!

To start off, this repo (along with others in the @slimwallet family) uses yarn workspaces to organize the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.

To get started -

  1. Clone the repo locally, via git clone https://github.com/MJR-Mu7/Slimwallet <optional local path>
  2. Ensure that you have a recent LTS version of Node.js, for development purposes Node >= 16 is recommended.
  3. Ensure that you have a recent version of Yarn, for development purposes Yarn >= 1.22 is required.
  4. Install the dependencies by running yarn
  5. Ready! Now you can launch the UI (assuming you have a local Kobole Node running), via yarn run start
  6. Access the UI via http://localhost:3000

Docker

You can run a docker container via -

docker run --rm -it --name slimwallet -e WS_URL=ws://someip:9944 -p 80:80 slimwallet-js-apps:latest

To build a docker container containing local changes -

docker build -t slimwallet-js-apps -f docker/Dockerfile .

When using these Docker commands, you can access the UI via http://localhost:80 (or just http://localhost)

Desktop App

The main advantage of using Desktop App is that it by default stores encrypted accounts on the filesystem instead of browser's local storage. Local storage is susceptible to attacks using XSS (Cross-Site Scripting). There's no such risk when with files stored on disk.

The desktop app uses the Electron framework. It provides the same features as web app, the only difference being different account storage.

The accounts are stored in the following directories:

  • Mac: ~/Library/Application Support/slimwallet/polkadot-accounts
  • Linux: ~/.config/slimwallet/polkadot-accounts (or $XDG_CONFIG_HOME/slimwallet/polkadot-accounts if $XDG_CONFIG_HOME is defined)
  • Windows: %APPDATA%\slimwallet\polkadot-accounts

For more details on the desktop app, head over to Electron package README.