Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hacker-volodya authored Jan 7, 2024
1 parent a5047c2 commit 8565d44
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# TON LiteClient
# TON liteapi

An attempt to rewrite [lite-client](https://github.com/ton-blockchain/ton/tree/master/lite-client) for TON Blockchain in Rust using our [ADNL library](https://github.com/tonstack/adnl-rs).
Implementation of [lite_api](https://github.com/ton-blockchain/ton/blob/master/tl/generate/scheme/lite_api.tl) and [lite-client](https://github.com/ton-blockchain/ton/tree/master/lite-client) in Rust using [adnl-rs](https://github.com/tonstack/adnl-rs).

## Roadmap
- [x] Implement own ADNL library instead of using Everscale
- [x] Write documentation for ADNL protocol
- [ ] Implement TL messages serialization
- [ ] Implement all functions of the original lite-client
| Feature | Status |
| ------------- | -------------------------------- |
| ADNL Client | ✅ Implemented |
| ADNL Server | ❌ Not implemented |
| ADNL P2P | ❌ Not implemented |
| async | ❌ Not implemented |
| ed25519 libs | curve25519_dalek + x25519_dalek |

## Installation
```bash
cargo install --git https://github.com/tonstack/lite-client
```

## Usage
Without any options, [mainnet config](https://newton-blockchain.github.io/global.config.json) will be used.
Without any options, [mainnet config](https://ton.org/global.config.json) will be used.
For testnet, use `-t / --testnet` flag.
To use your own config, pass `-c / --config <FILE>` option.

Expand Down

0 comments on commit 8565d44

Please sign in to comment.