ch1seL.TonNet.Client 1.26.0

<img src="https://avatars3.githubusercontent.com/u/67861283?s=150&u=4536b61595a1b422604fab8a7012092d891278f6&v=4" align="right" width="150">

Free TON .NET Client

Free TON is modern and fast crypto network. Lets do this network convenient both for users and developers!

• This client was automatically generated from api.json (see ClientGenerator)
• Fully supported methods provided in SDK documentation https://github.com/tonlabs/TON-SDK/tree/master/docs
• No Newtonsoft.Json required, it is kinda legacy now, last release was over a year ago. New System.Text.Json is ten times faster
• The most complete support of CancellationToken
• Net Standard 2.1 compatible

Quick start

Add Nuget Package to your project

dotnet add package ch1seL.TonNet.Client

Register in DI

Be careful! no network endpoints provided as default

public void ConfigureServices(IServiceCollection services)
{
    services.AddTonClient();
}

Ready to use everywhere

public class YourTonService {
    private readonly ITonClient _tonClient;

    public YourTonService(ITonClient tonClient) {
        _tonClient = tonClient;
    }
    
    public string GetTonSecretPhase() {
        var mnemonic = await _tonClient.Crypto.MnemonicFromRandom(new ParamsOfMnemonicFromRandom());
        return mnemonic.Phrase;
    }
}

IPackageManager interface

There is easy option to load contracts abi and tvm info from files in this client.

Now available following async methods:

Task<Package> LoadPackage(string name); // Package entity just contains Abi and Tvc
Task<Abi> LoadAbi(string name);
Task<string> LoadTvc(string name);

Default contracts path is _contracts

IDebotBrowser interface

Attention! DeBot module is UNSTABLE yet, see TON SDK description

More information:

• https://ru.freeton.wiki/Технические_характеристики_DeBot

• https://github.com/tonlabs/ton-labs-contracts/tree/master/solidity/debots

As default IDebotBrowser will resolve instance of DefaultDebotBrowser.

Can be inherited or implemented self-owned: services.AddTransient<IDebotBrowser, MyDebotBrowser>()

Advanced client configuration

See configuration parameters:

• https://github.com/tonlabs/TON-SDK/blob/master/docs/mod_client.md#networkconfig
• https://github.com/tonlabs/TON-SDK/blob/master/docs/mod_client.md#cryptoconfig
• https://github.com/tonlabs/TON-SDK/blob/master/docs/mod_client.md#abiconfig

public void ConfigureServices(IServiceCollection services)
{
    services.AddTonClient(config =>
    {
        config.Network.Endpoints = new[] { "net5.ton.dev" };
        config.Network.NetworkRetriesCount = 5;
    }, packageManagerConfig =>
    {
        packageManagerConfig.PackagesPath = "packages"; // path to abi.json and tvc files, _contracts is default
    });  
}

or configure options by appsettings.json or another configuration provider

https://docs.microsoft.com/en-us/dotnet/core/extensions/configuration-providers

Example for appsettings.json

{
  "TonClient": {
    "Network": {
      "Endpoints": [ "net.ton.dev" ],
      "WaitForTimeout": 5000
    }
  },
  "PackageManager": {
    "PackagesPath": "my_app_contracts"
  }
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddTonClient()        
        .Configure<TonClientOptions>(Configuration.GetSection("TonClient"))
        .Configure<PackageManagerOptions>(Configuration.GetSection("PackageManager"));
}

Logging

Fully compatible with https://docs.microsoft.com/en-us/dotnet/core/extensions/logging

Anonymous type extensions

There are a few properties with type JsonElement in data models. And this client provide methods to easy convert this properties to/from Anonymous prototype.

Convert to anonymous type example:

ResultOfParse parseResult = await tonClient.Boc.ParseMessage(new ParamsOfParse
{
    Boc = "te6ccgEBAQEAWAAAq2n+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE/zMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzSsG8DgAAAAAjuOu9NAL7BxYpA"
});
var parsedPrototype = new {type = default(int), id = default(string)};
var parsedMessage = parseResult.Parsed!.Value.ToAnonymous(parsedPrototype);

_logger.LogInformation("Parsed message id: {id} type: {type}", parsedMessage.id, parsedMessage.type);

Convert from anonymous type example:

await tonClient.Net.WaitForCollection(new ParamsOfWaitForCollection
{
    Collection = "transactions",
    Filter = new {in_msg = new {eq = parsedMessage.id}}.ToJsonElement(),
    Result = "id"
});

Samples

https://github.com/ton-actions/ton-client-dotnet/tree/master/samples/

Enjoy!

My Coffee Surf address:

ton://surf/0:9b487d68e4f029ab6d92640892d99d1c549ae69b198df414e905350559a165bf

https://ton.surf