mtproton

6.0.0 • Public • Published

mtproton

NPM Downloads

Telegram API JS (MTProto) client library for browser and nodejs

  • Actual. 133 layer in the API scheme
  • Fast. For the Node.js, it uses the TCP and crypto module. For the browser, it uses WebSocket and window.crypto
  • Easy. Cryptography and bytes is hidden. Just make requests to the API
  • Smart. Automatically sync authorization on all DC's
  • Events. Subscribe to updates via the EventEmitter API
  • 2FA. Use the library's built-in function to calculate 2FA parameters
  • Secure. Complies with Telegram security guidelines

Install

npm i mtproton -E

Quick start

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 path = require('path');
const MTProto = require('mtproton');

const api_id = YOU_API_ID;
const api_hash = YOU_API_HASH;

// 1. Create instance
const mtproto = new MTProto({
  api_id,
  api_hash,

  storageOptions: {
    path: path.resolve(__dirname, './data/1.json'),
  },
});

// 2. Print the user country code
mtproto.call('help.getNearestDc').then(result => {
  console.log('country:', result.country);
});

Guides

API

new MTProto({ api_id, api_hash, test, storageOptions }) => mtproto

api_id: number and api_hash: string and storageOptions: { path: string, instance: object }

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.

storageOptions: { instance?: customLocalStorage, path?: 'path to json storage file' }

We have default storages. The storage is used to store the session (authentication keys, server salts and time offset). Depending on the environment, you need to pass different parameters for the storage. But you can also use custom storage

For node environment

In the storageOptions.path, pass the absolute path to the json file through the constructor

new MTProto({
  storageOptions: {
    path: path.resolve(__dirname, './data/1.json'),
  },
});

For browser environment

The window.localStorage is used for storage. You don't need to pass storageOptions

Custom Storage

class CustomStorage {
  set(key: string, value: string): Promise<void>;
  get(key: string): Promise<string|null>;
}
const instance = new CustomStorage();

new MTProto({
  storageOptions: {
    instance,
  },
});

We have ready-made storage:

  1. tempStorage only stores data while the script is running

Example:

const tempStorage = require('mtproton/core/src/storage/temp');

new MTProto({
  storageOptions: {
    instance: tempStorage,
  },
});

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.

  1. If the method needs the flags parameter, flags is calculated automatically 🙃

  2. 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.

Example:

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) => Promise

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.

mtproto.updateInitConnectionParams(params)

Provide params for initConnection method. I recommend running this function immediately after creating an instance of MTProto.

See the example in the quick start.

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.

Useful references

Package Sidebar

Install

npm i mtproton

Weekly Downloads

9

Version

6.0.0

License

GPL-3.0

Unpacked Size

574 kB

Total Files

34

Last publish

Collaborators

  • godliked