mtcute / mtcute Goto Github PK

unlike tdlib, mtcute currently only caches the bare minimum needed to function. however, in many cases it makes sense to cache stuff locally, just like tdlib.

• cache results (*NotModified constructors + hash parameter)
• messages database
• dialogs database
• chat members database
• "full" peers database
• TBA...

ideally this should be done in a modular (and tree-shakeable) way - maybe some kind of request intercepting system would make sense here?

• support publishing to jsr.io (#27)
• stop globally depending on @types/node wontfix
• @mtcute/deno package with platform-specific transport, crypto and storage (#52)
• refactor proxy packages to be platform-agnostic, export the platform-specific implementations from the platform packages - requires better networking abstractions

we should migrate to building makefiles directly, because node-gyp depends on python and it sucks, and also add pre-built binaries for common platforms.

it's also broken on python 3.12+ due to nodejs/node-gyp#2869

currently dispatcher doesn't have any logging on its own. it would probably be quite useful if it logged events and whether something matched them or not

Does this library works with React Native/Expo projects? For example, gramjs dont work because of crypto, but this library use a different dependency

Tracking issue for:

• https://github.com/mtcute/mtcute/security/code-scanning/14

currently when sending messages/stories we expect the server to return updates with the actual message. however this might not actually be the case, so we should instead rely on random_id and updateMessageID

Sometimes I receive error (see logs sections) without no reason. It can happens at random time.

To Reproduce

1. Call resolvePeer(899433974)
2. With some chance you will receive error

p.s: 899433974 is @odesli_bot.

Expected behavior

Logs

Environment

OS: Windows 11 (WSL 2 with Ubuntu 22.04).
Runtime: Node.js v21.6.1.
mtcute version: ^0.7.0.

Additional context
No additional context.

bare minimum - accept them in .start() method and return them on .logOut()

Hello, dear developer! When I call exportSession() I receive error Error: Unknown object undefined.

To Reproduce

1. Log in to your account.
2. Call exportSession().
3. See result.

Expected behavior

Retrieve session string.

Logs

Error: Unknown object undefined
    at TlBinaryWriter.object (file:///home/lwjerri/projects/SpotiGram/node_modules/.pnpm/@[email protected]/node_modules/@mtcute/tl-runtime/esm/writer.js:243:19)
    at writeStringSession (file:///home/lwjerri/projects/SpotiGram/node_modules/.pnpm/@[email protected]/node_modules/@mtcute/core/esm/utils/string-session.js:22:12)
    at BaseTelegramClient.exportSession (file:///home/lwjerri/projects/SpotiGram/node_modules/.pnpm/@[email protected]/node_modules/@mtcute/core/esm/highlevel/base.js:168:16)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async saveSession (file:///home/lwjerri/projects/SpotiGram/dist/app.js:133:27)
    at async file:///home/lwjerri/projects/SpotiGram/dist/app.js:224:12

Environment

• OS: Windows 11 (WSL 2 with Ubuntu 22.04).
• Runtime: Node.js v21.6.1.
• mtcute version: ^0.7.0.

Additional context
I'm use NodeTelegramClient client instance from @mtcute/node package.

SQLite can't find the session file after pnpm i -r command.

To Reproduce

1. Run pnpm create @mtcute/bot my-awesome-bot.
2. Wait until all dependencies are installed.
3. Delete the node_modules folder.
4. Install all packages with the pnpm i -r command.
5. Run pnpm run run.

Expected behavior

An application must start as expected, without any errors.

Logs

Environment

• OS: Windows 11 (WSL 2 with Ubuntu 22.04).
• Runtime: Node.js v21.6.1.
• mtcute version: ^0.6.0.

Additional context
Some developers can use monorepository with this package, but it will not work, because we have this error.

I found this comment alik0211/mtproto-core#229 (comment) that has code for storage and transport on cloudflare workers , these are codes : https://github.com/Legend1991/mtproto-core/tree/master/envs/cloudflare

Could you please give me a code example how can i use that (exp. usage in my-awesome-bot template)?

/subj

add a high-level method sendTextMulti which would split the message into multiple if the text turns out to be too long.

we should probably also make a util to split TextWithEntities so users can implement it on their own for media messages (i'm not sure what the behavior should be on those)

How to reproduce

import { NodeTelegramClient } from '@mtcute/node'
import { Dispatcher, filters } from '@mtcute/dispatcher'

const tg = new NodeTelegramClient({
    apiId: 3328759,
    apiHash: 'e6bb1e8c05bd21386e33a5d89fe2e966',
    storage: 'bot-data/my-account',
    logLevel: 10
})

tg.run({
    phone: () => tg.input('phone > '),
    code: () => tg.input('code > '),
    password: () => tg.input('password > ')
}, async (self) => {
    console.log(`logged in as ${self.displayName}`)
})

• run the above code
• ctrl-c immediately after logging
• run the code again

Expected

the authorization is persisted

Actual

it is not

Currently updates handling is done in updates.ts file of client package, and core package only exposes a callback that is called whenever tl.TypeUpdates is received.

Correctly handling updates is pretty complex and should be done by a library, but I'm not entirely sure about moving updates handling to core since when using core, user might want to do something simple, or something very complex with custom storage schemes, etc., and in both cases updates handing isn't really needed.

Also this would be a breaking change in the APIs.

https://github.com/tdlib/td/blob/56163c2460a65afc4db2c57ece576b8c38ea194b/td/telegram/FileReferenceManager.cpp

implement file reference storage like described here: https://core.telegram.org/api/file_reference

currently @mtcute/tl is basically:

• a large map of constructor id -> reader function
• a large map of constructor name -> writer function
• a large union type in typescript

instead, we could do something along:

const messages_getMessages_write = (w) => { ... }
export function messages_getMessages(obj) {
  write: messages_getMessages_write,
  result: read.Updates,
  id: 12345678,
  obj,
}

for methods and similarly for objects (and put readers into a separate esm namespace - arguably, that's a much more rarely used case in the surface api).

// so, this
tg.call({ _: 'auth.exportAuthorization', ... })
// becomes this
tg.call(tl.auth.exportAuthorization({ ... }))

pros

• will make @mtcute/tl tree-shakeable
• will probably improve type checking performance (#30)
• we'll finally get rid of commonjs nonsense in mtcute and allow us to become esm-only
• end users will be able to easily invoke custom tl methods as we will no longer use

cons

• will be a major breaking change in the surface api
• currently unclear how to type the thing
• this will break the current way of overriding the schema. while it will provide some alternative, some cases will be missed

open questions

• how to handle error descriptions?
• what should reader functions return, plain objects?
  • if so, how do we transform those into something that can be written?
  • or do we even need to?

To Reproduce

const buffer = Buffer.from(b64, 'base64')
const photo = InputMedia.photo(buffer)
const phtemp = await tg.uploadMedia(photo)

Expected behavior

works fine

Environment

• OS: [e.g. windows]
• Runtime: [e.g. Node 18.12.1, Chrome 97.0.0]
• mtcute version: [e.g. 0.1.0]

Additional context

for some reason mime is not enough and we should also provide a valid file extension for that mime

After any change to the source code in a file with mtcute imports Intellisense operations take up to 5-10 sec to perform.

To Reproduce

Try to invoke .call method for TelegramClient object, e.g.:

const tg = new TelegramClient({...});
tg.call({...})

After typing "tg." it takes 5-10 sec to show method list.

Expected behavior

"Go to Definition" and "Autocomplete" operations perform in less than 1 sec.

Logs

Info 492 [17:26:49.904] request:
{
"seq": 99,
"type": "request",
"command": "quickinfo",
"arguments": {
"file": "/Users/.../mtcute/test/index.ts",
"line": 42,
"offset": 27
}
}
Perf 493 [17:26:49.916] 99::quickinfo: elapsed time (in milliseconds) 12.0900

Environment

• OS: MacOS 14.4.1
• Runtime: Node.js 20
• mtcute version: 0.10.1

Additional context
The codesandbox repo below can be opened locally with VSCode.

CodeSandbox

Currently pre-update middleware in Dispatcher allows user to add additional fields to the update info object:

interface TimerContext {
    start: number
}

dp.onPreUpdate<TimerContext>((upd) => {
    upd.start = Date.now()
})

dp.onPostUpdate<TimerContext>((handled, upd) => {
    if (handled) {
        console.log(`handled ${upd.type} in ${Date.now() - upd.start} ms`)
    }
})

This additional context is currently only available in post-update middleware and error handler, and not handlers/filters.

I'm not sure if providing it there would be useful, and if it would, not sure how to implement it in a way that is non-obtrusive, intuitive and type-safe.

ctr256 can work in place, we can reduce the number of allocs there. also check if we can use some pre-alloced pool for small chunks

/subj. was reported in tg chat

To Reproduce

create a node.js project, put "module": "esnext" in tsconfig.json, try compiling this code:

import { TelegramClient } from '@mtcute/node'

const tg = new TelegramClient({})
tg.exportSession() // <- error, `exportSession` not found

Expected behavior

works fine

Logs

n/a

Environment

• OS: n/a
• Runtime: node any, ts
• mtcute version: 0.10.0

Additional context
this happens because ts can't resolve @mtcute/core/client.js under esnext, because it ignores exports field in package.json:

we should probably also generate the client.js/utils.js/etc. files at root dir based on our package.json exports in build script, but this is blocked by #27

something similar to what grammy has:

await tg.sendText(fmt`hi, ${bold(user.name)}!`)

this becomes quite tedious and unreadable though with nested entities:

await tg.sendText(
  fmt`${bold(fmt`hi, ${italic(user.name)}`)}!`
)

idk if there's a way to prevent this

https://core.telegram.org/cdn