Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xelaj/mtproto
๐ฆ Full-native go implementation of Telegram API
https://github.com/xelaj/mtproto
api-client awesome awesome-golang go golang hacktoberfest hacktoberfest2020 mtproto tdlib tdlib-docker tdlib-go telegram telegram-api telegram-bot
Last synced: about 1 month ago
JSON representation
๐ฆ Full-native go implementation of Telegram API
- Host: GitHub
- URL: https://github.com/xelaj/mtproto
- Owner: xelaj
- License: mit
- Created: 2020-10-04T13:02:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T16:32:09.000Z (6 months ago)
- Last Synced: 2024-06-21T14:13:29.443Z (3 months ago)
- Topics: api-client, awesome, awesome-golang, go, golang, hacktoberfest, hacktoberfest2020, mtproto, tdlib, tdlib-docker, tdlib-go, telegram, telegram-api, telegram-bot
- Language: Go
- Homepage:
- Size: 29.1 MB
- Stars: 1,185
- Watchers: 29
- Forks: 134
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- awesome-golang-repositories - mtproto - native go implementation of Telegram API (Repositories)
- awesome-telegram - MTProto
README
# MTProto
[](https://pkg.go.dev/github.com/xelaj/mtproto)
[](https://goreportcard.com/report/github.com/xelaj/mtproto)
[](https://codecov.io/gh/xelaj/mtproto)
[](https://github.com/xelaj/mtproto/blob/main/README.md)
[](https://bit.ly/2xlsVsQ)
 Full-native implementation of MTProto protocol on Golang!
**english** [ััััะบะธะน](https://github.com/xelaj/mtproto/blob/main/docs/ru_RU/README.md) [็ฎไฝไธญๆ](https://github.com/xelaj/mtproto/blob/main/docs/zh_CN/README.md)
##
Features
Full native implementation
All code, from sending requests to encryption serialization is written on pure golang. You don't need to fetch any additional dependencies.
Latest API version (117+)
Lib is supports all the API and MTProto features, including video calls and post comments. You can create additional pull request to push api updates!
Reactive API updates (generated from TL schema)
All changes in TDLib and Android client are monitoring to get the latest features and changes in TL schemas. New methods are creates by adding new lines into TL schema and updating generated code!
Implements ONLY network tools
No more SQLite databases and caching unnecessary files, that you don't need. Also you can control how sessions are stored, auth process and literally everything that you want to!
Multiaccounting, Gateway mode
You can use more than 10 accounts at same time! xelaj/MTProto doesn't create huge overhead in memory or cpu consumption as TDLib. Thanks for that, you can create huge number of connection instances and don't worry about memory overload!
## How to use
MTProto is really hard in implementation, but it's really easy to use. Basically, this lib sends serialized structures to Telegram servers (just like gRPC, but from Telegram LLC.). It looks like this:
```go
func main() {
client := telegram.NewClient()
// for each method there is specific struct for serialization (Params{})
result, err := client.MakeRequest(&telegram.GetSomeInfoParams{FromChatId: 12345})
if err != nil {
panic(err)
}
resp, ok := result.(*SomeResponseObject)
if !ok {
panic("Oh no! Wrong type!")
}
}
```
Not so hard, huh? But there is even easier way to send request, which is included in TL API specification:
```go
func main() {
client := telegram.NewClient()
resp, err := client.GetSomeInfo(12345)
if err != nil {
panic(err)
}
// resp will be already asserted as described in TL specs of API
// if _, ok := resp.(*SomeResponseObject); !ok {
// panic("No way, we found a bug! Create new issue!")
// }
println(resp.InfoAboutSomething)
}
```
You do not need to think about encryption, key exchange, saving and restoring session, and more routine things. It is already implemented just for you.
**Code examples are [here](https://github.com/xelaj/mtproto/blob/main/examples)**
**Full docs are [here](https://pkg.go.dev/github.com/xelaj/mtproto)**
## Getting started
### Simple How-To
Installation is simple. Just do `go get`:
``` bash
go get github.com/xelaj/mtproto
```
After that you can generate source structures of methods and functions if you wish to. To do it, use `go generate`
``` bash
go generate github.com/xelaj/mtproto
```
That's it! You don't need to do anything more!
### What is InvokeWithLayer?
It's Telegram specific feature. If you want to create client instance and get information about the current server's configuration, you need to do something like this:
```go
resp, err := client.InvokeWithLayer(apiVersion, &telegram.InitConnectionParams{
ApiID: 124100,
DeviceModel: "Unknown",
SystemVersion: "linux/amd64",
AppVersion: "0.1.0",
// just use "en", any other language codes will receive error. See telegram docs for more info.
SystemLangCode: "en",
LangCode: "en",
// HelpGetConfig() is ACTUAL request, but wrapped in InvokeWithLayer
Query: &telegram.HelpGetConfigParams{},
})
```
Why? We don't know! This method is described in Telegram API docs, any other starting requests will receive error.
### How to use phone authorization?
**Example [here](https://github.com/xelaj/mtproto/blob/main/examples/auth)**
```go
func AuthByPhone() {
resp, err := client.AuthSendCode(
yourPhone,
appID,
appHash,
&telegram.CodeSettings{},
)
if err != nil {
panic(err)
}
// You can make any way to enter verification code, like in
// http requests, or what you like. You just need to call two
// requests, that's main method.
fmt.Print("Auth code:")
code, _ := bufio.NewReader(os.Stdin).ReadString('\n')
code = strings.Replace(code, "\n", "", -1)
// this is ALL process of authorization! :)
fmt.Println(client.AuthSignIn(yourPhone, resp.PhoneCodeHash, code))
}
```
That's it! You don't need any cycles, code is ready-to-go for async execution. You just need to follow the official Telegram API documentation.
### Telegram Deeplinks
Want to deal those freaky `tg://` links? See [`deeplinks` package](https://github.com/xelaj/mtproto/blob/main/telegram/deeplinks), here is the simplest how-to:
``` go
package main
import (
"fmt"
"github.com/xelaj/mtproto/telegram/deeplinks"
)
func main() {
link, _ := deeplinks.Resolve("t.me/xelaj_developers")
// btw, ResolveParameters is just struct for tg://resolve links, not all links are resolve
resolve := link.(*deeplinks.ResolveParameters)
fmt.Printf("Oh! Looks like @%v is the best developers channel in telegram!\n", resolve.Domain)
}
```
### Docs are empty. Why?
There is a pretty huge chunk of documentation. We are ready to describe every method and object, but it requires a lot of work. Although **all** methods are **already** described [here](https://core.telegram.org/methods).
### Does this project support Windows?
Technically โ yes. In practice โ components don't require specific architecture, but we didn't test it yet. If you have any problems running it, just create an issue, we will try to help.
### Why Telegram API soooo unusable?
Well... Read [this issue](https://github.com/ton-blockchain/ton/issues/31) about TON source code. Use google translate, this issue will answer to all your questions.
## Who use it
## Contributing
Please read [contributing guide](https://github.com/xelaj/mtproto/blob/main/.github/CONTRIBUTING.md) if you want to help. And the help is very necessary!
**Don't want code?** Read [this](https://github.com/xelaj/mtproto/blob/main/.github/SUPPORT.md) page! We love nocoders!
## Security bugs?
Please, don't create issue which describes security bug, this can be too offensive! Instead, please read [this notification](https://github.com/xelaj/mtproto/blob/main/.github/SECURITY.md) and follow that steps to notify us about problem.
## TODO
- [x] Basic MTProto implementation
- [x] Implement all Methods for latest layer
- [x] Make TL Encoder/Decoder
- [x] Get away from panics in parsing TL
- [ ] Support MTProxy
- [ ] Support socks5 as well
- [ ] Multiple tests
- [ ] Write amazing docs
## Authors
* **Richard Cooper** <[[email protected]](mailto:[email protected])>
* **Anton Larionov** <[[email protected]](mailto:[email protected])>
* **Arthur Petukhovsky** <[[email protected]](mailto:[email protected])>
* **Roman Timofeev** <[[email protected]](mailto:[email protected])>
* **Artem** <[[email protected]](mailto:[email protected])>
* **Bo-Yi Wu** <[[email protected]](mailto:[email protected])>
* **0xflotus** <[[email protected]](mailto:[email protected])>
* **Luclu7** <[[email protected]](mailto:[email protected])>
* **Vladimir Stolyarov** <[[email protected]](mailto:[email protected])>
* **grinrill** [@grinrill](https://github.com/grinrill)
* **kulallador** <[[email protected]]([email protected])>
* **rs** <[[email protected]](mailto:[email protected])>
## License
WARNING! This project is only maintained by Xelaj inc., however copyright of this source code **IS NOT** owned by Xelaj inc. at all. If you want to connect with code owners, write mail to this email. For all other questions like any issues, PRs, questions, etc. Use GitHub issues, or find email on official website.
This project is licensed under the MIT License - see the [LICENSE](https://github.com/xelaj/mtproto/blob/main/LICENSE.md) file for details