mtcute/packages/crypto-node
2024-04-21 04:53:09 +03:00
..
lib ci: node prebuilt worker 2024-04-13 05:49:13 +03:00
src feat(crypto-node): bundle prebuilts with the package 2024-04-13 06:59:12 +03:00
tests chore: initial bun support 2024-02-20 00:55:41 +03:00
.gitignore ci: node prebuilt worker 2024-04-13 05:49:13 +03:00
binding.gyp ci: node prebuilt worker 2024-04-13 05:49:13 +03:00
build.config.cjs ci: fix docs build 2024-04-14 04:52:18 +03:00
package.json build: initial support for jsr building 2024-04-21 04:53:09 +03:00
README.md docs: updated readmes 2024-03-07 05:35:37 +03:00
tsconfig.json ESM + end-to-end tests (#11) 2023-10-16 19:23:53 +03:00
typedoc.cjs chore: moved most configs to .config 2023-11-13 13:28:11 +03:00

@mtcute/crypto-node

📖 API Reference

Native extension for NodeJS that improves performance of the most used cryptographic mode in Telegram (IGE), which is not implemented directly by OpenSSL.

Uses OpenSSL under the hood to provide maximum performance

Installation

You will need all the pre-requisites for node-gyp. Pre-built packages are currently not available.

Then, install the package as usual. The native library will be built automatically.

Usage

import { TelegramClient } from '@mtcute/core'
import { NodeNativeCryptoProvider } from '@mtcute/crypto-node'

const tg = new TelegramClient({
    ...,
    crypto: () => new NodeNativeCryptoProvider()
})

Tip: When using @mtcute/node, this will be done automatically for you.

Benchmarks

See https://github.com/mtcute/benchmarks