From 23adadd5cff253086a5b296cbbeb30a6cf4d1c80 Mon Sep 17 00:00:00 2001 From: cassandrus Date: Sat, 30 Mar 2024 02:12:40 +0300 Subject: [PATCH] ackinacki readme changes --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e7645d7..ff39f7d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# EVER-SDK for Java +# AckiNacki SDK for Java [![JDK version](https://img.shields.io/badge/Java-21-green.svg)](https://shields.io/) [![SDK version](https://img.shields.io/badge/EVER%20SDK-v1.45.0-orange)](https://github.com/tonlabs/ever-sdk) @@ -10,11 +10,11 @@ docs: [![javadoc](https://javadoc.io/badge2/tech.deplant.java4ever/java4ever-binding/javadoc.svg)](https://javadoc.io/doc/tech.deplant.java4ever/java4ever-binding) This is a Java binding project for -[EVER-SDK](https://github.com/tonlabs/ever-sdk) library that is -compatible with -[Everscale](https://everscale.network/), Venom, GOSH & TON blockchain -networks. -Binding calls [JSON-RPC](https://github.com/tonlabs/ever-sdk/blob/master/docs/for-binding-developers/json_interface.md) interface of EVER-SDK. +[EVER-SDK](https://github.com/tonlabs/ever-sdk) library adapted for +[AckiNacki](https://everscale.network/), blockchain +network. + +This binding uses [JSON-RPC](https://github.com/tonlabs/ever-sdk/blob/master/docs/for-binding-developers/json_interface.md) interface of EVER-SDK. Native calls are based on modern [Foreign Function & Memory API](https://openjdk.org/jeps/454). This artifact provides full binding functionality, but doesn't include @@ -85,19 +85,28 @@ It's very simple, just type ModuleName.methodName (list of modules and methods i Note that method names are converted from snake_case to camelCase. Then pass EverSdkContext object as 1st parameter. That's all. ```java -Client.version(ctx); +Client.version(contextId); ``` +## Support of new and custom SDK versions + +### Custom EVER-SDK libs (no new API handles) + +Just use your custom SDK binary instead of current. +**java4ever-binding** is not bound to exact version of SDK. + +### Support of new API handles -## Notes +- Clone this repo +- Run `gradlew generateEverSdkApi -D--enable-preview -D--enable-native-access=java4ever.binding` -### Custom EVER-SDK libs -EVER-SDK libs are included in the distribution, but if you want to use custom one - build **EVER-SDK** binary lib "**ton_client**"(.so/.dll) yourself (or - get [precompiled one](https://github.com/tonlabs/ever-sdk/blob/master/README.md#download-precompiled-binaries)) +## Tests +- Clone this repo +- Run `gradlew test --tests "tech.deplant.java4ever.unit.*" -D--enable-preview -D--enable-native-access=java4ever.binding` -### Logging +## Logging -java4ever-binding uses the JDK Platform Loggging (JEP 264: Platform Logging API and Service), -so can be easily bridged to any logging framework. \ No newline at end of file +**java4ever-binding** uses the JPL - [JDK Platform Loggging](https://openjdk.org/jeps/264) facade, +so can be easily bridged to any logging framework of your choice. \ No newline at end of file