ennucore
/
bton
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 Commits
1 Branch
0 Tags
268 KiB
 
 
Tree: 5c7362e547
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5c7362e547'
${ noResults }
bton/README.md

3.9 KiB
Raw Blame History

TON Starter Template - Contracts

Starter template for a new TON project - FunC contracts, JS tests, compilation and deployment scripts

Overview

This project is part of a set of 3 typical repositories needed for a blockchain dapp running on TON blockchain:

  • Smart contracts in FunC that are deployed on-chain (this repo)
  • Web frontend for interacting with the dapp from a web browser
  • Telegram bot for interacting with the dapp from inside Telegram messenger

What does this repo contain?

  • contracts/*.fc - Smart contracts for TON blockchain written in FunC language
  • build/build.ts - Build script to compile the FunC code to Fift
  • build/*.fif - Output Fift files for every contract that was compiled, not uploaded to git
  • build/deploy.ts - Deploy script to deploy the compiled code to TON mainnet
  • test/*.spec.ts - Test suite for the contracts running on Mocha test runner

There is no one official way to develop smart contracts for TON. Every developer has their own best practices. This setup is definitely opinionated and some developers may not appreciate the choices made. Nevertheless, we stand by every choice made here and believe that this is the optimal setup to develop fully tested contracts in the most seamless way possible.

Some of the opinionated choices made here include:

  • Strong belief in tests - contracts often manage money - they must be developed under high scrutiny
  • Clear and documented code to help users audit the contracts sources and understand what they do
  • Reliance on modern TypeScript to develop clean and typed scripts and tests in a modern framework
  • Reliance on TypeScript for deployment instead of working with fift CLI tools - it's simply easier
  • Tests are executed in JavaScript with TVM in web-assembly - a great balance of speed and convenience
  • Following of the TON contract best practices appearing in the official docs

Dependencies and requirements

To setup your machine for development, please make sure you have the following:

  • A modern version of Node.js
    • Installation instructions can be found here
    • Run in terminal node -v to verify your installation, the project was tested on v17.3.0
  • The func CLI tool (FunC compiler)
    • Installation instructions can be found here
    • Run in terminal func -V to verify your installation
  • The fift CLI tool
    • Installation instructions can be found here
    • Don't forget to set the FIFTPATH env variable as part of the installation above
    • Run in terminal fift -V and fift to verify your installation
  • A decent IDE with FunC and TypeScript support

Development instructions

  • Install

    • Git clone the repo locally and rename the directory to your own project name
    • In the root repo dir, run in terminal npm install

  • Develop

    • FunC contracts are located in contracts/*.fc
      • Standalone root contracts are located in contracts/*.fc
      • Imported utility code (when breaking code to multiple files) in contracts/imports/*.fc
      • This structure assists with build and deployment and assumed by the included scripts
    • Tests are located in test/*.spec.ts

  • Build

    • In the root repo dir, run in terminal npm run build
    • Compilation errors will appear on screen

  • Test

    • In the root repo dir, run in terminal npm run test
    • Make sure to build before running tests

  • Deploy

    • In the root repo dir, run in terminal npm run deploy
    • Follow the on-screen instructions to deploy to mainnet