Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k-nuth/cs-api
Bitcoin full node as a C# library
https://github.com/k-nuth/cs-api
Last synced: 2 days ago
JSON representation
Bitcoin full node as a C# library
- Host: GitHub
- URL: https://github.com/k-nuth/cs-api
- Owner: k-nuth
- Created: 2020-01-30T03:29:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T09:49:10.000Z (about 2 months ago)
- Last Synced: 2024-09-10T09:41:18.218Z (about 2 months ago)
- Language: C#
- Homepage:
- Size: 3.48 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# C# API
> Bitcoin Cash full node as a C# library
[](https://www.nuget.org/packages/kth-bch)
[](LICENSE.md)
![Telegram][badge.telegram]
![Slack][badge.slack]
Knuth C# API is a high performance implementation of the Bitcoin Cash protocol focused on users requiring extra performance and flexibility. It is a Bitcoin Cash node you can use as a library.
## Prerequisites
Knuth C# API is a wrapper over our [C++ libraries](https://github.com/k-nuth/node), therefore in order to use the C# library we will need the toolchain to build the C++ libraries. Don't panic, you won't have to manually build our C++ libraries, you just have to provide some prerequisites, our build system will take care of the rest.
* [.NET Standard 2.0 compatible implementation](https://docs.microsoft.com/en-us/dotnet/standard/net-standard). We suggest [.Net Core 3.1](https://docs.microsoft.com/en-us/dotnet/core/install/).
* [Python PIP package-management system](https://pip.pypa.io/en/stable/installing/).
To speed up the compilation, we provide some pre-built C++ libraries for some common computer platforms, but case there are no pre-built binaries for your platform, our build system will automatically try to build from source code. In such a scenario, the following requirements must be added to the previous ones:
* C++17 [conforming compiler](https://en.cppreference.com/w/cpp/compiler_support). Could be [GCC8](https://gcc.gnu.org/), [Clang8](https://clang.llvm.org/) or [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
* CMake building tool, version 3.8 or newer.
## Getting started
1. Create a new C# console project:
```
$ mkdir HelloKnuth
$ cd HelloKnuth
$ dotnet new console
```
2. Add a reference to our C# API package:
```
$ dotnet add package kth-bch
```
3. Edit `Program.cs` and write some code:
```CSharp
using System;
using System.Threading.Tasks;
using Knuth;
namespace HelloKnuth {
public class Program {
private static bool running_;
static async Task Main(string[] args) {
Console.CancelKeyPress += OnSigInterrupt;
var config = Knuth.Config.Settings.GetDefault(NetworkType.Mainnet);
using (var node = new Knuth.Node(config)) {
await node.LaunchAsync();
Console.WriteLine("Knuth node has been launched.");
var height = await node.Chain.GetLastHeightAsync();
Console.WriteLine($"Current height in local copy: {height.Result}");
if (await ComeBackAfterTheBCHHardFork(node)) {
Console.WriteLine("Bitcoin Cash has been created!");
}
}
Console.WriteLine("Good bye!");
}
private static async Task ComeBackAfterTheBCHHardFork(Node node) {
UInt64 hfHeight = 478559;
while (running_) {
var res = await node.Chain.GetLastHeightAsync();
if (res.Result >= hfHeight) return true;
await Task.Delay(10000);
}
return false;
}
private static void OnSigInterrupt(object sender, ConsoleCancelEventArgs args) {
Console.WriteLine("Stop signal detected.");
args.Cancel = true;
running_ = false;
}
}
}
```
4. Enjoy Knuth node as a C# library:
```
$ dotnet run
```
## 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).
[badge.Travis]: https://travis-ci.org/k-nuth/cs-api.svg?branch=master
[badge.Appveyor]: https://img.shields.io/appveyor/ci/Knuth/cs-api.svg?style=for-the-badge&label=build&logo=appveyor&logoColor=white
[badge.GithubActions]: https://github.com/k-nuth/cs-api/workflows/Build%20and%20Test/badge.svg
[badge.Cirrus]: https://api.cirrus-ci.com/github/k-nuth/cs-api.svg?branch=master
[badge.version]: https://badge.fury.io/gh/k-nuth%2Fkth-cs-api.svg
[badge.release]: https://img.shields.io/github/release/k-nuth/cs-api.svg
[badge.c]: https://img.shields.io/badge/C-11-blue.svg?style=flat&logo=c
[badge.telegram]: https://img.shields.io/badge/telegram-badge-blue.svg?logo=telegram&style=for-the-badge
[badge.slack]: https://img.shields.io/badge/slack-badge-orange.svg?logo=slack&style=for-the-badge