From b2724d5bd061a8ad108ab0efc6c0ffbb36fd206b Mon Sep 17 00:00:00 2001 From: Thomas Marchand Date: Fri, 15 Nov 2024 16:08:43 +0700 Subject: [PATCH] refactor: readme --- README.md | 68 ++++++++++++++++++++++++------------------------------- 1 file changed, 29 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 9265b45..26b1cbb 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ -## Foundry +# TelePay Smart Contracts -**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** +**TelePay is a cross-chain USD transfer system built for Telegram, enabling seamless transfers between users while abstracting away blockchain complexity.** -Foundry consists of: +## Overview -- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools). -- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. -- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network. -- **Chisel**: Fast, utilitarian, and verbose solidity REPL. +TelePay consists of a network of smart contracts deployed across multiple chains that enable: +- Native USD transfers between Telegram users +- Cross-chain deposits and withdrawals +- Abstracted transaction fees and complexity +- Batched transfer operations +- Automated liquidity management -## Documentation +## Core Features -https://book.getfoundry.sh/ +### User Operations +- Deposit USDC to any user's balance using their public key +- Withdraw USDC to any chain +- Transfer USDC between TelePay users +- Cross-chain transfers via CCTP -## Usage +## Architecture + +- Each supported chain has an identical contract deployment +- Cross-chain messaging handled via [Circle's CCTP](https://www.cctp.io/) +- Frontend interface available as a Telegram Mini App +- Signature-based authorization for user operations + +## Development ### Build @@ -27,40 +40,17 @@ $ forge build $ forge test ``` -### Format - -```shell -$ forge fmt -``` - -### Gas Snapshots - -```shell -$ forge snapshot -``` - -### Anvil - -```shell -$ anvil -``` - ### Deploy ```shell -$ forge script script/Counter.s.sol:CounterScript --rpc-url --private-key +$ forge script script/Deploy.s.sol:DeployScript --rpc-url --private-key ``` -### Cast +## Links -```shell -$ cast -``` +- Frontend Repository: [@lfglabs-dev/app.telepay.cc](https://github.com/lfglabs-dev/app.telepay.cc) +- Telegram Bot: [TelePay Bot](https://t.me/telepay_bot) -### Help +## Security -```shell -$ forge --help -$ anvil --help -$ cast --help -``` +This project is under active development. Use at your own risk.