NBitcoin is the most complete Bitcoin library for the .NET platform. It implements all most relevant Bitcoin Improvement Proposals (BIPs). It also provides low level access to Bitcoin primitives so you can easily build your application on top of it. Join us in our gitter chat room. It works on Windows, Mac and Linux with Xamarin, Unity, .NET Core or CLR. (Porting to Unity should not be that hard if you need it)
The best documentation available is our eBook, and the excellent unit tests. There are also some more resources below.
You can also browse the API easily through the API reference.
With NuGet :
Install-Package NBitcoin
Go on the NuGet website for more information.
The packages support:
- With full features: Windows Desktop applications, Mono Desktop applications and platforms supported by .NET Standard 1.3 (.NET Core, Xamarin IOS, Xamarin Android, UWP and more).
- With limited features: platforms supported by .NET Standard 1.1 (Windows Phone, Windows 8.0 apps).
To compile it by yourself, you can git clone, open the project and hit the compile button in Visual Studio. How to get started ? Check out this article on CodeProject for some basic Bitcoin operations, or this Introduction to NBitcoin video.
Install-Package NBitcoin.Altcoins
Find more information here.
When a new version of NBitcoin, NBitcoin.Altcoins or NBitcoin.TestFramework is released on Nuget, we also upload a separate symbol package (snupkg) with SourceLink enabled. This is enabled from version 4.1.1.73.
This means that it is possible to debug into NBitcoin code, and the source will be fetched transparently from github.
This works on both Visual Studio Code and Visual Studio for Windows.
You need to run at least Visual Studio 15.9. Then, you need to:
- Go in
Tools / Options / Debugging / Generaland turn offEnable Just My Code. - Go in
Tools / Options / Debugging / Symbolsand addhttps://symbols.nuget.org/download/symbolsto theSymbol file (.pdb) locations, make sure it is checked.
You should also check Microsoft Symbol Server or your debugging experience in visual studio will be slowed down.
Now you can Debug your project and step inside any call to NBitcoin.
Inside your launch.json, add the following to .NET Core Launch (console) configuration:
"justMyCode": false,
"symbolOptions": {
"searchPaths": [ "https://symbols.nuget.org/download/symbols" ],
"searchMicrosoftSymbolServer": true
},Now you can Debug your project and step inside any call to NBitcoin.
Find more information here.
You should use at least Unity 2018.2 using Script Runtime Version .NET 4.x Equivalent and Api Compatibility Level .NET Standard 2.0.
You can see more on this post.
Then you need to compile NBitcoin:
git clone https://github.com/MetacoSA/NBitcoin/
cd NBitcoin/NBitcoin
dotnet publish -c Release -f netstandard2.0
Remove-Item -Force -Recurse .\bin\Release\netstandard2.0\publish\runtimes\Then put the libraries of .\bin\Release\netstandard2.0 into your asset folder.
If you need altcoins support, use the same step but with cd NBitcoin/NBitcoin.Altcoins instead.
If you want to use .NET Core, first install .NET Core as documented here.
Then:
mkdir MyProject
cd MyProject
dotnet new console
dotnet add package NBitcoin
dotnet restore
Then edit your Program.cs:
using System;
using NBitcoin;
namespace _125350929
{
class Program
{
static void Main(string[] args)
{
Console.WriteLine("Hello World! " + new Key().GetWif(Network.Main));
}
}
}
You can then run with
dotnet run
We advise you to use Visual Studio Code as the editor for your project.
NBitcoin notably includes:
- A TransactionBuilder supporting Stealth, Open Asset, and all standard transactions
- Full script evaluation and parsing
- A RPC Client
- A Rest Client
- The parsing of standard scripts and creation of custom ones
- The serialization of blocks, transactions and scripts
- The signing and verification with private keys (with support for compact signatures) for proving ownership
- Bloom filters and partial merkle trees
- Segregated Witness (BIP 141, BIP 143, BIP 144)
- Bech32 segwit address implementation with error detection BIP 173
- Mnemonic code for generating deterministic keys (BIP 39), credits to Thasshiznets
- Hierarchical Deterministic Wallets (BIP 32)
- Payment URLs (BIP 21)
Please read our ebook to understand the capabilities.
NBitcoin is inspired by Bitcoin Core code but provides a simpler object oriented API (e.g., new Key().PubKey.Address.ToString() to generate a key and get the associated address). It relies on the BouncyCastle cryptography library instead of OpenSSL, yet replicates OpenSSL bugs to guarantee compatibility. NBitcoin also ports the integrality of Bitcoin Core unit tests with their original data in order to validate the compatibility of the two implementations.
NBitcoin is licensed under the MIT License and we encourage you to use it to explore, learn, debug, play, share and create software for Bitcoin and with other Metaco services.
-
Wasabi: Privacy focused, ZeroLink compliant Bitcoin wallet.
-
StratisBitcoinFullNode: Bitcoin full node in C# https://stratisplatform.com
-
Breeze: Breeze Wallet, the first full-block SPV bitcoin wallet
-
BlockExplorer: A set of projects that can index and query stratis blockchains on the fullnode.
-
BTCPay Server: A cross platform, self-hosted server compatible with Bitpay API
-
NTumbleBit: TumbleBit Implementation in .NET Core
-
BitPoker: Decentralised peer to peer poker, using bitcoin http://www.bitpoker.io
-
Zen-Wallet: Node and GUI for the Zen Protocol. https://www.zenprotocol.com
-
Metaco-Trader: Bitcoin Wallet for advanced user based on a NBitcoin.Server
-
Swarmops: Admin backend for any bitcoin-native or swarm organization http://sandbox.swarmops.com/
-
Nako: A Bitcoin and Altcoin server api that indexes blockchain transactions and addresses
-
NBXplorer: A minimalist UTXO tracker for HD Wallets with bitcoin based altcoin support
-
UnitCurrency: UnitCoin - a hybrid scrypt PoW + PoS based cryptocurrency.
-
Openchain: Openchain node reference implementation. https://www.openchain.org/
-
BreezeProject: Breeze Masternode and Wallet with Breeze Privacy Protocol
-
Geewallet: a minimalistic and pragmatist lightweight wallet for people that want to hold the most important cryptocurrencies in the same application without hassle
-
NBitcoin Github : https://github.com/NicolasDorier/NBitcoin
-
NBitcoin Nuget : https://www.nuget.org/packages/NBitcoin/
-
Intro: http://www.codeproject.com/Articles/768412/NBitcoin-The-most-complete-Bitcoin-port-Part-Crypt
-
Stealth Payment, and BIP38 : http://www.codeproject.com/Articles/775226/NBitcoin-Cryptography-Part
-
How to build transaction : http://www.codeproject.com/Articles/835098/NBitcoin-Build-Them-All
-
Using the NBitcoin Indexer : http://www.codeproject.com/Articles/819567/NBitcoin-Indexer-A-scalable-and-fault-tolerant-blo
-
How to Scan the blockchain : http://www.codeproject.com/Articles/784519/NBitcoin-How-to-scan-the-Blockchain (You can dismiss the ScanState for that, now I concentrate on the indexer)
Please, use github issues for questions or feedback. For confidential requests or specific demands, contact us on Metaco support.
Visual Studio Community Edition : https://www.visualstudio.com/products/visual-studio-community-vs