Build on it.
All of YSKAR is open: node, wallets, miners, explorer and this website, under the MIT License. A public API answers without a key.
Read everything
The protocol is specified, the consensus code is short enough to read, and every figure on this site comes from that code or from the chain.
Ask the chain
Blocks, transfers, addresses, fees, pools and supply over plain HTTP. No key, no sign-up, open to any website.
Change it
Proposals go through YSKAR Lab, in public, from the first idea to the release. You sign in with your wallet.
Open YSKAR LabRead the chain over HTTP
The public API answers plain GET requests with JSON. Pick a request and read the answer.
- Read-only and open
- No key and no account. Cross-origin requests are allowed, so a web page can call the API directly.
- Your own node answers too
- Every full node serves the same read routes on port 8645. Point your code at
http://127.0.0.1:8645and you depend on nobody's server. - Amounts are whole numbers
- Amounts come in units: 1 YSR is 100,000,000 units. Read them as integers or strings and never as floating-point numbers.
Run a full node
A full node keeps its own copy of the chain and checks every block itself. It takes nothing on trust, not from other nodes and not from this website.
What a node checks in every block- You need
- Node.js 22.13 or newer and Git. The node stores the chain with the SQLite module built into Node.js.
- Ports
- TCP 8646 for other nodes, 8645 for the HTTP interface that miners and wallets use.
- Clock
- Keep the system clock correct. A block dated more than 120 seconds ahead of your node's clock is rejected.
- Seed nodes
- The command-line node has no seed built in. Name both seed nodes, as in the command above.
--no-upstream- Belongs in the command. Without it the node would also exchange blocks with the project's database mirror, which only accepts blocks from the main node.
On Windows, type npm.cmd in place of npm in PowerShell. If you prefer a window to a terminal, Node Core runs the same full node on Windows and Linux.
The documents
Written for people who want to check the claims. Each one links to the code it describes.
PROTOCOL.md
The protocol specification: formats, hashing, difficulty, validity rules and test vectors.
CONSENSUS_V6.md
The binding specification of revision 6, active from block 10,000.
FULLNODE.md
The command-line full node: commands, options, HTTP interface, storage and reorganizations.
P2P.md
The protocol nodes speak with each other.
FEES.md
The fee rules and how the fee estimate is made.
POOL.md
Pools: joining one, running one, how the accounting works.
OPERATIONS.md
The public infrastructure: main node, HTTPS, mirror and its settings.
SECURITY.md
What cryptography and consensus enforce, what you have to trust, and the known limits.
What is where
One repository holds the consensus code, the node, the miner and the tests that guard them.
- src/lib/core/
- Consensus: header, difficulty, transactions, state, wallet derivation
- src/lib/node/fullnode/
- Full node: chain, mempool, mining interface, read API, command line
- src/lib/node/p2p/
- The node-to-node protocol
- src/lib/pool/
- PPLNS accounting and the split of the block reward
- node/
- Build of the command-line full node
- node-core/
- Node Core for Windows and Linux, with the GPU miners
- miner/
- The command-line miner, without dependencies
- observer/
- The observer: a small read-only tool that downloads the chain and recomputes every block
- tests/
- Tests of consensus, node, P2P, pool and wallet
- docs/
- The documentation listed above
Signed messages
A wallet can prove that it controls an address without moving a coin. All YSKAR software signs and checks the same text format.
- The signature is Ed25519 over the raw UTF-8 bytes of the whole message, checked by the same rule as on the chain.
- The first line makes it safe: a transaction is binary and never starts with these words, so a signed message can never count as a transfer.
- YSKAR Wallet and Node Core sign such messages. YSKAR Lab uses them to sign you in without a password.
Contribute and report
- Changes to the code
- CONTRIBUTING.md says which checks must pass before a push: the type checks and the full test suite.
- Ideas and proposals
- Proposals for the protocol and the software are discussed in the open at YSKAR Lab. You sign in with your wallet.
- Security problems
- Report them as an issue at github.com/dabitlex/YSKAR/issues. Issues are public: describe what you saw and how to reproduce it, and never post your 12 words, a PIN, a wallet file or a key.
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.