.Net Bitcoin, Litecoin, Dogecoin and Bitcoin-Clones Library & RPC Wrapper in C#
- Fully compatible and up-to-date with Bitcoin 0.10.0 RPC API.
- Design-by-contract, service-oriented architecture.
- Strongly-typed structures for complex RPC requests and responses.
- Implicit JSON casting for all RPC messages.
- Extended methods for every-day scenarios where the built-in methods fall short.
- Exposure of all RPC API's functionality as well as the extended methods through a single interface.
- Fallback mechanism for timed-out RPC requests.
- Custom RPC exceptions.
- Available on NuGet.
- Supports all Bitcoin clones.
- Can operate on unlimited daemons with a single library reference.
- Bitcoin, Litecoin and Dogecoin integrations included.
- Each coin instance can be fully parametrized at run-time and implement its own constants.
- Console test client with demo methods implemented in it.
- Disconnected raw RPC connector included for quick'n'dirty debugging.
- Handles and relays RPC internal server errors along with their error code.
- Can be configured to work without a .config file.
- Test Network (testnet) and Regression Test Mode (regtest) ready.
- Mono compatible.
- Fully configurable.
-
Locate your
bitcoin.conffile (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
-
Call
bitcoind -reindex -txindex -debug=net -printtoconsoleand wait until it's finished re-indexing (it might take a while). Append-testnetif you want to run it for Testnet. You need to do this just once. -
Shut down bitcoind and run it again with these arguments:
bitcoind -daemon -debug=net -printtoconsole. Append-testnetif you want to run it for Testnet. Wait until it is fully synchronized. -
Edit the
app.configfile in the Console test client to best fit your needs. Make sure you also update thebitcoin.confwhen you alter theBitcoin_RpcUsernameandBitcoin_RpcPasswordparameters. -
You're good to go.
-
Perform the same steps as those mentioned above for Bitcoin.
-
Litecoin configuration file is:
litecoin.confunder:%AppData%\Roaming\Litecoinand 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).Parametersto fully configure each coin pointer at run-time.
Sample configuration:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<appSettings>
<!-- BitcoinLib settings start -->
<!-- Shared RPC settings start -->
<add key="RpcRequestTimeoutInSeconds" value="10" />
<add key="RpcResendTimedOutRequests" value="false" />
<add key="RpcTimedOutRequestsResendAttempts" value="5" />
<add key="RpcDelayResendingTimedOutRequests" value="true" />
<add key="RpcUseBase2ExponentialDelaysWhenResendingTimedOutRequests" value="true" />
<add key="RpcUnlockWalletImplicitlyWhenRequired" value="true" />
<!-- 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>
Please use GitHub's Issues. Premium support is also available here.
This library took a significant amount of time and effort to build and requires continuous maintenance in order to keep up with changes introduced with every new Bitcoin-Core release. Keep it alive by donating at: 14cSZjrLSWU1QX7DsKr2ogAfULq9pbgQG3
The web test client is not maintained anymore. The latest operating version can be found here.
BitcoinLib is released under the terms of the GPLv3 license. See LICENSE for more information or see http://opensource.org/licenses/GPL-3.0.
Thanks to everyone who contributed to making this library better: OperatorOverload, Angelos Leoussis, Shaun Barratt, Nikos Baxevanis, everyone who reported any issues, et al. Influenced by Bitnet by Konstantin Ineshin, BitcoinRpcSharp by BitKoot and Bitcoin-wrapper by Lars Holdgaard.