TonLib.Net 0.18.1

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

// Install TonLib.Net as a Cake Tool
#tool nuget:?package=TonLib.Net&version=0.18.1                

TonLib.NET

Wrapper around tonlibjson library for accessing Telegram Open Network lite servers (nodes) via ADNL protocol.

NuGet NuGet downloads Framework GitHub License

⚠ Uses System.Text.Json package v7.0.1 (from net7.0) - it makes [de]serialization much simpler (because of Polymorphic serialization). It only updates System.Text.Encodings.Web (v6.0 → v7.0) as a transitive dependency, which I think is acceptable.

Features

  • Read account balance and transaction history;
  • Operate with keys and mnemonics;
  • Send TON to different account;
  • Send arbitrary message to account;
  • Read and parse smartcontract data, call get-methods;
  • Read DNS data (resolve to ADNL);
  • Work with BOCs and Cells (read and parse using Slices, compose using CellBuilder);

And more:

  • Easy-to-extend: describe and call new TonLib
  • Connects to random LiteServer or choosen by you;
  • Reconnects to different LiteServer if previous one fails (but you need to handle exceptions and implement retry logic yourself, for example with Polly);
  • No 3rd-party packages;

Usage

Register in Startup (for console projects - create instance manually or see demo project for hosted sample):

services.AddSingleton<ITonClient, TonClient>();

And use:

// Obtain client from DI
var tonClient = app.Services.GetRequiredService<ITonClient>();

// You need to init it before first use.
// During this, TON network config file is loaded from internet.
// Subsequent calls to `InitIfNeeded` will be ignored, 
//   so no need for you to have additional variable 
//   to remember that you already called it.
await tonClient.InitIfNeeded();

// Use 'Execute' to send requests.
var lsi = await tonClient.Execute(new LiteServerGetInfo());
logger.LogInformation("Server time: {Now}", lsi.Now);

var mi = await tonClient.Execute(new GetMasterchainInfo());
logger.LogInformation("Last block: shard = {Shard}, seqno = {Seqno}", mi.Last.Shard, mi.Last.Seqno);

And the result is:

Sample

Installing dependencies and running a demo

This library is a wrapper around tonlibjson library. You need to obtain complied copy of it (and its dependencies) yourself.

Go to https://github.com/ton-blockchain/ton/releases, open latest release, scroll to "Assets" and download tonlibjson.* for your OS. Make sure this file will be available for your running program (for example, add it to your project and set "Copy to Output Directory" to "Copy if newer").

The number of additional dependencies you need depends of what you already have on your machine.

When something is missed, Demo app will fail with "Unable to load DLL 'tonlibjson' or one of its dependencies" exception. You may use Process Monitor to find what file it wants.

On my Win machine I needed libcrypto-1_1-x64.dll from OpenSSL.

EQDP_JFi4IucdPmEHJBSjEoSHlbC57G_8HLJAgqe05a-sGZ8

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 was computed.  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 TonLib.Net:

Package Downloads
TonProof

TonProof validates proof requests from TonConnect

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.22.0 7,198 8/5/2024
0.21.3 6,402 3/30/2024
0.21.2 159 2/25/2024
0.21.1 3,019 2/7/2024
0.20.0 2,229 11/27/2023
0.19.0 3,635 7/8/2023
0.18.1 987 6/6/2023
0.17.1 224 6/5/2023
0.17.0 269 6/1/2023
0.16.0 502 5/18/2023
0.15.0 532 5/3/2023
0.14.1 310 4/27/2023
0.14.0 347 4/21/2023
0.13.0 308 4/16/2023
0.12.0 215 4/7/2023
0.11.0 246 3/26/2023
0.10.0 255 3/15/2023
0.9.0 235 3/9/2023
0.8.0 220 3/7/2023
0.7.0 257 3/5/2023
0.6.0 302 2/21/2023
0.5.0 272 2/21/2023
0.4.0 267 2/13/2023
0.3.1 289 2/6/2023
0.3.0 282 2/6/2023
0.2.0 312 2/1/2023
0.1.0 321 1/31/2023

`TonRecipes.Telemint` replaced with two (`TonRecipes.TelegramUsernames` and `TonRecipes.TelegramNumbers`) to work with both .t.me domains and +888 anonymous numbers.