# Blueprint
A development environment for TON blockchain for writing, testing, and deploying smart contracts.
## Table of Contents
* [Quick start](#quick-start-)
* [Overview](#overview)
* [Core features](#core-features)
* [Tech stack](#tech-stack)
* [Requirements](#requirements)
* [Features overview](#features-overview)
* [Project creation](#project-creation)
* [Directory structure](#directory-structure)
* [Building contracts](#building-contracts)
* [Running the test suites](#running-the-test-suites)
* [Running scripts](#running-scripts)
* [Deploying contracts](#deploying-contracts)
* [Using Mnemonic Provider](#using-mnemonic-provider)
* [Contract development](#contract-development)
* [Creating contracts](#creating-contracts)
* [Writing contract code](#writing-contract-code)
* [Testing contracts](#testing-contracts)
* [Benchmark contracts](#benchmark-contracts)
* [Configuration](#configuration)
* [Plugins](#plugins)
* [Custom network](#custom-network)
* [Contributors](#contributors)
* [License](#license)
* [Donations](#donations)
## Quick start 🚀
Run the command in terminal to create a new project and follow the on-screen instructions:
```console
npm create ton@latest
```
## Overview
Blueprint is an all-in-one development environment designed to enhance the process of creating, testing, and deploying smart contracts on TON blockchain using [Tolk](https://docs.ton.org/develop/tolk/overview), [FunC](https://docs.ton.org/develop/func/overview), and [Tact](https://docs.tact-lang.org/) languages.
### Core features
* Create a development environment from template - `npm create ton@latest`
* Streamlined workflow for building, testing and deploying smart contracts
* Dead simple deployment to mainnet/testnet using your favorite wallet (eg. Tonkeeper)
* Blazing fast testing of multiple smart contracts in an isolated blockchain running in-process
### Tech stack
1. Compiling Tolk with https://github.com/ton-blockchain/tolk-js
2. Compiling FunC with https://github.com/ton-community/func-js
3. Compiling Tact with https://github.com/tact-lang/tact
* Uses [`tact.config.json`](https://docs.tact-lang.org/book/config/) as the build configuration file
4. Testing smart contracts with https://github.com/ton-org/sandbox
5. Deploying smart contracts with [TON Connect 2](https://github.com/ton-connect) or a `ton://` deeplink
### Requirements
* [Node.js](https://nodejs.org) with a recent version like v18. Version can be verified with `node -v`
* IDE with TON support:
* [Visual Studio Code](https://code.visualstudio.com/) with the [TON plugin](https://marketplace.visualstudio.com/items?itemName=ton-core.vscode-ton) or [Tact plugin](https://marketplace.visualstudio.com/items?itemName=tonstudio.vscode-tact)
* [IntelliJ IDEA](https://www.jetbrains.com/idea/)
* [TON Development plugin](https://plugins.jetbrains.com/plugin/23382-ton) for Tolk, FunC and Fift
* [Tact plugin by TON Studio](https://plugins.jetbrains.com/plugin/27290-tact) for Tact
## Features overview
### Project creation
1. Run and follow the on-screen instructions: `npm create ton@latest` or `npx create-ton@latest`
2. From the project directory run `npm/yarn install` to install dependencies
### Directory structure
* `contracts/` - Source code for all smart contracts and their imports
* `wrappers/` - TypeScript interface classes for all contracts **except Tact**.
* Tact-generated wrappers are located according to the build path defined in [`tact.config.json`](https://docs.tact-lang.org/book/config/)
* Each wrapper implements `Contract` interface from [@ton/core](https://www.npmjs.com/package/@ton/core)
* Includes message [de]serialization primitives, getter wrappers and compilation functions
* Used by the test suite and client code to interact with the contracts from TypeScript
* `compilables/` - Compilations scripts for contracts
* `tests/` - TypeScript test suite for all contracts (relying on [Sandbox](https://github.com/ton-org/sandbox) for in-process tests)
* `scripts/` - Deployment scripts to mainnet/testnet and other scripts interacting with live contracts
* `build/` - Compilation artifacts created here after running a build command
### Building contracts
1. You need a compilation script in `compilables/.compile.ts` - [example](/example/compilables/Counter.compile.ts)
2. Run interactive: `npx blueprint build` or `yarn blueprint build`
3. Non-interactive: `npx/yarn blueprint build ` OR build all contracts `yarn blueprint build --all`
* Example: `yarn blueprint build counter`
4. Build results are generated in `build/.compiled.json`
5. Tact generated files are located in `build/` directory
6. Fift output is located in `build//.fif`
### Running the test suites
1. Run in terminal: `npx blueprint test` or `yarn blueprint test`
2. Alternative method: `npm test` or `yarn test`
3. You can specify test file to run: `npm/yarn test `
* Example: `yarn test counter`
> Learn more about writing tests from the Sandbox's documentation - [here](https://github.com/ton-org/sandbox#writing-tests).
### Running scripts
1. Custom scripts should be located in `scripts` folder
2. Script file must have exported function `run`
```ts
export async function run(provider: NetworkProvider, args: string[]) {
//
}
```
3. Script can be run using `npx/yarn blueprint run