Merge pull request #29 from tonlabs/0.28.0-rc

Version 0.28.0

Author: d3p

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Release Notes
 All notable changes to this project will be documented in this file.
 
+## 0.28.0 May 15, 2021
+### New
+- Predeployed [SafeMultisigWallet](contracts/safe_multisig) contract with 1 million tokens.
+- [Improved logging. Added TVM log (tvm.log file)](README.md#how-to-work-with-logs).
+### Fixed
+- Contract freezing on receiving bounceable message when balance is zero.
+- Crashes of logging in docker.
+
 ## 0.27.2 Apr 28, 2021
 ### Fixed
 -  Transaction could be lost if it was created near the end of block producing interval. Again

README.md

@@ -1,4 +1,5 @@
 # TON OS Startup Edition
+
 Local blockchain for Free TON DApp development and testing.  
 
 **Have a question? Get quick help in our channel:**
@@ -13,13 +14,15 @@ Local blockchain for Free TON DApp development and testing.
     - [Instal via TONDEV Development Environment](#instal-via-tondev-development-environment)
     - [Install via docker command](#install-via-docker-command)
   - [How to change the blockchain configuration](#how-to-change-the-blockchain-configuration)
+  - [How to work with logs](#how-to-work-with-logs)
   - [How to connect to TON OS SE Graphql API from SDK](#how-to-connect-to-ton-os-se-graphql-api-from-sdk)
   - [TON OS SE components](#ton-os-se-components)
   - [TON Live explorer](#ton-live-explorer)
   - [How to build docker image locally](#how-to-build-docker-image-locally)
     - [Linux/Mac:](#linuxmac)
     - [Windows:](#windows)
 
+
 ## What is TON OS Startup Edition?
 
 TON OS Startup Edition (SE) is a local blockchain that developer can run on their machine in one click.   
@@ -31,17 +34,22 @@ See the [TON Labs TON OS SE documentation](https://docs.ton.dev/86757ecb2/p/19d8
 
 
 ## Use-cases
+
 - Test your applications locally
 - Test your contracts
 - Run TON OS remotely on a server and test your application from different devices
 
+
 ## How to install
+
 ### Pre-requisites
+
 - Latest [Docker](https://www.docker.com/get-started) installed
 
 **Attention!** [Docker daemon](https://www.docker.com/get-started) must be running. 
 
 ### Instal via TONDEV Development Environment
+
 If you have [TONDEV installed globally on your machine](https://github.com/tonlabs/tondev), run this command
 
 ```commandline
@@ -50,6 +58,7 @@ $ tondev se start
 [Checkout other TON OS SE commands accessible from TONDEV](https://docs.ton.dev/86757ecb2/p/54722f-tonos-se). 
 You can also access these commands from [TONDEV VS Code Extension](https://github.com/tonlabs/tondev-vscode).
 
+
 ### Install via docker command
 
 Run this command 
@@ -66,6 +75,7 @@ If you specified another port then add it to the local url http://0.0.0.0:port/g
 [Find out more about GraphQL API](https://docs.ton.dev/86757ecb2/p/793337-graphql-api). 
 
 ## How to change the blockchain configuration
+
 TON OS SE loads the blockchain configuration (config params) during its start from the configuration file 
 [blockchain.conf.json](docker/ton-node/blockchain.conf.json) instead of special smart contract, which stores 
 various config params in the real networks.
@@ -84,12 +94,52 @@ $ docker run -d --name local-node -e USER_AGREEMENT=yes -p80:80 \
      tonlabs/local-node
 ```
 
+## How to work with logs
+
+By default, TON OS SE logs the most of the information to the console, which is accessible by the next command:
+```commandline
+$ docker logs local-node
+```
+
+More verbose logging is configured to `/ton-node/log/` directory inside the running docker container. 
+By default, there are two files: `ton-node.log` for all logging and `tvm.log` for tracing of TVM execution: 
+code, stack, control registers, gas, etc.
+
+Logging configuration is stored in `/ton-node/log_cfg.yml` file. In order to change the default logging verbosity of 
+other parameters, you can configure logging in several ways:
+1. In the running container by changing `/ton-node/log_cfg.yml` file:
+
+```commandline
+$ docker exec -it local-node bash
+bash-5.0# vi /ton-node/log_cfg.yml
+```
+(in order to exit from VI editor with saving changes press the `ESC` key, then type `:wq` and press the `ENTER` key)
+
+Note: `log_cfg.yml` file is normally scanned for changes every 30 seconds, so all changes made to this file in running 
+      container will be applied only after the scan.
+
+Note: after recreation of the container, all changes made in its files will be lost, so use the second way, if you need 
+      to keep them. 
+
+2. Before starting of the container, download and edit a copy of [log_cfg.yml](./docker/ton-node/log_cfg.yml) file, then 
+   mount this file to container's file system in `docker run` command:
+```commandline
+$ docker run -d --name local-node -e USER_AGREEMENT=yes -p80:80 \
+     -v /home/user/log_cfg.yml:/ton-node/log_cfg.yml \
+     tonlabs/local-node
+```
+After starting of TON OS SE, you can edit this file in your file system without restart.
+
+More information about log4rs configuration [in the log4rs documentation](https://docs.rs/log4rs/1.0.0/log4rs/).
+
+
 ## How to connect to TON OS SE Graphql API from SDK
 
 **Attention** at the moment there are a few [differences in SE behaviour comparing with a real TON blockchain](https://docs.ton.dev/86757ecb2/p/683279-difference-in-behaviour). Read about them before you start implemennting. Please note that we plan to upgrade the SE behaviour in the next releases so that it will work the same way as a real network.  
 
 To connect to local blockchain from your application [specify localhost in SDK Client network config](https://docs.ton.dev/86757ecb2/p/5328db-tonclient).
 
+
 ## TON OS SE components
 
 * [TON Labs implementation of TON VM written in Rust](https://github.com/tonlabs/ton-labs-vm)
@@ -98,6 +148,7 @@ To connect to local blockchain from your application [specify localhost in SDK C
 * [TON-live explorer](https://ton.live)
 * [Pre-deployed high-performance Giver, ABI v2](contracts)
 
+
 ## TON Live explorer
 
 TON Live explorer runs on the same IP and port as TON OS SE, just open http://ip_address:port (e.g. http://127.0.0.1)
@@ -108,12 +159,15 @@ TON Live explorer runs on the same IP and port as TON OS SE, just open http://ip
 In order to build and use TON OS Startup Edition you need Docker.
 To build docker image, run from the repository root:
 
+
 ### Linux/Mac:
+
 ```commandline
 ./build.sh
 ```
 
 ### Windows:
+
 ```commandline
 build.cmd
 ```

contracts/README.md

@@ -1,33 +1,5 @@
-# Giver v2
+# Smart Contracts, used in TON OS SE
+* [Giver v2](giver_v2)
+* [SafeMultisig Wallet](safe_multisig)
 
-This directory contains Giver v2 (ABI v2) contract. This giver is recommended over Giver v1.
 
-In TON OS SE this giver is predeployed at `0:b5e9240fc2d2f1ff8cbb1d1dee7fb7cae155e5f6320e585fcc685698994a19a5` address 
-and its initial balance is about 5 billion tokens. 
-
-## Keys:
-* Public: `2ada2e65ab8eeab09490e3521415f45b6e42df9c760a639bcf53957550b25a16`
-* Secret: `172af540e43a524763dd53b26a066d472a97c4de37d5498170564510608250c3`
-
-## Usage
-Method: `sendTransaction`
-
-parameters: 
-* `dest`: `address` - destination address;
-* `value`: `uint128` - amount to send, in nanotokens;
-* `bounce`: `bool` - bounce flag of the message.
-
-### Using tonos-cli:
-```commandline
-tonos-cli call 0:b5e9240fc2d2f1ff8cbb1d1dee7fb7cae155e5f6320e585fcc685698994a19a5 \
-    sendTransaction '{"dest":"<address>","value":<nanotokens>,"bounce":false}' \
-    --abi GiverV2.abi.json \
-    --sign GiverV2.keys.json  
-```
-
-
-## Files
-* ABI: [GiverV2.abi.json](GiverV2.abi.json)
-* Keypair: [GiverV2.keys.json](GiverV2.keys.json)
-* TVC file: [GiverV2.tvc](GiverV2.tvc)
-* Source code: [GiverV2.sol](GiverV2.sol)

contracts/GiverV2.abi.json renamed to contracts/giver_v2/GiverV2.abi.json

@@ -0,0 +1,33 @@
+# Giver v2
+
+This directory contains Giver v2 (ABI v2) contract. This giver is recommended over Giver v1.
+
+In TON OS SE this giver is predeployed at `0:b5e9240fc2d2f1ff8cbb1d1dee7fb7cae155e5f6320e585fcc685698994a19a5` address 
+and its initial balance is about 5 billion tokens. 
+
+## Keys:
+* Public: `2ada2e65ab8eeab09490e3521415f45b6e42df9c760a639bcf53957550b25a16`
+* Secret: `172af540e43a524763dd53b26a066d472a97c4de37d5498170564510608250c3`
+
+## Usage
+Method: `sendTransaction`
+
+parameters: 
+* `dest`: `address` - destination address;
+* `value`: `uint128` - amount to send, in nanotokens;
+* `bounce`: `bool` - bounce flag of the message.
+
+### Using tonos-cli:
+```commandline
+tonos-cli call 0:b5e9240fc2d2f1ff8cbb1d1dee7fb7cae155e5f6320e585fcc685698994a19a5 \
+    sendTransaction '{"dest":"<address>","value":<nanotokens>,"bounce":false}' \
+    --abi GiverV2.abi.json \
+    --sign GiverV2.keys.json  
+```
+
+
+## Files
+* ABI: [GiverV2.abi.json](GiverV2.abi.json)
+* Keypair: [GiverV2.keys.json](GiverV2.keys.json)
+* TVC file: [GiverV2.tvc](GiverV2.tvc)
+* Source code: [GiverV2.sol](GiverV2.sol)

contracts/GiverV2.keys.json renamed to contracts/giver_v2/GiverV2.keys.json

@@ -0,0 +1,41 @@
+# SafeMultisig Wallet
+
+This directory contains SafeMultisig Wallet contract for testing purposes.
+
+In TON OS SE this contract is predeployed at `0:d5f5cfc4b52d2eb1bd9d3a8e51707872c7ce0c174facddd0e06ae5ffd17d2fcd` address 
+with one single custodian and its initial balance is about 1 million tokens. 
+
+## Custodian Keys:
+* Public: `99c84f920c299b5d80e4fcce2d2054b05466ec9df19532a688c10eb6dd8d6b33`
+* Secret: `73b60dc6a5b1d30a56a81ea85e0e453f6957dbfbeefb57325ca9f7be96d3fe1a`
+* Seed Phrase: `"fan harsh baby section father problem person void depth already powder chicken"`
+
+
+## Basic Usage
+Method: `submitTransaction`
+
+Sends transaction to the specified address.
+
+Parameters: 
+* `dest`: `address` - destination address;
+* `value`: `uint128` - amount to send, in nanotokens;
+* `bounce`: `bool` - bounce flag of the message;
+* `allBalance`: `bool` - if true, all wallet's balance will be sent;
+* `payload`: `cell` - payload to send with transaction.
+
+### Using tonos-cli:
+```commandline
+tonos-cli call 0:d5f5cfc4b52d2eb1bd9d3a8e51707872c7ce0c174facddd0e06ae5ffd17d2fcd \
+    submitTransaction '{"dest":"<raw_address>","value":<nanotokens>,"bounce":false,"allBalance":false,"payload":""}' \
+    --abi SafeMultisigWallet.abi.json \
+    --sign SafeMultisigWallet.keys.json  
+```
+
+For more information about `SafeMultisigWallet` contract and `tonos-cli` usage see in 
+[documentation](https://docs.ton.dev/86757ecb2/p/94921e-multisignature-wallet-management-in-tonos-cli).
+
+## Files
+* ABI: [SafeMultisigWallet.json](SafeMultisigWallet.abi.json)
+* Keypair: [SafeMultisigWallet.keys.json](SafeMultisigWallet.keys.json)
+* TVC file: [SafeMultisigWallet.tvc](SafeMultisigWallet.tvc)
+* Source code: [SafeMultisigWallet.sol](SafeMultisigWallet.sol)

contracts/GiverV2.sol renamed to contracts/giver_v2/GiverV2.sol

@@ -0,0 +1,123 @@
+{
+	"ABI version": 2,
+	"header": ["pubkey", "time", "expire"],
+	"functions": [
+		{
+			"name": "constructor",
+			"inputs": [
+				{"name":"owners","type":"uint256[]"},
+				{"name":"reqConfirms","type":"uint8"}
+			],
+			"outputs": [
+			]
+		},
+		{
+			"name": "acceptTransfer",
+			"inputs": [
+				{"name":"payload","type":"bytes"}
+			],
+			"outputs": [
+			]
+		},
+		{
+			"name": "sendTransaction",
+			"inputs": [
+				{"name":"dest","type":"address"},
+				{"name":"value","type":"uint128"},
+				{"name":"bounce","type":"bool"},
+				{"name":"flags","type":"uint8"},
+				{"name":"payload","type":"cell"}
+			],
+			"outputs": [
+			]
+		},
+		{
+			"name": "submitTransaction",
+			"inputs": [
+				{"name":"dest","type":"address"},
+				{"name":"value","type":"uint128"},
+				{"name":"bounce","type":"bool"},
+				{"name":"allBalance","type":"bool"},
+				{"name":"payload","type":"cell"}
+			],
+			"outputs": [
+				{"name":"transId","type":"uint64"}
+			]
+		},
+		{
+			"name": "confirmTransaction",
+			"inputs": [
+				{"name":"transactionId","type":"uint64"}
+			],
+			"outputs": [
+			]
+		},
+		{
+			"name": "isConfirmed",
+			"inputs": [
+				{"name":"mask","type":"uint32"},
+				{"name":"index","type":"uint8"}
+			],
+			"outputs": [
+				{"name":"confirmed","type":"bool"}
+			]
+		},
+		{
+			"name": "getParameters",
+			"inputs": [
+			],
+			"outputs": [
+				{"name":"maxQueuedTransactions","type":"uint8"},
+				{"name":"maxCustodianCount","type":"uint8"},
+				{"name":"expirationTime","type":"uint64"},
+				{"name":"minValue","type":"uint128"},
+				{"name":"requiredTxnConfirms","type":"uint8"}
+			]
+		},
+		{
+			"name": "getTransaction",
+			"inputs": [
+				{"name":"transactionId","type":"uint64"}
+			],
+			"outputs": [
+				{"components":[{"name":"id","type":"uint64"},{"name":"confirmationsMask","type":"uint32"},{"name":"signsRequired","type":"uint8"},{"name":"signsReceived","type":"uint8"},{"name":"creator","type":"uint256"},{"name":"index","type":"uint8"},{"name":"dest","type":"address"},{"name":"value","type":"uint128"},{"name":"sendFlags","type":"uint16"},{"name":"payload","type":"cell"},{"name":"bounce","type":"bool"}],"name":"trans","type":"tuple"}
+			]
+		},
+		{
+			"name": "getTransactions",
+			"inputs": [
+			],
+			"outputs": [
+				{"components":[{"name":"id","type":"uint64"},{"name":"confirmationsMask","type":"uint32"},{"name":"signsRequired","type":"uint8"},{"name":"signsReceived","type":"uint8"},{"name":"creator","type":"uint256"},{"name":"index","type":"uint8"},{"name":"dest","type":"address"},{"name":"value","type":"uint128"},{"name":"sendFlags","type":"uint16"},{"name":"payload","type":"cell"},{"name":"bounce","type":"bool"}],"name":"transactions","type":"tuple[]"}
+			]
+		},
+		{
+			"name": "getTransactionIds",
+			"inputs": [
+			],
+			"outputs": [
+				{"name":"ids","type":"uint64[]"}
+			]
+		},
+		{
+			"name": "getCustodians",
+			"inputs": [
+			],
+			"outputs": [
+				{"components":[{"name":"index","type":"uint8"},{"name":"pubkey","type":"uint256"}],"name":"custodians","type":"tuple[]"}
+			]
+		}
+	],
+	"data": [
+	],
+	"events": [
+		{
+			"name": "TransferAccepted",
+			"inputs": [
+				{"name":"payload","type":"bytes"}
+			],
+			"outputs": [
+			]
+		}
+	]
+}