mirror of
https://github.com/ton-blockchain/ton
synced 2025-02-12 19:22:37 +00:00
0d8abea534
* Add TON Research Forum * Update README.md --------- Co-authored-by: EmelyanenkoK <emelyanenko.kirill@gmail.com>
159 lines
6.5 KiB
Markdown
159 lines
6.5 KiB
Markdown
<div align="center">
|
|
<a href="https://ton.org">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://ton.org/download/ton_logo_dark_background.svg">
|
|
<img alt="TON logo" src="https://ton.org/download/ton_logo_light_background.svg">
|
|
</picture>
|
|
</a>
|
|
<h3>Reference implementation of TON Node and tools</h3>
|
|
<hr/>
|
|
</div>
|
|
|
|
##
|
|
|
|
<p align="center">
|
|
<a href="https://tonresear.ch">
|
|
<img src="https://img.shields.io/badge/TON%20Research-0098EA?style=flat&logo=discourse&label=Forum&labelColor=gray" alt="Ton Research">
|
|
</a>
|
|
<a href="https://t.me/toncoin">
|
|
<img src="https://img.shields.io/badge/TON%20Community-0098EA?logo=telegram&logoColor=white&style=flat" alt="Telegram Community Group">
|
|
</a>
|
|
<a href="https://t.me/tonblockchain">
|
|
<img src="https://img.shields.io/badge/TON%20Foundation-0098EA?logo=telegram&logoColor=white&style=flat" alt="Telegram Foundation Group">
|
|
</a>
|
|
<a href="https://t.me/tondev_eng">
|
|
<img src="https://img.shields.io/badge/chat-TONDev-0098EA?logo=telegram&logoColor=white&style=flat" alt="Telegram Community Chat">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://twitter.com/ton_blockchain">
|
|
<img src="https://img.shields.io/twitter/follow/ton_blockchain" alt="Twitter Group">
|
|
</a>
|
|
<a href="https://answers.ton.org">
|
|
<img src="https://img.shields.io/badge/-TON%20Overflow-FE7A16?style=flat&logo=stack-overflow&logoColor=white" alt="TON Overflow Group">
|
|
</a>
|
|
<a href="https://stackoverflow.com/questions/tagged/ton">
|
|
<img src="https://img.shields.io/badge/-Stack%20Overflow-FE7A16?style=flat&logo=stack-overflow&logoColor=white" alt="Stack Overflow Group">
|
|
</a>
|
|
</p>
|
|
|
|
|
|
|
|
Main TON monorepo, which includes the code of the node/validator, lite-client, tonlib, FunC compiler, etc.
|
|
|
|
## The Open Network
|
|
|
|
__The Open Network (TON)__ is a fast, secure, scalable blockchain focused on handling _millions of transactions per second_ (TPS) with the goal of reaching hundreds of millions of blockchain users.
|
|
- To learn more about different aspects of TON blockchain and its underlying ecosystem check [documentation](https://ton.org/docs)
|
|
- To run node, validator or lite-server check [Participate section](https://ton.org/docs/participate/nodes/run-node)
|
|
- To develop decentralised apps check [Tutorials](https://ton.org/docs/develop/smart-contracts/), [FunC docs](https://ton.org/docs/develop/func/overview) and [DApp tutorials](https://ton.org/docs/develop/dapps/)
|
|
- To work on TON check [wallets](https://ton.app/wallets), [explorers](https://ton.app/explorers), [DEXes](https://ton.app/dex) and [utilities](https://ton.app/utilities)
|
|
- To interact with TON check [APIs](https://ton.org/docs/develop/dapps/apis/)
|
|
|
|
## Updates flow
|
|
|
|
* **master branch** - mainnet is running on this stable branch.
|
|
|
|
Only emergency updates, urgent updates, or updates that do not affect the main codebase (GitHub workflows / docker images / documentation) are committed directly to this branch.
|
|
|
|
* **testnet branch** - testnet is running on this branch. The branch contains a set of new updates. After testing, the testnet branch is merged into the master branch and then a new set of updates is added to testnet branch.
|
|
|
|
* **backlog** - other branches that are candidates to getting into the testnet branch in the next iteration.
|
|
|
|
Usually, the response to your pull request will indicate which section it falls into.
|
|
|
|
|
|
## "Soft" Pull Request rules
|
|
|
|
* Thou shall not merge your own PRs, at least one person should review the PR and merge it (4-eyes rule)
|
|
* Thou shall make sure that workflows are cleanly completed for your PR before considering merge
|
|
|
|
## Build TON blockchain
|
|
|
|
### Ubuntu 20.4, 22.04 (x86-64, aarch64)
|
|
Install additional system libraries
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get install -y build-essential git cmake ninja-build zlib1g-dev libsecp256k1-dev libmicrohttpd-dev libsodium-dev
|
|
|
|
wget https://apt.llvm.org/llvm.sh
|
|
chmod +x llvm.sh
|
|
sudo ./llvm.sh 16 all
|
|
```
|
|
Compile TON binaries
|
|
```bash
|
|
cp assembly/native/build-ubuntu-shared.sh .
|
|
chmod +x build-ubuntu-shared.sh
|
|
./build-ubuntu-shared.sh
|
|
```
|
|
|
|
### MacOS 11, 12 (x86-64, aarch64)
|
|
```bash
|
|
cp assembly/native/build-macos-shared.sh .
|
|
chmod +x build-macos-shared.sh
|
|
./build-macos-shared.sh
|
|
```
|
|
|
|
### Windows 10, 11, Server (x86-64)
|
|
You need to install `MS Visual Studio 2022` first.
|
|
Go to https://www.visualstudio.com/downloads/ and download `MS Visual Studio 2022 Community`.
|
|
|
|
Launch installer and select `Desktop development with C++`.
|
|
After installation, also make sure that `cmake` is globally available by adding
|
|
`C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin` to the system `PATH` (adjust the path per your needs).
|
|
|
|
Open an elevated (Run as Administrator) `x86-64 Native Tools Command Prompt for VS 2022`, go to the root folder and execute:
|
|
```bash
|
|
copy assembly\native\build-windows.bat .
|
|
build-windows.bat
|
|
```
|
|
|
|
### Building TON to WebAssembly
|
|
Install additional system libraries on Ubuntu
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get install -y build-essential git cmake ninja-build zlib1g-dev libsecp256k1-dev libmicrohttpd-dev libsodium-dev
|
|
|
|
wget https://apt.llvm.org/llvm.sh
|
|
chmod +x llvm.sh
|
|
sudo ./llvm.sh 16 all
|
|
```
|
|
Compile TON binaries with emscripten
|
|
```bash
|
|
cd assembly/wasm
|
|
chmod +x fift-func-wasm-build-ubuntu.sh
|
|
./fift-func-wasm-build-ubuntu.sh
|
|
```
|
|
|
|
### Building TON tonlib library for Android (arm64-v8a, armeabi-v7a, x86, x86-64)
|
|
Install additional system libraries on Ubuntu
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get install -y build-essential git cmake ninja-build automake libtool texinfo autoconf libgflags-dev \
|
|
zlib1g-dev libssl-dev libreadline-dev libmicrohttpd-dev pkg-config libgsl-dev python3 python3-dev \
|
|
libtool autoconf libsodium-dev libsecp256k1-dev
|
|
```
|
|
Compile TON tonlib library
|
|
```bash
|
|
cp assembly/android/build-android-tonlib.sh .
|
|
chmod +x build-android-tonlib.sh
|
|
./build-android-tonlib.sh
|
|
```
|
|
|
|
### Build TON portable binaries with Nix package manager
|
|
You need to install Nix first.
|
|
```bash
|
|
sh <(curl -L https://nixos.org/nix/install) --daemon
|
|
```
|
|
Then compile TON with Nix by executing below command from the root folder:
|
|
```bash
|
|
cp -r assembly/nix/* .
|
|
export NIX_PATH=nixpkgs=https://github.com/nixOS/nixpkgs/archive/23.05.tar.gz
|
|
nix-build linux-x86-64-static.nix
|
|
```
|
|
More examples for other platforms can be found under `assembly/nix`.
|
|
|
|
## Running tests
|
|
|
|
Tests are executed by running `ctest` in the build directory. See `doc/Tests.md` for more information.
|