What is it

This is your personal local TON blockchain (www.ton.org) in a shape of cross-platform desktop application. It comes in a form of uber-jar with all dependencies and binaries. Please notice this an alpha version and cannot be treated as production ready.

Matrix of supported OS & Java

Please make sure you are not using headless (no GUI) Java and OS/Java combination matches as per table above.

For MacOS users

In case you are using MacPorts instead of Homebrew on Mac please execute the following command:

mkdir -p /usr/local/opt/readline/lib; ln -s /opt/local/lib/libreadline.8.dylib /usr/local/opt/readline/lib/

Java installation

Microsoft Visual C++ Redistributable installation (for Windows only)

Please install Microsoft Visual C++ Redistributable 2015 (and above) x64. https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170

MyLocalTon installation

MyLocalTon usage

java -jar MyLocalTon-x86-64.jar [nogui] [ton-http-api] [explorer] [ip.addr.xxx.xxx] [test-binaries] [test-tonlib ] [with-validators-N] [custom-binaries=] [debug]

for ARM64 architecture use:

java -jar MyLocalTon-arm64.jar

Parameters

• nogui - used to run MyLocalTon without GUI interface. Can be used in Docker or server with headless Java.
• ton-http-api - enables ton-http-api service on start. Runs on port 8081.
• explorer - enables native ton blockchain explorer on start. Runs on port 8000.
• ip.addr.xxx.xxx - used to bind specific IP to MyLocalTon instead of 127.0.0.1.
• with-validators-N - used to start MyLocalTon with N additional validators.
• custom-binaries=absolute-path - used to start MyLocalTon with custom TON binaries. The folder should contain validator-engine, validator-engine-console, lite-client, fift, func, generate-random-id, create-state, dht-server, tonlibjson, blockchain-explorer binaries and also smartcont and lib folders in its root folder.
• debug - used to start MyLocalTon in debug mode, that produces lots of useful log files.

Lite-client

MyLocalTon uses deterministic (permanent) private and public keys for lite-server and validator-engine-console access. These keys can be found here. Once MyLocalTon is ready, you can use lite-client with the base64 key:

lite-client -a 127.0.0.1:4443 -b E7XwFSQzNkcRepUC23J2nRpASXpnsEKmyyHYV4u/FZY= -c last

or validator-engine-console in this way:

validator-engine-console -a 127.0.0.1:4441 -k <absolute-path>/myLocalTon/genesis/bin/certs/client -p <absolute-path>/myLocalTon/genesis/bin/certs/server.pub

Log files

• MyLocalTon log files can be found under ./myLocalTon/MyLocalTon.log.
• validator-engine log files can be found under ./myLocalTon/genesis/db/log.

Reporting an issue

• delete the current folder ./myLocalTon next to MyLocalTon*.jar
• execute java -jar MyLocalTon*.jar debug. (* replace with architecture and branch if needed)
• wait till the error appears and shutdown MyLocalTon.
• then send zipped above log files to Telegram @neodix or attach to issue at GitHub.
• Thanks for reporting. You are making MyLocalTon better.

Upgrade

Today upgrade is not supported, that means once you have a new version of MyLocalTon just overwrite the existing MyLocalTon and delete myLocalTon directory next to it. The upgrade functionality is in the backlog, so it will be implemented in future releases.

Build from sources

Common actions for all platforms

• Install OpenJDK 11 or higher
• Install IntelliJ IDEA Community Edition 2019 or higher
• Install SceneBuilder from https://gluonhq.com/products/scene-builder/
• Clone this repository and open it in IntelliJ as Maven project.
• Click Add configuration, select new "Application" type and specify main class "org.ton.main.Main".
• In Settings - JavaFX specify path to SceneBuilder.
• Now you can compile and run the application from IntelliJ.

Manual TON-HTTP-API installation (optional)

Linux

sudo apt install -y python3
sudo apt install -y python3-pip
pip3 install --user ton-http-api

MacOS

Note: Python version must be 3.11 or greater

brew install -q python3
python3 -m ensurepip --upgrade
pip3 install --user ton-http-api

Windows

wget https://www.python.org/ftp/python/3.12.0/python-3.12.0-amd64.exe
python -m ensurepip --upgrade
start pip3 install -U ton-http-api

Star History