Skip to content

Commit

Permalink
- added block exporer
Browse files Browse the repository at this point in the history
- moved tutoraials to doc folder
  • Loading branch information
skywinder committed May 27, 2019
1 parent be8b6e3 commit e6e2dd2
Show file tree
Hide file tree
Showing 3 changed files with 198 additions and 84 deletions.
111 changes: 27 additions & 84 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# TON Research

This open development community and **enthusiasts research place**. We will post our news and updates this project there.
This is open development community and **enthusiasts research place**. We will post our news and updates this project there.

## TON whitepapers:

- [Telegram Open Network Whitepaper](https://test.ton.org/ton.pdf)
- [Telegram Open Network Virtual Machine](https://test.ton.org/tvm.pdf)
- [Telegram Open Network Blockchain](https://test.ton.org/tblkch.pdf)
- [Fift: A Brief Introduction](https://test.ton.org/fiftbase.pdf) (Smart contract language for TON)
- [List of available files](https://test.ton.org/download.html) – List of available files
- [Telegram Open Network Whitepaper](https://test.ton.org/ton.pdf) – a general description
- [Telegram Open Network Virtual Machine](https://test.ton.org/tvm.pdf) - TON Virtual Machine description
- [Telegram Open Network Blockchain](https://test.ton.org/tblkch.pdf) - TON Blockchain description (possibly a bit out of date)
- [Fift: A Brief Introduction](https://test.ton.org/fiftbase.pdf) - A brief introduction to Fift programming language
- [README](https://test.ton.org/README.txt) -
General information, compilation and installation instructions
- [HOWTO](https://test.ton.org/HOWTO.txt) - Step-by-step description of creation of a new smart contract with the aid of the Lite Client

---
## Table of contents:
Expand All @@ -17,13 +21,9 @@ This open development community and **enthusiasts research place**. We will post
- [What we already did:](#what-we-already-did)
- [Future steps:](#future-steps)
- [Installation & Setup](#installation--setup)
* [Docker](#docker)
* [Releases (macOS)](#releases-macos)
- [Tutorial (how to)](#tutorial-how-to)
- [Got questions?](#got-questions)
- [Project links:](#project-links)
- [Tutorial](#tutorial)
- [Contributing](#contributing)
- [Contact us on telegam](#contact-us-on-telegam)
- [Contact us](#contact-us)

<!-- tocstop -->

Expand Down Expand Up @@ -56,9 +56,9 @@ _✨feel free to propose your topics_

## Installation & Setup

There is two options. By running Docker or precompilled binary for macOS below:
There are two options. By running Docker or precompiled binary for macOS below:

### Docker
**Docker**

The easiest way to run the node in a docker container:

Expand All @@ -78,7 +78,7 @@ Compile a fif file (if your container is running and current dir is mounted):
docker exec ton fift test.fif
```

### Releases (macOS)
**Releases (macOS)**

[Lite Client Latest release](https://github.com/copperbits/TON/releases/tag/test-1)

Expand All @@ -90,82 +90,25 @@ docker exec ton fift test.fif
```
- run `help` to get started

## Tutorial (how to)
## Tutorial

[HOWTO.md](./HOWTO.md)
All educational thing we moved it to [docs](/docs) folder.
You will find here [original readme](/docs/README.md), with additions of community-based tools and educational materials.

## Got questions?
If you have any quistions about project/installation - feel free to [open an issue!](https://github.com/copperbits/TON/issues/new)

## Project links:

- Bugs, suggestions or feature requests, [open an issue](https://github.com/copperbits/TON/issues/new) :octocat:
- Star [GitHub repo](https://github.com/copperbits/TON/) to support this project :+1:
- License in [GNU Lesser General Public License v2.1
](https://github.com/copperbits/TON/blob/master/LICENSE) :unlock:
- Shipped by [CooperBits team](https://t.me/ton_research) :sunny: and [contributors](https://github.com/copperbits/TON/graphs/contributors) :clap:

## Contributing

Your contributions are appreciated. You can follow [CONTRIBUTING](https://github.com/copperbits/TON/blob/master/CONTRIBUTING.md) guide to get everything started.

## Contact us on telegam
- [Telegam public group](https://t.me/ton_research)

---

Readme:
This is a distribution of a preliminary version of the TON Blockchain Lite Client along with the relevant portions of the TON Blockchain Library. It is not necessarily representative of the totality of the TON Blockchain code developed so far; rather it is a simplified stable version, containing only those files that are necessary for compiling the Lite Client, and sometimes outdated versions of these files sufficient for this purpose.

Use this software at your own risk; consult the DISCLAIMER for more information.

The software is licensed under GNU Lesser General Public License version 2 or later; consult LICENSE.LGPL and LGPL.v2 for more information. If you ever use any of these source files to develop your own versions of this or other software, you must attach a comment with the contents of LGPL.v2 to the beginning of each source file taken from this archive.

The software is likely to compile and work properly on most Linux systems. It should work on macOS and even Windows; however, we do not guarantee this for this preliminary version.

Basic compilation and installation instructions
All this information shipped by [cooperbits team](https://t.me/ton_research) and [contributors](https://github.com/copperbits/TON/graphs/contributors) :clap:

1. Download and unpack the newest version of this archive, available at
https://test.ton.org/download
The TON Blockchain Test Network is updated quite often, so we cannot guarantee that older versions of the Lite Client will always work. Backward compatibility is not enforced at this development stage.

2. Install the newest versions of make, cmake (version 3.0.2 or later), OpenSSL (including C header files), and g++ or clang (or another C++14-compatible compiler as appropriate for your operating system).

3. Suppose that you have unpacked this archive to directory ~/lite-client, where ~ is your home directory, and that you have created an empty directory ~/liteclient-build. Then run the following in a terminal on a Linux system:

```bash
cd ~/liteclient-build
cmake ~/lite-client
cmake --build . --target test-lite-client
```
You might also want to build some extra utilities useful for smart-contract development:

```bash
cmake --build . --target fift
```

4. Download the newest configuration file from https://test.ton.org/ton-lite-client-test1.config.json :

```bash
wget https://test.ton.org/ton-lite-client-test1.config.json
```

5. Run the Lite Client:

```bash
./test-lite-client -C ton-lite-client-test1.config.json
```

If everything was installed successfully, the Lite Client will connect to a special server (a full node for the TON Blockchain Test Network #1) and will send some queries to the server.
If you indicate a writeable "database" directory as an extra argument to the client, it will download and save the block and the state corresponding to the newest masterchain block:

```bash
./test-lite-client -C ton-lite-client-test1.config.json -D ~/ton-db-dir
```
Basic help info can be obtained by typing "help" into the Lite Client. Type "quit" or press Ctrl-C to exit.

6. Now you can create new smart contracts, examine the state of existing smart contracts, send external messages to smart contracts and so on. You can also use Fift (if you have compiled it) to compile, execute, and debug your smart contracts locally.
- **Questions?** Feel free to [open an issue](https://github.com/copperbits/TON/issues/new). Or ask us on [Telegam public group](https://t.me/ton_research)
- If you find **bugs, got suggestions**, or even feature requests: [open an issue](https://github.com/copperbits/TON/issues/new) :octocat:
- Star [GitHub repo](https://github.com/copperbits/TON/) to **support this project** :+1:
- **Want to share something?** Feel free to add related staff to [awesome-ton](https://github.com/copperbits/awesome-ton) repo
- The **license** in [GNU Lesser General Public License v2.1
](https://github.com/copperbits/TON/blob/master/LICENSE) :unlock:
- Your **contributions are appreciated**. You can follow [CONTRIBUTING](https://github.com/copperbits/TON/blob/master/CONTRIBUTING.md) guide to get everything started.

More details on these activities, including step-by-step instructions for creating a simple wallet smart contract (along with its source code), may be found in the HOWTO file included in this archive.
## Contact us

7. Some documentation on the TON Blockchain and TON Virtual Machine may be found at the download page https://test.ton.org/download . Be aware that this documentation may not be completely in sync with the version currently employed by the Test Network, because some minor implementation details are likely to be changed during the final development and testing phases.
Here is [Telegam public group](https://t.me/ton_research) - feel free to **ask any questions and propousals** there :+1:
File renamed without changes.
171 changes: 171 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
# TON Research

This open development community and **enthusiasts research place**. We will post our news and updates this project there.

## TON whitepapers:

- [Telegram Open Network Whitepaper](https://test.ton.org/ton.pdf)
- [Telegram Open Network Virtual Machine](https://test.ton.org/tvm.pdf)
- [Telegram Open Network Blockchain](https://test.ton.org/tblkch.pdf)
- [Fift: A Brief Introduction](https://test.ton.org/fiftbase.pdf) (Smart contract language for TON)

---
## Table of contents:

<!-- toc -->

- [What we already did:](#what-we-already-did)
- [Future steps:](#future-steps)
- [Installation & Setup](#installation--setup)
* [Docker](#docker)
* [Releases (macOS)](#releases-macos)
- [Tutorial (how to)](#tutorial-how-to)
- [Got questions?](#got-questions)
- [Project links:](#project-links)
- [Contributing](#contributing)
- [Contact us on telegam](#contact-us-on-telegam)

<!-- tocstop -->

## What we already did:
- 🏗 Build lite client node: [First release](https://github.com/copperbits/TON/releases/tag/test-1)
- 🖥 Started Lite Client on macOS
- 📩 Explain, how to send transactions to TON network
- 🎓 Now we are writing tutorials / FAQ / HOWTO how to use TON.
- 🏗 Instructions for building lite client on [Ubuntu 16.04](docs/ubuntu16.04.sh)
- 🐳 Packaged lite client into [Docker](#docker) container

- 👉 _any request and suggestions are [very welcome](https://github.com/copperbits/TON/issues/new)!_

![CLient lunch](img/run_client.png)

## Future steps:

**Creating FAQ & Video tutorial (WIP):**
_✨feel free to propose your topics_
- Step-by-step guide: **How to build a TON client**
- How to get test Grams
- Development:
- Write first hello-world smart contract
- How to deploy a smart contract
- How to send transactions

**Also, you will find there:**
- Future releases of binaries
- A FAQ with most popular questions (WIP)

## Installation & Setup

There is two options. By running Docker or precompilled binary for macOS below:

### Docker

The easiest way to run the node in a docker container:

```
docker run -d copperbits/ton
```

You might want to run in interactive mode and mount current dir into the container to be able to compile fif files:

```
docker run -ti -v "$(pwd):/data" --name ton copperbits/ton
```

Compile a fif file (if your container is running and current dir is mounted):

```
docker exec ton fift test.fif
```

### Releases (macOS)

[Lite Client Latest release](https://github.com/copperbits/TON/releases/tag/test-1)

- Download [latest release](https://github.com/copperbits/TON/releases/)
- Go to command line, where binary placed
- Run:
```bash
./test-lite-client -C ton-lite-client-test1.config.json
```
- run `help` to get started

## Tutorial (how to)

[HOWTO.md](./HOWTO.md)

## Got questions?
If you have any quistions about project/installation - feel free to [open an issue!](https://github.com/copperbits/TON/issues/new)

## Project links:

- Bugs, suggestions or feature requests, [open an issue](https://github.com/copperbits/TON/issues/new) :octocat:
- Star [GitHub repo](https://github.com/copperbits/TON/) to support this project :+1:
- License in [GNU Lesser General Public License v2.1
](https://github.com/copperbits/TON/blob/master/LICENSE) :unlock:
- Shipped by [CooperBits team](https://t.me/ton_research) :sunny: and [contributors](https://github.com/copperbits/TON/graphs/contributors) :clap:

## Contributing

Your contributions are appreciated. You can follow [CONTRIBUTING](https://github.com/copperbits/TON/blob/master/CONTRIBUTING.md) guide to get everything started.

## Contact us on telegam
- [Telegam public group](https://t.me/ton_research)

---

Readme:
This is a distribution of a preliminary version of the TON Blockchain Lite Client along with the relevant portions of the TON Blockchain Library. It is not necessarily representative of the totality of the TON Blockchain code developed so far; rather it is a simplified stable version, containing only those files that are necessary for compiling the Lite Client, and sometimes outdated versions of these files sufficient for this purpose.

Use this software at your own risk; consult the DISCLAIMER for more information.

The software is licensed under GNU Lesser General Public License version 2 or later; consult LICENSE.LGPL and LGPL.v2 for more information. If you ever use any of these source files to develop your own versions of this or other software, you must attach a comment with the contents of LGPL.v2 to the beginning of each source file taken from this archive.

The software is likely to compile and work properly on most Linux systems. It should work on macOS and even Windows; however, we do not guarantee this for this preliminary version.

Basic compilation and installation instructions

1. Download and unpack the newest version of this archive, available at
https://test.ton.org/download
The TON Blockchain Test Network is updated quite often, so we cannot guarantee that older versions of the Lite Client will always work. Backward compatibility is not enforced at this development stage.

2. Install the newest versions of make, cmake (version 3.0.2 or later), OpenSSL (including C header files), and g++ or clang (or another C++14-compatible compiler as appropriate for your operating system).

3. Suppose that you have unpacked this archive to directory ~/lite-client, where ~ is your home directory, and that you have created an empty directory ~/liteclient-build. Then run the following in a terminal on a Linux system:

```bash
cd ~/liteclient-build
cmake ~/lite-client
cmake --build . --target test-lite-client
```
You might also want to build some extra utilities useful for smart-contract development:

```bash
cmake --build . --target fift
```

4. Download the newest configuration file from https://test.ton.org/ton-lite-client-test1.config.json :

```bash
wget https://test.ton.org/ton-lite-client-test1.config.json
```

5. Run the Lite Client:

```bash
./test-lite-client -C ton-lite-client-test1.config.json
```

If everything was installed successfully, the Lite Client will connect to a special server (a full node for the TON Blockchain Test Network #1) and will send some queries to the server.
If you indicate a writeable "database" directory as an extra argument to the client, it will download and save the block and the state corresponding to the newest masterchain block:

```bash
./test-lite-client -C ton-lite-client-test1.config.json -D ~/ton-db-dir
```
Basic help info can be obtained by typing "help" into the Lite Client. Type "quit" or press Ctrl-C to exit.

6. Now you can create new smart contracts, examine the state of existing smart contracts, send external messages to smart contracts and so on. You can also use Fift (if you have compiled it) to compile, execute, and debug your smart contracts locally.

More details on these activities, including step-by-step instructions for creating a simple wallet smart contract (along with its source code), may be found in the HOWTO file included in this archive.

7. Some documentation on the TON Blockchain and TON Virtual Machine may be found at the download page https://test.ton.org/download . Be aware that this documentation may not be completely in sync with the version currently employed by the Test Network, because some minor implementation details are likely to be changed during the final development and testing phases.

0 comments on commit e6e2dd2

Please sign in to comment.