Skip to content
YSKAR

Guides

Step by step

Everything you need to take part: mining, your wallet and your own node. Pick the way that suits you.

Telegram Mini App

The fastest way in. The Mini App runs inside Telegram; there is nothing to install.

  1. Open @YSKAR_bot in Telegram and start the app.
  2. Tap “Create wallet”. The app shows you 12 words: write them down on paper, in order.
  3. Confirm a few of the words and choose a PIN.
  4. Open the Mining tab and tap “Start mining”. Keep the app open while it computes.

Tip: in the Mining tab you can choose between solo and pool. In the pool you receive smaller amounts more often; solo means rarer but whole blocks.

Android app with mining

The Android app can keep mining in the background and shows your status on the home screen. Because Google Play does not allow on-device mining, this version is available directly from us.

Download the latest version

Installing

  1. On your phone, open the download page and tap the file yskar-wallet-….apk.
  2. Android asks whether apps from this source (for example your browser) may be installed. Tap “Settings” and allow it for this source.
  3. Go back and tap “Install”. Google Play Protect may show a warning; this is normal for apps from outside the Play Store.
  4. Open the app, create a wallet or restore your existing one with your 12 words.

Mining in the background

Android stops background apps to save battery. For uninterrupted mining, set the app’s battery usage to “Unrestricted” (Settings → Apps → YSKAR Wallet → Battery).

Checking the download (optional)

Every release also contains a file ending in .sha256. It holds the checksum of the APK. If the checksum of your download matches, the file is exactly the one we published.

PC miner

The miner runs on Windows, macOS and Linux. It only needs an address – no private key, no wallet, no sign-up. You can safely run it on any computer.

1. Install Node.js

The miner needs Node.js 20 or newer. Download the LTS version from nodejs.org and install it. On Windows, open a new command window afterwards.

2. Get the miner

git clone https://github.com/dabitlex/YSKAR.git
cd YSKAR/miner
node src/selbsttest.mjs

There is nothing else to install. The self-test checks that your computer computes hashes correctly.

3. Start mining

Replace the address with your own YSKAR address (it starts with ysr1). With the pool:

node src/cli.mjs --address ysr1… --api https://yskar-main.dynv6.net --mode pool

Solo instead of pool: leave out --mode pool. Whole blocks, but more rarely.

4. Graphics card (optional)

With an NVIDIA card, add --gpu. This needs the GPU program yskar-cuda; how to build it is described in the repository under node-core/gpu.

Your wallet

Your wallet is created on your device from 12 words. These words are your key: whoever has them can access the funds – on any device, in any YSKAR app.

  • Write the words down on paper, in the right order. No screenshot, no cloud.
  • Keep the paper safe. If you lose your phone, the words restore everything.
  • The PIN only protects the app on this device. It cannot replace the words.
  • To move to a new device, choose “I already have twelve words” and enter them.

Whoever has the 12 words has the funds. Never share them. Nobody from YSKAR will ever ask you for them.

Running a full node

A full node downloads the chain and checks every block itself – proof of work, signatures, balances. It needs Node.js 22 or newer and runs well on a Raspberry Pi.

1. Build

git clone https://github.com/dabitlex/YSKAR.git
cd YSKAR/node
npm install
npm run build

On Windows, use npm.cmd instead of npm.

2. Start and connect to the network

node dist/yskar-node.cjs mine --data ./knoten --seed yskar-main.dynv6.net:8646

The node connects to another node (the seed), loads the chain and checks it block by block. Other nodes can reach yours on port 8646 if you open it in your router; this is optional.

3. Mine against your own node

node src/cli.mjs --address ysr1… --api http://127.0.0.1:8645

4. Run a pool (optional)

Any node can be a pool, without registration. The block itself pays all participants; you never hold anyone else’s funds.

node dist/yskar-node.cjs mine --data ./knoten --pool my-pool-name \
  --pool-fee 100 --pool-payout ysr1…

--pool-fee is in basis points: 100 = 1.00 %, at most 500.

5. As a service on a Raspberry Pi

So the node starts on its own after a restart, set it up as a systemd service. The ready-made files and a guide are in the repository under deploy/.