Nimiq C# Client
C# implementation of the Nimiq RPC client specs.
Usage
Send requests to a Nimiq node with NimiqClient object.
var config = new Config(
scheme: "http",
host: "127.0.0.1",
port: 8648,
user: "luna",
password: "moon"
);
var client = new NimiqClient(config)
Once the client have been set up, we can call the methods with the appropiate arguments to make requests to the Nimiq node.
When no config object is passed in the initialization it will use the default values in the Nimiq node.
var client = NimiqClient();
// make rpc call to get the block number
var blockNumber = await client.blockNumber();
Console.WriteLine(blockNumber) // displays the block number, for example 748883
API
The complete API documentation is available here.
Check out the Nimiq RPC specs for behind the scene RPC calls.
Installation
To install NimiClient add the Nuget package as a dependency to your project from Visual Studio IDE.
Contributions
This implementation was originally contributed by rraallvv.
Please send your contributions as pull requests.
Refer to the issue tracker for ideas.
Develop
After cloning the repository, open the solution file NimiqClientProjects.sln located in the repository root folder on Visual Studio.
All done, happy coding!
Testing
The project containing all the is in the folder /NimiqClientTest and can be run from the Visual Studio IDE. Alternatively you can run all the tests from the command line from the repository root directory:
$ dotnet test
Documentation
The documentation is generated automatically with DocFX.
Run all the commands from the repository root directory.
First install the DocFX package:
$ nuget install docfx.console -version 2.51.0
Copy the file README.md with the name index.md:
$ cp -r README.md index.md
Run DocFX with the configuration file docfx.json via the mono command:
$ mono docfx.console.2.51.0/tools/docfx.exe docfx.json
Mono is distributed with the .Net SDK, if it isn't already installed download and install the tool from here.