YSKAR

Guides

Step by step

Everything explained step by step: mining on the phone and on the PC, your wallet, your own node and your own pool.

Which way suits you?

There are five ways to take part. All of them use the same wallet: with your 12 words you reach the same balance everywhere.

WayGood forYou need
Telegram Mini AppTrying it out, right awayTelegram
Android appMining in the background on your phoneAn Android phone
Node CoreYour own node with wallet and mining on a PC, graphics card includedWindows 10/11 or Linux (64-bit)
PC minerMining from the command lineWindows, macOS or Linux with Node.js
Full nodeA node or a pool on a Raspberry Pi or a serverLinux, Windows or macOS with Node.js 22.13 or newer

How mining works

YSKAR is a blockchain of its own. A new block is found about every 10 minutes. Whoever finds it receives the reward – currently 875 YSR – directly on their address.

To find a block, your device tries out numbers (double SHA-256). The more computing power you have, the better your chances. The difficulty adjusts to the power of the whole network.

Solo or pool

  • Solo: you search on your own. If you find a block, the whole reward is yours. That can take a long time.
  • Pool: many search together. When the pool finds a block, the reward is split by the work contributed. Smaller amounts, but more regularly.

How a pool pays out

The block itself pays everyone directly. The pool operator never holds your money, and there is no payout threshold.

What counts is the work of the recent past, measured in shares. If you have only just started, your part of the first block is correspondingly small.

  • A block can pay out at most 64 addresses, so a pool has at most 64 places (63 when it takes a fee). A place counts only while you mine: a new device holds it on trial for 2 minutes and keeps it by delivering shares regularly. Places of miners who stop become free again.
  • The operator may take a fee between 0 and 5 %. It is shown in the pool list.

Nobody can promise you a return. How often you receive something depends on your computing power, on the power of the network and on chance.

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 keeps mining in the background, even with the screen locked, and shows your mining in a widget on the home screen. Because Google Play does not allow on-device mining, this version is available directly from us.

Download the latest version

On your phone this app is called “YSKAR Wallet”. It is a different app from the new YSKAR Wallet without mining, and both can be installed side by side; your 12 words work in both.

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.

Starting mining

  1. Open the Mining tab and scroll to “Controls”.
  2. Choose the mode: Solo or Pool. In pool mode the app suggests an open pool; tap “Change” to see all pools with their miners, hash power, blocks found and fee. A full pool cannot be selected.
  3. Set “Workers” and “Duty cycle”. Workers are the processor cores that compute; the duty cycle sets how hard they work (25 to 100 %).
  4. Tap “Start mining”. If Android asks about notifications, allow them: that is how you see that mining is running, and you can stop it from there.

Our recommendation: all workers, duty cycle 25 %, in the pool. That is easy on battery and temperature, and in the pool smaller amounts arrive more regularly. “Calibrate device” finds the best number of workers for your phone.

Mining in the background

Since version 1.0.9 a dedicated service inside the app does the computing. Mining continues when you leave the app or lock the screen. While it runs, Android shows a notification with your hashrate; “Stop mining” ends it right there.

Some devices still close background apps to save battery. If mining stops on its own, set the app’s battery usage to “Unrestricted” (Settings → Apps → YSKAR Wallet → Battery).

Widget on the home screen

Press and hold an empty spot on the home screen, choose “Widgets” and drag “YSKAR Wallet” onto the screen.

While mining runs, the widget shows what you have earned in this session, plus hashrate, runtime and accepted shares. “Stop” ends mining straight from the home screen. When mining is stopped, you see the current block, the network hashrate and the block reward.

“Earned this session” counts the block rewards and pool payouts credited to your address since you started; the value changes when a new block is found. Choose light or dark in the app under Settings → App → Widget. The widget in this form is available from version 1.1.0.

Updating the app

When a new version is available, the app shows a notice when you open it. Tap “Download”: the app fetches the update, then Android asks whether to install it. Your wallet is kept. To check by hand, go to Settings → App → Updates in the app.

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.

Node Core for Windows and Linux

Node Core is the YSKAR program for Windows and Linux: your own node with wallet and mining in one window. It downloads the blockchain to your PC and checks every block itself.

Download for Windows Download for Linux (.deb)

v1.1.0 · Windows 10 or 11 (64-bit) · 95 MB · Linux 64-bit · Ubuntu, Debian, Mint · 93 MB · AppImage for other Linux distributions · Checksum and release notes

A laptop on a wooden desk at night, running YSKAR Node Core; behind it a window onto a dark fjord.
Example view – the numbers are examples.

What you need

  • Windows 10 or 11 (64-bit) or Linux (64-bit, x86-64) and an internet connection
  • Disk space for the blockchain. It is still small and grows with every block.
  • For mining with a graphics card: an NVIDIA, AMD or Intel card with a current driver. Without one, the processor does the work.

Installing on Windows

  1. Download the installer and run it.
  2. Windows shows “Windows protected your PC” because the installer is not signed. Choose “More info”, then “Run anyway”.
  3. Follow the installer. Node Core starts afterwards.

To be sure the file is the one we published, compare its checksum with the .sha256 file of the release. In PowerShell:

Get-FileHash .\YSKAR-Node-Core-Setup-1.1.0.exe -Algorithm SHA256

Installing on Linux

Ubuntu, Debian, Linux Mint: download the .deb file and install it in a terminal. Then start “YSKAR Node Core” from the application menu.

sudo apt install ./YSKAR-Node-Core-1.1.0-amd64.deb

Other distributions: download the AppImage, make it executable and start it. AppImages need FUSE 2 (on Ubuntu the package libfuse2).

chmod +x YSKAR-Node-Core-1.1.0-x86_64.AppImage
./YSKAR-Node-Core-1.1.0-x86_64.AppImage

Node Core for Linux runs on 64-bit PCs (x86-64) with a desktop. ARM computers such as the Raspberry Pi are not supported.

On Linux:

sha256sum -c YSKAR-Node-Core-1.1.0-amd64.deb.sha256

First start

  1. Node: data folder, ports and seed are filled in. The defaults suit most people – just click “Continue”.
  2. Wallet: create a new wallet and write down the 12 words, or bring your existing wallet over with your 12 words. Choose a password of at least 8 characters; it encrypts the words on this PC. You can also set up the wallet later.
  3. Start: click “Start node”.

On the first start Windows asks whether Node Core may access the network. Allow it, otherwise the node cannot find other nodes.

On Linux there is no such prompt. If a firewall is active (such as ufw), allow port 8646 – otherwise other nodes cannot reach yours. Your own connections work either way.

The first synchronisation

On the first start Node Core downloads the whole blockchain and checks every block. That can take a while; the overview shows the progress. Mining only starts once the node has caught up with the network.

Wallet

  • Send: enter recipient and amount, review, confirm with your password. The password is asked before every transfer.
  • Receive: show your address or its QR code.
  • Contacts: names instead of addresses, stored only on this PC.
  • Lock: the wallet locks itself after 10 minutes without activity and whenever Windows is locked. You can change the time in the settings.

Mining

  1. Choose the target: Solo or Pool. In pool mode pick a pool from the list, or enter an address under “Your own pool address” and check it.
  2. “Reward goes to”: your own wallet or another address.
  3. Choose the device: processor, graphics card or both. Set the number of cores and the load per core.
  4. Solo only: if you like, enter a name that appears in the blocks you find. It is public and permanent.
  5. Click “Start mining”.

If a pool no longer accepts you, mining stops and tells you why. It never silently continues solo.

Settings

  • Start with Windows (on Linux: “Start when you log in”): Node Core starts without a window when you sign in.
  • Keep running when closed: the window disappears into the notification area next to the clock, the node keeps working.
  • Resume mining after start: mining continues with the last settings as soon as the node is in sync.
  • Updates: Node Core tells you when a new version is available. Nothing is installed by itself.

Signing and YSKAR Lab

Since version 1.1.0, “Sign” in the wallet signs a text with your address, for example to prove that an address is yours; “Verify” checks a signed message from someone else. On lab.yskar.app, “Sign in with wallet” opens Node Core: it shows the website, your address and how long the request is valid, and signs only after you confirm with your password. A signature cannot move YSR.

Updating

Download the new installer, quit Node Core – also in the notification area – and run the installer. Your wallet and the blockchain are kept.

Do I have to open a port?

No. Without it your node connects to other nodes by itself. If you forward port 8646 in your router, other nodes can reach yours as well. That helps the network but is optional.

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://pool.yskar.app --mode pool

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

4. Graphics card (optional)

With a graphics card, add --gpu. This needs a GPU program: yskar-cuda for NVIDIA cards, yskar-opencl for AMD and Intel cards. The miner takes the first one that finds a card; --gpu-api opencl uses the AMD and Intel program even if an NVIDIA card is present. For Linux both are attached to every Node Core release (yskar-cuda-…-linux-x86_64, yskar-opencl-…-linux-x86_64); on Windows, build them as described in the repository under node-core/gpu.

5. Mining rigs with HiveOS

For mining rigs with HiveOS there is a ready package: this miner with the GPU program, one miner per graphics card from NVIDIA, AMD or Intel, no fee. It is attached to every Node Core release as yskar-hiveos-….tar.gz. How to set up the flight sheet is described in hiveos/README.md.

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.

Sending

  1. Recipient: paste the address, scan the QR code or choose a contact. A YSKAR address starts with ysr1.
  2. Amount, and a note of up to 32 bytes if you like – that is 32 plain Latin letters, fewer with accents or other scripts. The note is stored publicly in the blockchain.
  3. Fee: the app suggests it. When the network is not busy, the minimum fee is enough for the next block.
  4. Review: the app shows the full address and tells you whether you have sent there before. Confirm with your PIN or fingerprint.

A payment that has been sent cannot be taken back. Check the whole address before you confirm.

Receiving

Show your address or its QR code. You can add an amount and a note to the code; the sender then only has to confirm. You may share your address with anyone – your 12 words with nobody.

Contacts and history

Contacts give addresses a name; they are stored only on your device. The history shows every payment; mining income of one day is bundled into one line and can be opened down to the single block.

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.13 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 pool.yskar.app:8646 \
  --seed yskar-seed2.dynv6.net:8646 --no-upstream

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. With --no-upstream your node passes blocks on only to other nodes, not to the project’s web server.

3. Mine against your own node

cd ../miner
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 \
  --seed pool.yskar.app:8646 \
  --seed yskar-seed2.dynv6.net:8646 --no-upstream \
  --pool my-pool-name --pool-fee 100 --pool-payout ysr1…

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

What a pool needs so that the app and other miners can reach it is described under Running a pool.

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/.

Running a pool

A YSKAR pool is not a service with accounts. It is a node that splits the reward of its blocks. Anyone can run one, without registration. What you need depends on who is supposed to mine with you.

Who mines with youWhat you need
You and devices in your home networkNode Core with “Run a pool” switched on
PC miners from the internetA node that runs all the time and can be reached from outside
The app and the Mini AppIn addition HTTPS: a name (domain or DynDNS) and a certificate

In your home network with Node Core

  1. Open “Run a pool”, set name, fee and number of places, and switch it on.
  2. Under Mining choose “Pool”. Your own pool is listed first.
  3. For more PCs switch on “Devices in your home network”. They connect with http://<address of this PC>:8645.

The pool in Node Core answers only your own PC and your own network. It cannot be reached from the internet this way.

For the app, the Mini App and miners from the internet

This is what you need:

  • A node that runs all the time. Best is the command-line node on a Raspberry Pi or a server – see Running a full node.
  • A name under which it can be reached: a domain of your own or a free DynDNS name.
  • HTTPS with a valid certificate. Telegram and browsers do not load anything unencrypted. Without HTTPS no phone reaches your pool.
  • A web server in front that fetches the certificate and passes requests on to the node, for example Caddy.
  • Port 443 open. For a node at home that means a port forwarding in your router.

Start the node as a pool. It listens only on the machine itself; the web server stands in front of it.

node dist/yskar-node.cjs mine --data ./knoten \
  --seed pool.yskar.app:8646 \
  --seed yskar-seed2.dynv6.net:8646 --no-upstream \
  --pool my-pool-name --pool-fee 100 --pool-payout ysr1…

The configuration for Caddy. Replace the name with yours; it must point to your machine first.

pool.example.org {
    reverse_proxy 127.0.0.1:8645
    header Access-Control-Allow-Origin "*"
    header Access-Control-Allow-Methods "GET, POST, OPTIONS"
    header Access-Control-Allow-Headers "content-type"
    @options method OPTIONS
    respond @options 204
}

Check from outside. If the answer contains your pool name and the number of places, the pool is reachable.

curl https://pool.example.org/api/v2/pool

At home or on a rented server?

  • At home: no extra cost. But your IP address becomes publicly known, you need a port forwarding, and your connection carries the load.
  • Rented server: your home IP address stays out of it, and no keys are stored on the server – only the address for the fee. Read the provider’s terms first: many forbid mining or anything related to it. Get the permission in writing.

Rules for every pool

  • Name: 3 to 32 simple characters. It is written into every block of your pool and stays there for good.
  • Fee: 0 to 5 %. In the command --pool-fee is given in basis points: 100 = 1 %. With a fee you must name the address it goes to.
  • Places: at most 64 addresses, with a fee 63 – one recipient is you.
  • No foreign money: the block pays everyone directly. You never hold funds of your miners.

How miners join

In the app choose “Pool” and enter the address of your pool under “Custom address”; in Node Core under “Your own pool address”. With the PC miner:

node src/cli.mjs --address ysr1… --api https://pool.example.org --mode pool

Getting into the pool list

The app and Node Core show a maintained list of pools. For an entry your pool must be reachable over HTTPS and answer /api/v2/pool. Ask for it on GitHub. The list is neither a check nor a recommendation: a pool reports its miners, power and fee itself.

The explorer

The explorer shows every block, every transfer and every address. It reassembles each block header in your browser, hashes it and checks the proof of work and the chain. Transfers, signatures and balances are checked by full nodes – run one, and you do not have to believe anyone.

  • Search by block height, hash or address.
  • For every block you see who found it: a name, a pool or a solo address.
  • Enter your own address to check your payouts.

Security

  • Your 12 words are your wallet. Never type them into a website, never send them to anyone. Nobody from YSKAR will ask for them.
  • Download only from yskar.app and the YSKAR project on GitHub. If you want to be sure, compare the checksum.
  • Keep your software up to date. At an announced rule change, an outdated node either stops at that block or keeps running without checking the new rule – both are reasons to update in time.
  • Running a node: other nodes see your IP address, as in every peer-to-peer network. You do not need a port forwarding. If you do not want your address to be visible, use a VPN.
  • Node Core: wallet and interface can only be reached from your own PC.

If something does not work

Mining on the phone stops by itself

Android is closing the app to save battery. Set the battery usage of YSKAR Wallet to “Unrestricted” (Settings → Apps → YSKAR Wallet → Battery).

“Pool full”

A pool has at most 64 places. A place is freed at once when a miner stops, and up to 20 minutes after a miner goes silent, so trying again later can work. Otherwise choose another pool or mine solo. If your address already has a place, further devices can still join.

Node Core: “No peer connected yet”

The node has not found another node yet. Check your internet connection and whether you allowed Node Core in the Windows firewall prompt. Then wait a moment.

Node Core: mining does not start

The node is still synchronising. Mining starts once the overview shows “In sync”.

The graphics card is not found

Graphics card mining needs an NVIDIA, AMD or Intel card with a current driver. Install the current driver from the card maker and restart Node Core. Before a card mines, it runs a self-test; a card that fails is not used.

My balance is missing on a new device

Restore the wallet with the same 12 words, in the same order. A different set of words is a different wallet.

Something else

Ask questions in the community chat on Telegram. Report bugs on GitHub. Never share your 12 words: admins never message you first.

The same fjord at first light: a pale sky over snow-covered mountains and still water.

It's still early here.

Day . The first light is only just coming up over this network. The people who shape it are the ones who are here now.