# knuth ![Github Releases][badge.release] ![Build status][badge.Travis] ![Build Status][badge.Appveyor] ![CPP][badge.cpp] ![Telegram][badge.telegram] ![Slack][badge.slack] > High performance Bitcoin development platform. Knuth is a high performance implementation of the Bitcoin protocol focused on users requiring extra performance and flexibility, what makes it the best platform for wallets, exchanges, block explorers and miners. ## Multiple cryptos Knuth supports the following cryptocurrencies in the same code base: - [Bitcoin Cash (BCH)](https://www.bitcoincash.org/) - [Bitcoin (BTC)](https://bitcoin.org/) - [Litecoin (LTC)](https://litecoin.org/) Choosing a cryptocurrency is just as simple as changing a switch in our build system, [take a look here](#getting-started). Also, given its modular design and beautiful code, Knuth allows you to implement other cryptocurrencies with very few code changes. ## Not just a node Knuth is a multi-crypto full node, but it is also a development platform. Knuth's core is written in C++17, on top of it we provide a set of libraries and modules written in various programming languages that you can use as basis for building your application. At the moment we have libraries in the following languages: [C++](https://github.com/k-nuth/node), [C](https://github.com/k-nuth/c-api), [C#](https://github.com/k-nuth/cs-api), [Python](https://github.com/k-nuth/py-api), [Javascript](https://github.com/k-nuth/js-api) and [Golang](https://github.com/k-nuth/go-api). You can build your own library in the language of your choice on top of our [C library](https://github.com/k-nuth/c-api). ## Performance matters We designed Knuth to be a high performance node, so our build system has the ability to automatically detect the microarchitecture of your processor and perform an optimized build for it. For those who don't want to wait for compilation times, we provide pre-built binaries compatible with [Intel's Haswell microarchitecture](https://en.wikipedia.org/wiki/Haswell_(microarchitecture)). But you don't have to worry about that, our build system will do everything for you. ## Modular architecture Knuth is based on a modular architecture simple to modify, expand and learn. Any protocol change can be introduced in Knuth much faster and more efficiently than in reference implementations. ## Cross-platform Knuth can be used in any computer architecture and operating system, it only requires a 64-bit system. Knuth has been well tested on x86-64 processors and on the following operating systems: FreeBSD, Linux, macOS and Windows. However, it is not limited to these, Knuth can be used in any computer architecture and any operating system, the only requirement is a 64-bit system. If you find a problem in any other platform, please [let us know](https://github.com/k-nuth/kth/issues). ## Getting started Install and run Knuth is very easy: 1. Install and configure the Knuth build helper: ``` $ pip install kthbuild --user --upgrade $ conan config install https://github.com/k-nuth/ci-utils/raw/master/conan/config.zip ``` 2. Install the appropriate node executable: ``` # For Bitcoin Cash (default) $ conan install kth/0.X@kth/stable -o currency=BCH --update # For Bitcoin $ conan install kth/0.X@kth/stable -o currency=BTC --update # For Litecoin $ conan install kth/0.X@kth/stable -o currency=LTC --update ``` (`0.X` is an alias for our latest uploaded package) 3. Run the node: ``` # Initialize the database $ ./kth -i # Run the node $ ./kth ``` For more more detailed instructions, please refer to our [documentation](https://k-nuth.github.io/docs/). ## Roadmap Our goal is to become a reliable implementation for use in mining and the one with the best APIs, so we need to: - Implement the Bitcoin-Cash-Node and Bitcoin-Core testing batteries, to ensure compatibility with them. - Remove the limitation of 25 chained transactions. - Implement a high performance SLP full indexer within the node. - Improve libraries and APIs of languages. - Create a high performance mining API (a high performance API should not be on top of HTTP). - Improve our APIs documentation. ## Donation We believe that the feature-by-feature funding model proposed by [Bitcoin Verde](https://read.cash/@joshmgreen/bitcoin-verdes-response-to-the-miner-sponsored-development-fund-34028b1e#funding-bitcoin-verde) fits with our project. Take a look at our [issues](https://github.com/k-nuth/kth/issues) to see if you want to donate towards a specific objective, or you can contact us by [Telegram](https://t.me/knuth_cash), [Slack](https://k-nuth.slack.com/) or info@kth.cash. Our general donation address is: `bitcoincash:qrlgfg2qkj3na2x9k7frvcmv06ljx5xlnuuwx95zfn` ## Documentation We are working to improve the documentation, which is [located here](https://k-nuth.github.io/docs/). ## Issues Each of our modules has its own Github repository, but in case you want to create an issue, please do so in our [main repository](https://github.com/k-nuth/kth/issues). ## Contact You can contact us through our [Telegram](https://t.me/knuth_cash) and [Slack](https://k-nuth.slack.com/) groups or write to us at info@kth.cash. ## Security Disclosures To report security issues please contact: Fernando Pelliccioni (fpelliccioni@gmail.com) - GPG Fingerprint: 8C1C 3163 AAE1 0EFA 704C 8A00 FE77 07B7 4C29 E389 [badge.Travis]: https://travis-ci.org/k-nuth/node-exe.svg?branch=master [badge.Appveyor]: https://ci.appveyor.com/api/projects/status/github/k-nuth/node-exe?svg=true&branch=master [badge.Cirrus]: https://api.cirrus-ci.com/github/k-nuth/node-exe.svg?branch=master [badge.version]: https://badge.fury.io/gh/k-nuth%2Fkth-node-exe.svg [badge.release]: https://img.shields.io/github/release/k-nuth/node-exe.svg [badge.cpp]: https://img.shields.io/badge/C++-17-blue.svg?style=flat&logo=c%2B%2B [badge.telegram]: https://img.shields.io/badge/telegram-badge-blue.svg?logo=telegram [badge.slack]: https://img.shields.io/badge/slack-badge-orange.svg?logo=slack