Skip to content
Contribute

Nobody owns it. Anyone can improve it.

Genoryn Krypton is open source under MIT or Apache-2.0. There is no company behind it and no team to apply to: changes are proposed in public and judged on what they do. You do not need to be a programmer to help.

Ways to help

Pick what suits you

Code

Build it, test it, send a change

Everything is written in Rust and lives in one repository: github.com/genoryn/genoryn. You need Rust 1.89 or newer and no other toolchain.

git clone https://github.com/genoryn/genoryn
cd genoryn
cargo build --release                                   # node, miner, wallets
cargo test --workspace                                  # all tests
cargo fmt --all -- --check                              # formatting
cargo clippy --workspace --all-targets -- -D warnings   # lints
python website/build.py                                 # this website, into website/dist

Try your change on a private network of your own before you propose it. Never test against other people's funds or nodes:

kryptond --network devnet --no-seeds

Where things are

PathWhat
crates/krypton-coreConsensus, transactions, emission, parameters
crates/krypton-zkThe zk-STARK spend circuit, prover and verifier
crates/krypton-cryptoHashes, ML-KEM, signatures, key derivation
crates/krypton-powKryptoHash proof of work
crates/krypton-p2p, krypton-store, krypton-lightNetwork, storage, light client
crates/krypton-wallet-core, krypton-swapWallet logic, atomic swaps and the offer board
apps/kryptond, krypton-miner, krypton-wallet, krypton-wallet-cliNode, miner, desktop wallet, command-line wallet
docs/specSpecifications
websitegenoryn.io

A good pull request

The full guide is CONTRIBUTING.md. By contributing you agree that your work is licensed like the rest of the project, under MIT or Apache-2.0 at the user's choice.

Review

Where careful eyes are worth most

The software has extensive automated tests and an internal review, and no independent audit yet. If you know cryptography, consensus or Rust, these are the places where a mistake would cost the most:

The spend proofThe circuit that proves a transfer valid, and its zero-knowledge masking: crates/krypton-zk, docs/spec/spend-circuit.md
Consensus and reorganizationscrates/krypton-core/src/consensus.rs, crates/krypton-store
The light wallet's verificationcrates/krypton-light
Keys and the wallet filecrates/krypton-wallet-core
The handshake between nodescrates/krypton-p2p/src/session.rs

If you find something an attacker could use, report it privately.

Documentation

Make it clearer for the next person

Documentation is part of the software: a rule nobody can understand is a rule nobody can check. It lives in three places, all in the repository, all plain text you can edit in a browser on GitHub:

This website

The folder website: one HTML file per page, no framework. python website/build.py builds it. The list of updates comes from website/updates.py.

The README

README.md is the whole project on one page, for people who read on GitHub.

The specifications

docs/spec says exactly what the rules are: the spend circuit, consensus, rewards, the light client, addresses and the network, atomic swaps.

What helps

Translations

Where they stand

Honestly: the wallet and this website exist in English only today, and the wallet has no system yet for showing itself in other languages. Its texts are written into the page it displays, so a translation cannot simply be dropped in.

That is worth changing. Money that only English speakers can read the warnings of is not money for everyone. What would help, in the order it has to happen:

  1. Say which language you would use it in

    Open an issue or add your voice to an existing one. Which languages come first should follow who is there to keep them current.

  2. The wallet has to learn languages

    Its texts need to move out of the page into one file per language, with English as the fallback. That is a code change, and a welcome one: see Code.

  3. Then translate, and keep translating

    A wallet's words are instructions about money. A translation has to be exact, has to keep words like recovery phrase and refund the same throughout, and has to be updated with every release. A language without someone to maintain it is worse than no translation.

Until then, translations of the documentation, written and kept by people who speak the language, are welcome as pages of their own. Mark clearly which version they describe, and link the English original.

Start small

Report one thing that confused you, or fix one sentence. That is how every contributor started.