CHIA-RPC 1.8.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package CHIA-RPC --version 1.8.2                
NuGet\Install-Package CHIA-RPC -Version 1.8.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CHIA-RPC" Version="1.8.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CHIA-RPC --version 1.8.2                
#r "nuget: CHIA-RPC, 1.8.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CHIA-RPC as a Cake Addin
#addin nuget:?package=CHIA-RPC&version=1.8.2

// Install CHIA-RPC as a Cake Tool
#tool nuget:?package=CHIA-RPC&version=1.8.2                

Welcome to the CHIA-RPC Nuget package!

This package is a wrapper for RPC-JSON files used to communicate with the Chia client through the HTTP-API, WebSocket API, or CLI.
The wrapper allows you to easily create the appropriate RPC object for all wallet endpoint calls, and deserialize the response JSON and accessing its objets.

CHIA-RPC ONLY contains the rpc wrappers (.net objects for RPC, Response and Chia Objects) In ;rder to cummiunicate with the chia client, you need to either implement your own client solution or use the Chia-Client-API package which implements all rpc endpoints and supports remote management of the chia client.

Usage

General functions

All classes support the following base functions:

  • SaveToFile(string path): saves the rpc as a json-formatted file to the specified path on disk.
  • LoadFromFile(string path): loads an rpc file from the specified path from disk.
  • ToString(): returns a json-formatted string representation of the class.
  • LoadObjectFromString(string json): converts a json string (eg. response) into a given object.

Types

There are 3 types in this library:

  • EndpointName_RPC these classes represent the request content which is issued against the chia client.
  • EndpointName_Response these classes represent the chia clients response and are beeing used to deserialize the server response into workable c# objects
  • ObjectName these classes represent objects in the chia space such as a CoinRecord, a Transaction and so on

RPC Creation

Most endpoints are implemented with a constructor:

// Create a new instance of the SendXCH_RPC class
var rpc = new SendXCH_RPC(1234, "chia1q2jzm7eg5t2k8vnq3tkkf5l7zj9mfx9v7p9t5", 1000, 500, new string[] { "Transaction from Example program" })

If this is not the case or for whatever other reason, You can also creath them like so:

// Create a new instance of the SendXCH_RPC class
var rpc = new SendXCH_RPC
{
    wallet_id = 1234,
    address = "chia1q2jzm7eg5t2k8vnq3tkkf5l7zj9mfx9v7p9t5",
    amount = 10000,
    fee = 500,
    memos = new string[] { "Transaction from Example program" }
};

Some endpoints already implement Constructors which make things a litte easier:

GetNextAddress_RPC rpc = new GetNextAddress_RPC(1, false);

Some endpoins already have implicit conversions which make working a lot easier. The support is quite sparse still:

WalletID_Response walletID = WalletID_Response.LoadResponseFromString(serverResponse);
GetNextAddress_RPC rpc = new GetNextAddress_RPC(walletID);

Serialisation

in order to work with the rpcs, you want to serialize/deserialize them to and from json.

Serialisation

All classes have a .ToString() method to convert a class to json content:

WalletID_RPC rpc = new WalletID_RPC(1);
string json = rpc.Tostring();
Deserialisation

Deserialisation is implemented as static method and can be used to convert the server response:

GetNextAddress_Response nextAddress = GetNextAddress_Response.LoadResponseFromString(serverResponse);

IO

Often it can be helpful to load and store objects such as an initiated transaction to disk for later reuse:

Saving object to disk

All objects and classes implement a SaveToFile method. The method automatically appends a filename .rpc .response or .object in respect of the basetype

TransactionID_Response pendingTransaction = new TransactionID_Response();
pendingTransaction.SaveResponseToFile("C:\\temp\\pendingTransactions\\mytransaction-001");
Loading object from disk

Simmilar to the Deserialisation, loading from disk is implemented as a static method:

TransactionID_Response pendingTransaction = TransactionID_Response.LoadResponseFromFile("C:\\temp\\pendingTransactions\\mytransaction-001");

Remarks

The structure of the chia API can be confusing and many rpcs (eg WalletID_RPC) are used for multiple endpoints so it is strongly recommended to use the Chia-Client-API to see how the interaction with the RPC requests is.

Per default, the chia client will only listen to rpc requests from the local machine.
If you have remote machines to manage, eg a full node or farmers, you need to enable public port listening.
For that, edit the chia configuration (default at ~/.chia/mainnet/config/config.yaml).
Look for a line starting with self-hostname like so: self_hostname: &self_hostname "localhost"
change it to: self_hostname: 0.0.0.0 to listen on all interfaces or to the local interface ip to listen on a specific interface.

For a full documentation besides xml markup, please refer to the official chia documentation: https://docs.chia.net/rpc

Thank you for using CHIA-RPC!

Dependencies

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on CHIA-RPC:

Package Downloads
Chia-Client-API

CHIA-RPC is a C# Nuget library that allows developers to easily communicate with the Chia client. It provides a wrapper for making requests, sending transactions, and minting, making it a versatile tool for interacting with the Chia blockchain. With CHIA-RPC, you can easily integrate Chia functionality into your C# projects.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0.17 187 3/13/2024
2.2.0.10 127 3/5/2024
2.2.0 138 3/1/2024
2.1.3 218 12/21/2023
2.1.1.8 170 12/8/2023
2.1.1.7 174 11/26/2023
2.1.1.6 169 11/15/2023
2.1.1.5 143 11/15/2023
2.1.1.4 149 11/9/2023
2.1.1.2 169 10/19/2023
2.1.1 177 10/13/2023
2.0.1 165 10/5/2023
2.0.0.1 187 8/31/2023
2.0.0 191 8/28/2023
1.8.2.13 227 8/22/2023
1.8.2.5 222 8/10/2023
1.8.2.4 193 8/9/2023
1.8.2.3 206 8/9/2023
1.8.2.2 192 8/9/2023
1.8.2.1 196 8/9/2023
1.8.2 193 7/26/2023
1.8.1.16 197 6/26/2023
1.8.1.15 212 6/23/2023
1.8.1.14 215 6/22/2023
1.8.1.13 190 6/22/2023
1.8.1.12 199 6/22/2023
1.8.1.11 202 6/22/2023
1.8.1.10 193 6/22/2023
1.8.1.9 211 6/21/2023
1.8.1.8 214 6/14/2023
1.8.1.7 204 6/14/2023
1.8.1.6 220 6/12/2023
1.8.1.5 228 6/9/2023
1.8.1.4 207 6/9/2023
1.8.1.3 211 6/9/2023
1.8.1.2 200 6/7/2023
1.8.1.1 203 6/7/2023
1.8.1 198 6/2/2023
1.8.0 210 5/11/2023
1.7.1 248 4/21/2023
1.6.2.14 368 2/8/2023
1.6.2.13 339 2/8/2023
1.6.2.12 361 2/5/2023
1.6.2.11 278 2/5/2023
1.6.2.10 289 2/5/2023
1.6.2.9 418 1/31/2023
1.6.2.8 389 1/28/2023
1.6.2.6 468 1/25/2023
1.6.2.5 355 1/24/2023
1.6.2.4 339 1/17/2023
1.6.2.3 360 1/16/2023
1.6.2.2 355 1/15/2023
1.6.2.1 363 1/13/2023
1.6.2 371 1/12/2023
1.6.1.5 389 1/11/2023
1.6.1.3 420 1/10/2023
1.6.1.2 314 1/10/2023
1.6.1.1 359 12/29/2022
1.6.1 325 12/29/2022

This is a Major overhaul of the Package.
It implements nullable types for all endpoints. It is likely to require code changes or otherwise at least produces plentiful null value compiler warnings.

Enhanced features:
- Improved handling of null parameters: The RPC interface now properly handles null input parameters. This ensures that the application does not crash or cause unintended behavior when null is passed.
- RPC Parameter nullable: All RPC parameter objects are now nullable. This helps to prevent malformed requests and enhances the robustness of our API communication.
- Added null checks in RPC methods: Methods like BatchUpdate_Async now check if their required parameters are null before executing. This allows us to fail early and return a useful error message instead of causing an unexpected exception at runtime.
- Fixed potential NullReferenceExceptions
- Expanded XML Comments: We have vastly added or expanded XML comments to several classes and methods. These comments serve as in-code documentation and provide useful context and explanations for developers.
- All compiler warnings within the package have been resolved
Please refer to the documentation and updated code comments for more detailed information about these updates. As always, feel free to report any issues or provide feedback on these changes.