bitcoinlib

Bitcoin Core RPC compatible, battle-tested .NET library and RPC wrapper for Bitcoin and Altcoins

cryptean/bitcoinlib
starsStars 347
forksForks 181
watchersWatchers 347
current-versionCurrent version
total-releasesTotal releases 0
open_issues_countOpen issues 3
dateFirst release -
dateLatest release -
updateLast update 2020-12-15

BitcoinLib

.NET Bitcoin & Altcoins library

Features

Support

Premium Support is available by our team of experts at: support@cryptean.com.

License

See LICENSE.

NuGet packages

BitcoinLib is available on NuGet:

Versioning

From version 1.4.0, BitcoinLib follows Semantic Versioning 2.0.0.

Building from source

To build BitcoinLib from source, you will need either the .NET Core SDK or Visual Studio.

Building & running tests

With Visual Studio you can build BitcoinLib and run the tests from inside the IDE, otherwise with the dotnet command-line tool you can execute:

dotnet build

Instructions for Bitcoin

  • Locate your bitcoin.conf file (in Windows it's under: %AppData%\Roaming\Bitcoin, if it's not there just go ahead and create it) and add these lines:
    rpcuser = MyRpcUsername
    rpcpassword = MyRpcPassword
    server=1
    txindex=1
    
  • Edit the app.config file in the Console test client to best fit your needs. Make sure you also update the bitcoin.conf file when you alter the Bitcoin_RpcUsername and Bitcoin_RpcPassword parameters.

Instructions for Litecoin and other Bitcoin clones

  • Perform the same steps as those mentioned above for Bitcoin.
  • Litecoin configuration file is: litecoin.conf under: %AppData%\Roaming\Litecoin and its daemon is: litecoind.
  • Each coin can be initialized by its own interface specification:
    • IBitcoinService BitcoinService = new BitcoinService();
    • ILitecoinService LitecoinService = new LitecoinService();
  • Any bitcoin clone can be adopted without any further installation steps with the use of the generic ICryptocoinService:
    • ICryptocoinService cryptocoinService = new CryptocoinService("daemonUrl", "rpcUsername", "rpcPassword", "walletPassword");
  • Use (ICryptocoinService).Parameters to fully configure each coin pointer at run-time.

Configuration

Sample configuration:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <!-- BitcoinLib settings start -->

      <!-- Shared RPC settings start -->
      <add key="RpcRequestTimeoutInSeconds" value="10" />
      <!-- Shared RPC settings end -->

      <!-- Bitcoin settings start -->
      <add key="Bitcoin_DaemonUrl" value="http://localhost:8332" />
      <add key="Bitcoin_DaemonUrl_Testnet" value="http://localhost:18332" />
      <add key="Bitcoin_WalletPassword" value="MyWalletPassword" />
      <add key="Bitcoin_RpcUsername" value="MyRpcUsername" />
      <add key="Bitcoin_RpcPassword" value="MyRpcPassword" />
      <!-- Bitcoin settings end -->

    <!-- BitcoinLib settings end -->
  </appSettings>
</configuration>

Bitcoin Core resources