Full-native implementation of MTProto protocol on Golang!
english русский
![](docs/assets/ezgif-3-a6bd45965060.gif)
![](docs/assets/ezgif-3-19ced73bc71f.gif)
![](docs/assets/ezgif-3-5b6a808d2774.gif)
![](docs/assets/ezgif-3-3ac8a3ea5713.gif)
![](docs/assets/ezgif-3-7bcf6dc78388.gif)
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:
func main() {
client := &Telegram.NewClient()
// for each method there is specific struct for serialization (<method_name>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:
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
Full docs are here
Installation is simple. Just do go get
:
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
go generate github.com/xelaj/mtproto
That's it! You don't need to do anything more!
It's Telegram specific feature. I you want to create client instance and get information about the current servers configuration, you need to do something like this:
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 IvokeWithLayer
Query: &telegram.HelpGetConfigParams{},
})
Why? We don't know! This method is described in Telegram API docs, any other starting requests will receive error.
Example here
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.
There is a pretty huge chunk of documentation. We are ready to describe every method and object, but its requires a lot of work. Although all methods are already described here.
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.
Please read contributing guide if you want to help. And the help is very necessary!
[ ]
- Richard Cooper <[email protected]>
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 file for details