Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@mtproto/core
Advanced tools
Telegram API (MTProto) client library for browser and nodejs
yarn add @mtproto/core -E
# or
npm i @mtproto/core -E
You need api_id and api_hash. If you do not have them yet, then get them according to the official instructions: creating your Telegram application.
const { MTProto } = require('@mtproto/core');
const api_id = 'YOU_API_ID';
const api_hash = 'YOU_API_HASH';
// 1. Create an instance
const mtproto = new MTProto({
api_id,
api_hash,
});
// 2. Get the user country code
mtproto.call('help.getNearestDc').then(result => {
console.log(`country:`, result.country);
});
new MTProto({ api_id, api_hash, test, customLocalStorage }) => mtproto
api_id: number
and api_hash: string
api_id and api_hash are required. If you do not have them yet, then get them according to the official instructions: creating your Telegram application.
test: boolean
Default: false
. Use test data centers. On test servers, you can use test phone numbers.
customLocalStorage: localStorage
Default for browser: window.localStorage
. Default for nodejs: node-localstorage
. Custom storage for save auth data. Your localStorage must follow this API:
interface MyLocalStorage {
setItem(key: string, value: string): void;
getItem(key: string): string;
}
We have ready-made storage:
Example:
const { tempLocalStorage } = require('@mtproto/core/src/storage/temp');
const mtproto = new MTProto({
customLocalStorage: tempLocalStorage,
});
mtproto.call(method, params, options) => Promise
method: string
Method name from methods list.
params: object
Parameters for method
from https://core.telegram.org/method/{method}#parameters
.
If you need to pass a constructor use _
. Example for users.getFullUser:
const params = {
id: {
_: 'inputUserSelf',
},
};
options.dcId: number
Specific DC id. By default, it is 2
. You can change the default value using mtproto.setDefaultDc method.
options.syncAuth: boolean
Default: true
. Copy authorization to all DC if the response contains auth.authorization
.
mtproto.call('help.getNearestDc', {}, {
dcId: 1
}).then(result => {
console.log('result:', result);
// { _: 'nearestDc', country: 'RU', this_dc: 1, nearest_dc: 2 }
}).catch(error => {
console.log('error.error_code:', error.error_code);
console.log('error.error_message:', error.error_message);
});
mtproto.updates.on(updates, listener)
Method for handles updates.
Example of handling a updateShort with updateUserStatus:
mtproto.updates.on('updateShort', message => {
const { update } = message;
if (update._ === 'updateUserStatus') {
const { user_id, status } = update;
console.log(`User with id ${user_id} change status to ${status}`);
}
});
mtproto.setDefaultDc(dcId)
If a migration error occurs, you can use this function to change the default data center. You can also use options.dcId.
See the example in the authentication.
getSRPParams({ g, p, salt1, salt2, gB, password }) => { A, M1 }
Function to calculate parameters for 2FA (Two-factor authentication). For more information about parameters, see the article on the Telegram website.
See the example in the authentication.
FAQs
Telegram API JS (MTProto) client library for Node.js and browser
The npm package @mtproto/core receives a total of 706 weekly downloads. As such, @mtproto/core popularity was classified as not popular.
We found that @mtproto/core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.