TonLib.Net 0.19.0

TonLib.NET

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

Does not require TonAPI, TonCenter API, TonKeeper API or any other HTTP API.

⚠ 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 (sample);
• Operate with keys and mnemonics (sample);
• Send TON to different account (sample);
• Work with BOCs and Cells (read and parse using Slices, compose using CellBuilder) (sample), including HashmapE (tests);
• Read and parse smartcontract data, call get-methods (sample);
• Resolve domains (sample)
• TonRecipes class (ready-to-use one-liners) to work with:
  • TEP-81 DNS contracts (parse all data, update entries) (sample);
  • Telemint contracts (*.t.me usernames and +888 anonymous numbers) (sample)
  • TEP-74 Jettons (transfer, burn, read info) - blocked by https://github.com/ton-blockchain/ton/issues/709
  • TEP-62 NFTs - soon

And more:

• Easy-to-extend:
  • Describe and call new TonLib methods without waiting for new version (sample);
  • Add your own Recipe methods to existing repice classes without recompiling library;
• 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 except native .NET assemblies;

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);

Run Demo project for more samples.

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. On my Win machine I also needed libcrypto-1_1-x64.dll from OpenSSL v1.1. You may use Process Monitor to find what it wants if it fails to run.

3rd-party libraries and dependencies

• Microsoft.Extensions.Logging.Abstractions v6.0.0
• Microsoft.Extensions.Options v6.0.0
• System.Text.Json v7.0.1
  • System.Text.Encodings.Web v7.0.0 as transitive dependency

Donate

EQDP_JFi4IucdPmEHJBSjEoSHlbC57G_8HLJAgqe05a-sGZ8

Useful links

• TON ADNL API Home: https://ton.org/docs/develop/dapps/apis/adnl
• TonLib TL Schema: https://github.com/ton-blockchain/ton/blob/master/tl/generate/scheme/tonlib_api.tl
• TL Language description: https://core.telegram.org/mtproto/TL