Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme #335

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 83 additions & 81 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
![GitHub stars](https://img.shields.io/github/stars/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub forks](https://img.shields.io/github/forks/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub issues](https://img.shields.io/github/issues/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub pull requests](https://img.shields.io/github/issues-pr/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub last commit](https://img.shields.io/github/last-commit/ton-blockchain/mytonctrl?style=flat-square&logo=github) ![GitHub license](https://img.shields.io/github/license/ton-blockchain/mytonctrl?style=flat-square&logo=github)

<!-- omit from toc -->

# MyTonCtrl

<!-- omit from toc -->

## Contents

- [What is MyTonCtrl?](#what-is-myttonctrl)
- [MyTonCtrl Documentation](#mytonctrl-documentation)
- [Functionality](#functionality)
- [List of tested operating systems](#list-of-tested-operating-systems)
- [List of tested operating systems](#list-of-tested-operating-systems)
- [Installation](#installation)
- [Installation scripts overview](#installation-scripts-overview)
- [Installation modes](#installation-modes)
- [Installation for Ubuntu](#installation-for-ubuntu)
- [Installation for Debian](#installation-for-debian)
- [Installation scripts overview](#installation-scripts-overview)
- [Installation modes](#installation-modes)
- [Installation for Ubuntu](#installation-for-ubuntu)
- [Installation for Debian](#installation-for-debian)
- [Telemetry](#telemetry)
- [MyTonCtrl installer mode](#mytonctrl-installer-mode)
- [Web admin panel](#web-admin-panel)
- [Local copy of toncenter](#local-copy-of-toncenter)
- [Web admin panel](#web-admin-panel)
- [Local copy of toncenter](#local-copy-of-toncenter)
- [Useful links](#useful-links)


# What is MyTonCtrl?
MyTonCtrl is a console application that serves as a convenient wrapper for `fift`, `lite-client`, and `validator-engine-console`. It has been specifically developed for node (validator) management tasks on the Linux operating system.

MyTonCtrl is a console application that serves as a convenient wrapper for `fift`, `lite-client`,
and `validator-engine-console`. It has been specifically developed for node (validator) management tasks on the Linux
operating system.

![MyTonCtrl Status](screens/mytonctrl-status.png)

Expand All @@ -32,107 +36,103 @@ MyTonCtrl is a console application that serves as a convenient wrapper for `fift
Mytonctrl's documentation can be found at https://docs.ton.org/participate/run-nodes/mytonctrl.

# Functionality

- [x] Show TON network status
- [x] Management of local wallets
- [x] Create local wallet
- [x] Activate local wallet
- [x] Show local wallets
- [x] Import wallet from file (.pk)
- [x] Save wallet address to file (.addr)
- [x] Delete local wallet
- [x] Create local wallet
- [x] Activate local wallet
- [x] Show local wallets
- [x] Import wallet from file (.pk)
- [x] Save wallet address to file (.addr)
- [x] Delete local wallet
- [x] Show account status
- [x] Show account balance
- [x] Show account history
- [x] Show account status from bookmarks
- [x] Show account balance
- [x] Show account history
- [x] Show account status from bookmarks
- [x] Transferring funds to the wallet
- [x] Transfer of a fixed amount
- [x] Transfer of the entire amount (all)
- [x] Transfer of the entire amount with wallet deactivation (alld)
- [x] Transferring funds to the wallet from bookmarks
- [x] Transferring funds to a wallet through a chain of self-deleting wallets
- [x] Transfer of a fixed amount
- [x] Transfer of the entire amount (all)
- [x] Transfer of the entire amount with wallet deactivation (alld)
- [x] Transferring funds to the wallet from bookmarks
- [x] Transferring funds to a wallet through a chain of self-deleting wallets
- [x] Manage bookmarks
- [x] Add account to bookmarks
- [x] Show bookmarks
- [x] Delete bookmark
- [x] Add account to bookmarks
- [x] Show bookmarks
- [x] Delete bookmark
- [x] Offer management
- [x] Show offers
- [x] Vote for the proposal
- [x] Automatic voting for previously voted proposals
- [x] Show offers
- [x] Vote for the proposal
- [x] Automatic voting for previously voted proposals
- [x] Domain management
- [x] Rent a new domain
- [x] Show rented domains
- [x] Show domain status
- [x] Delete domain
- [ ] Automatic domain renewal
- [x] Rent a new domain
- [x] Show rented domains
- [x] Show domain status
- [x] Delete domain
- [ ] Automatic domain renewal
- [x] Controlling the validator
- [x] Participate in the election of a validator
- [x] Return bet + reward
- [x] Autostart validator on abnormal termination (systemd)
- [x] Send validator statistics to https://toncenter.com
- [x] Participate in the election of a validator
- [x] Return bet + reward
- [x] Autostart validator on abnormal termination (systemd)
- [x] Send validator statistics to https://toncenter.com

## List of tested operating systems
| Operating System | Status |
|-------------------------------|----------------------------|
| Ubuntu 16.04 LTS (Xenial Xerus) | Error: TON compilation error |
| Ubuntu 18.04 LTS (Bionic Beaver) | OK |
| Ubuntu 20.04 LTS (Focal Fossa) | OK |
| Ubuntu 22.04 LTS (Jammy Jellyfish) | OK |
| Debian 8 | Error: Unable to locate package libgsl-dev |
| Debian 9 | Error: TON compilation error |
| Debian 10 | OK |

| Operating System | Status |
|------------------------------------|--------------------------------------------|
| Ubuntu 16.04 LTS (Xenial Xerus) | Error: TON compilation error |
| Ubuntu 18.04 LTS (Bionic Beaver) | OK |
| Ubuntu 20.04 LTS (Focal Fossa) | OK |
| Ubuntu 22.04 LTS (Jammy Jellyfish) | OK |
| Debian 8 | Error: Unable to locate package libgsl-dev |
| Debian 9 | Error: TON compilation error |
| Debian 10 | OK |

# Installation

## Installation scripts overview
- `toninstaller.sh`: clones `TON` and` mytonctrl` sources to `/usr/src/ton` and`/usr/src/mytonctrl` folders, compiles programs from sources and writes them to `/usr/bin/`.

- `toninstaller.sh`: clones `TON` and` mytonctrl` sources to `/usr/src/ton` and`/usr/src/mytonctrl` folders, compiles
programs from sources and writes them to `/usr/bin/`.
- `mytoninstaller.py`: configures the validator and `mytonctrl`; generates validator connection keys.

## Installation modes
There are two installation modes: `liteserver` and `validator`. They both **compile** and install `TON` components and run the node/validator. Use `liteserver` mode if you want to use your node as Liteserver only.

There are two installation modes: `liteserver` and `validator`. They both **compile** and install `TON` components and
run the node/validator. Use `liteserver` mode if you want to use your node as Liteserver only.
Use `validator` mode if you want to participate in the validator elections (you still can use that node as Liteserver).

Learn more about node types: https://docs.ton.org/participate/nodes/node-types

## Installation for Ubuntu
1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts you for the superuser password several times.
```sh
wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
sudo bash install.sh -m <mode>
```

2. Done. You can try to run the `mytonctrl` console now.
```sh
mytonctrl
```


## Installation for Debian
1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts you for the superuser password several times.
```sh
wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
su root -c 'bash install.sh -m <mode>'
```
1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts
you for the superuser password several times.
```sh
wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
sudo bash install.sh -m <mode>
```

2. Done. You can try to run the `mytonctrl` console now.
```sh
mytonctrl
```
```sh
mytonctrl
```

# Telemetry
By default, `mytonctrl` sends validator statistics to the https://toncenter.com server.
It is necessary to identify network abnormalities, as well as to quickly give feedback to developers.
To disable telemetry during installation, use the `-t` flag:
```sh
sudo bash install.sh -m <mode> -t
```
## Installation for Debian

To disable telemetry after installation, do the following:
```sh
MyTonCtrl> set sendTelemetry false
```
1. Download and execute the `install.sh` script in the desired installation mode. During installation the script prompts
you for the superuser password several times.
```sh
wget https://raw.githubusercontent.com/ton-blockchain/mytonctrl/master/scripts/install.sh
su root -c 'bash install.sh -m <mode>'
```

# MyTonCtrl installer mode
2. Done. You can try to run the `mytonctrl` console now.
```sh
mytonctrl
```

## Web admin panel

To control the node/validator through the browser, you need to install an additional module:
`mytonctrl` -> `installer` -> `enable JR`

Expand All @@ -143,11 +143,13 @@ Ready. Now you can go to https://tonadmin.org site and log in with your credenti
git: https://github.com/igroman787/mtc-jsonrpc

## Local copy of toncenter

To set up a local https://toncenter.com copy on your server, install an additional module:
`mytonctrl` ->`installer` -> `enable PT`

Ready. A local copy of toncenter is available at `http://<server-ip-address>:8000`
git: https://github.com/igroman787/pytonv3

# Useful links

* https://docs.ton.org/