Chia-Client-API 1.8.2.4

.NET 6.0
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Chia-Client-API --version 1.8.2.4
NuGet\Install-Package Chia-Client-API -Version 1.8.2.4
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-Client-API" Version="1.8.2.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Chia-Client-API --version 1.8.2.4
#r "nuget: Chia-Client-API, 1.8.2.4"
#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-Client-API as a Cake Addin
#addin nuget:?package=Chia-Client-API&version=1.8.2.4

// Install Chia-Client-API as a Cake Tool
#tool nuget:?package=Chia-Client-API&version=1.8.2.4

Chia-Client-API

Thank you for considering using the Chia Client API for C#! Here is a brief overview of what you can expect to find in this repository:

Description

This repository contains a C# wrapper for the Chia blockchain API. It allows you to easily interact with the Chia blockchain from your C# applications.

This library is also available on NuGet. You can find it by searching for "ChiaClientAPI" in the NuGet Package Manager or by using the following command in the Package Manager Console:

Install-Package Chia-Client-API

Features

A simple, easy-to-use interface for accessing the Chia API Support for all API endpoints, including those for managing accounts, sending and receiving transactions, and querying the blockchain Detailed documentation for each API endpoint, including descriptions of input and output parameters

  • viewing, creating and managing wallets
  • sending chia, cats, nfts
  • creating offers for chia, cats and nfts
  • exploring the blockchain
  • managing datalayer
  • managing simulator
  • Minting NFTs
  • Creating CATs

Requirements

.NET 6 or higher

Installation

To install this library from the repository, simply clone the repository and open the solution file in Visual Studio. You can then build the solution and reference the compiled library in your own C# projects.

Alternatively, you can install the library from NuGet as described above.

Usage

Note: Per default, chia rpc will only listen to 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.

To use the Chia Client API in your C# applications, you will need to create an instance of the ChiaClient class and pass in your API key:

using ChiaClientAPI;

var client = new ChiaClient("your_api_key");

You can then call any of the API endpoints by calling the corresponding method on the client object. For example, to get the balance of an account, you can use the GetBalance method:

var balance = client.GetBalance("your_account_id");
Console.WriteLine(balance);

Refer to the documentation for specific usage instructions for each API endpoint.

Creating a cat offer

this is how you offer Cat vs chia:

CatGetAssetId_Response assetId = Testnet_Wallet.Wallet_Client.CatGetAssetID_Sync(new WalletID_RPC(wallet.id));
CreateOfferForIds_RPC offer_rpc = new CreateOfferForIds_RPC();
offer_rpc.offer.Add("1", -50000); // you want to give 500000 mojos
offer_rpc.offer.Add(assetId.asset_id, 500); // you want to receive 0.5 of asset x
OfferFile offer = Testnet_Wallet.Wallet_Client.CreateOfferForIds_Sync(offer_rpc);
offer.Export("btftestoffer");

note you can also give amounts in decimal chia (note that 1 cat is normally 1000 mojos so mind the conversion there)

offer_rpc.AddOfferPosition("1", -0.005); // you want to give 500000 mojos

Contributing

We welcome contributions to this repository! If you have suggestions for improvements or new features, please open an issue or submit a pull request.

License

This library is licensed under the MIT License. Please see the LICENSE file for more information.

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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0.17 97 3/13/2024
2.2.0.14 88 3/5/2024
2.2.0 84 3/1/2024
2.1.3 163 12/21/2023
2.1.1.10 123 12/8/2023
2.1.1.9 122 11/26/2023
2.1.1.8 107 11/15/2023
2.1.1.7 87 11/15/2023
2.1.1.6 94 11/9/2023
2.1.1.4 110 10/20/2023
2.1.1 113 10/13/2023
2.0.1 111 10/5/2023
2.0.0.1 127 8/31/2023
2.0.0 121 8/28/2023
1.8.2.13 129 8/22/2023
1.8.2.12 102 8/22/2023
1.8.2.5 150 8/10/2023
1.8.2.4 127 8/9/2023
1.8.2.3 140 8/9/2023
1.8.2.2 122 8/9/2023
1.8.2.1 123 8/9/2023
1.8.2 129 7/26/2023
1.8.1.16 113 6/26/2023
1.8.1.15 127 6/23/2023
1.8.1.14 113 6/22/2023
1.8.1.13 105 6/22/2023
1.8.1.12 109 6/22/2023
1.8.1.11 112 6/22/2023
1.8.1.10 114 6/22/2023
1.8.1.9 125 6/21/2023
1.8.1.8 139 6/14/2023
1.8.1.7 120 6/14/2023
1.8.1.6 146 6/12/2023
1.8.1.5 139 6/9/2023
1.8.1.4 126 6/9/2023
1.8.1.3 135 6/9/2023
1.8.1.2 144 6/7/2023
1.8.1.1 124 6/7/2023
1.8.1 132 6/2/2023
1.8.0 144 5/11/2023
1.7.1 153 4/21/2023
1.6.2.14 254 2/8/2023
1.6.2.13 232 2/8/2023
1.6.2.12 243 2/5/2023
1.6.2.10 263 1/31/2023
1.6.2.9 240 1/31/2023
1.6.2.8 259 1/28/2023
1.6.2.7 272 1/26/2023
1.6.2.6 276 1/25/2023
1.6.2.5 265 1/24/2023
1.6.2.4 262 1/17/2023
1.6.2.3 266 1/16/2023
1.6.2.2 271 1/15/2023
1.6.2.1 272 1/13/2023
1.6.2 287 1/12/2023
1.6.1.6 274 1/11/2023
1.6.1.5 273 1/11/2023
1.6.1.4 273 1/11/2023
1.6.1.3 287 1/10/2023
1.6.1.1 277 12/29/2022
1.6.1 276 12/29/2022

1.8.2.4
- hotfix for peer (has no attribute names)
- added unit test

1.8.2.3
- timestamps can now be read as DateTime
- improved resiliense and error handling in case of serialisation failures

1.8.2.2
- Included Peer object
- updated transaction documentationfor `sent_to` and `sent`
- changed `sent_to`  from `dynamic?` to `Peer[]?`
related documentation: https://docs.chia.net/walletconnect-commands?_highlight=sent#transactionrecord

1.8.2.1
This is a minor update that introduces changes to Transaction, Transaction Dict Memos, Transaction no memos, and GetTransaction:
- Added the TransactionType enum, making it easier to identify the type of a transaction.
- Added an unknown wallet type, "Ratelimited Wallet," to the WalletType enum.

1.8.2
This release presents a major overhaul of the package, implementing nullable types for all endpoints. It's likely that this will necessitate code changes, or at the very least, produce numerous null value compiler warnings.

Enhanced features:
- Improved Null Parameter Handling: The RPC interface now accurately manages null input parameters. This ensures the application won't crash or exhibit unintended behavior when a null value is passed.
- RPC Parameter Nullability: All RPC parameter objects are now nullable, enhancing request integrity and the stability of our API communication.
- Null Checks in RPC Methods: Functions, such as BatchUpdate_Async, now ascertain if their essential parameters are null prior to execution. This preemptive action helps detect issues early, returning a helpful error message instead of triggering unexpected runtime exceptions.
- Null Reference Exception Fixes: Addressed potential NullReferenceExceptions.
- Expanded XML Comments: We have significantly added to or expanded the XML comments across numerous classes and methods. These annotations act as in-code documentation, offering valuable context and guidance for developers.
- Compiler Warnings: Resolved all compiler warnings within the package.

Please refer to the documentation and the updated code comments for a deeper understanding of these updates. As always, we welcome any issue reports or feedback on these modifications.