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.

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

Added README.md #6

Merged
merged 10 commits into from
Dec 10, 2024
Merged
67 changes: 63 additions & 4 deletions README.md
Shvandre marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,7 +1,66 @@
# TACT template project
# TACT Jetton (Fungible Token) Implementation

This project has ready to use TACT compiler, typescript + jest with ton-contract-executor, example how to do tests.
## Overview

## Licence
This project includes a complete setup for working with TACT-based smart contracts for Jettons. It provides:

MIT
- A preconfigured TACT compiler.
- Smart contracts written in the TACT language.
- TypeScript + Jest testing environment with `@ton/sandbox`.

## Goals

This implementation is fully compatible with the following TON standards:
- [TEP-64](https://github.com/ton-blockchain/TEPs/blob/master/text/0064-token-data-standard.md),
- [TEP-74](https://github.com/ton-blockchain/TEPs/blob/master/text/0074-jettons-standard.md),
- [TEP-89](https://github.com/ton-blockchain/TEPs/blob/master/text/0089-jetton-wallet-discovery.md).

You can use this implementation as an alternative to the official Jetton contracts available in the [TON Blockchain repository](https://github.com/ton-blockchain/token-contract).
Shvandre marked this conversation as resolved.
Show resolved Hide resolved

## Getting Started

### 1. Install Dependencies

Run the following command to install all required dependencies:

```bash
yarn install
```

### 2. Build Contracts

Compile the smart contracts with:

```bash
yarn build
```

### 3. Deploy Contracts

Customize your Jetton by editing the `contract.deploy.ts` file. This file also includes a detailed deployment guide. Deploy the contracts with:

```bash
yarn deploy
```

### 4. Test Contracts

Run tests in the `@ton/sandbox` environment:

```bash
yarn test
```

## Jetton Architecture

If you’re new to Jettons, refer to the [TON Jettons Processing](https://docs.ton.org/develop/dapps/asset-processing/jettons)

## Best Practices

- For guidance on interacting with Jettons using TACT, check the [Jetton Cookbook](https://docs.tact-lang.org/cookbook/jettons/).
- Be cautious of fake messages sent by scammers. Read the [Security Best Practices](https://docs.tact-lang.org/book/security-best-practices/) for protection against fraudulent activities.
- Always consult the [official TACT documentation](https://docs.tact-lang.org/) for additional resources and support.

## License

This project is licensed under the MIT License.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"dependencies": {
"@aws-crypto/sha256-js": "^5.2.0",
"@nowarp/misti": "~0.5.0",
"@tact-lang/compiler": "~1.5.0",
"@tact-lang/compiler": "^1.5.3",
anton-trunov marked this conversation as resolved.
Show resolved Hide resolved
"@tact-lang/deployer": "^0.2.0",
"@tact-lang/ton-abi": "^0.0.3",
"@tact-lang/ton-jest": "^0.0.4",
Expand All @@ -26,6 +26,7 @@
"dotenv": "^16.4.5",
"enquirer": "^2.3.6",
"jest": "^29.3.1",
"misti": "^0.0.21",
"open": "^8.4.0",
"prando": "^6.0.1",
"prettier": "^2.5.1",
Expand Down