Skip to content

Commit

Permalink
refactor: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Th0rgal committed Nov 15, 2024
1 parent 756e1a3 commit b2724d5
Showing 1 changed file with 29 additions and 39 deletions.
68 changes: 29 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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 <your_rpc_url> --private-key <your_private_key>
$ forge script script/Deploy.s.sol:DeployScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```

### Cast
## Links

```shell
$ cast <subcommand>
```
- 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.

0 comments on commit b2724d5

Please sign in to comment.