⚡️ react-native-quick-crypto

A fast implementation of Node's crypto module.

Unlike any other current JS-based polyfills, react-native-quick-crypto is written in C/C++ JSI and provides much greater performance - especially on mobile devices. QuickCrypto can be used as a drop-in replacement for your Web3/Crypto apps to speed up common cryptography functions.

🏎️ Up to 58x faster than all other solutions
⚡️ Lightning fast implementation with pure C++ and JSI, instead of JS
🧪 Well tested in JS and C++ (OpenSSL)
💰 Made for crypto apps and Wallets
🔢 Secure native compiled cryptography
🔁 Easy drop-in replacement for crypto-browserify or react-native-crypto

For example, creating a Wallet using ethers.js uses complex algorithms to generate a private-key/mnemonic-phrase pair:

const start = performance.now()
const wallet = ethers.Wallet.createRandom()
const end = performance.now()
console.log(`Creating a Wallet took ${end - start} ms.`)

Without react-native-quick-crypto 🐢:

Creating a Wallet took 16862 ms

With react-native-quick-crypto ⚡️:

Creating a Wallet took 289 ms

Installation

React Native

yarn add react-native-quick-crypto
yarn add react-native-quick-base64
cd ios && pod install

Expo

expo install react-native-quick-crypto
expo install react-native-quick-base64
expo prebuild

Replace `crypto-browserify`

If you are using a library that depends on crypto, instead of polyfilling it with crypto-browserify (or react-native-crypto) you can use react-native-quick-crypto for a fully native implementation. This way you can get much faster crypto operations with just a single-line change!

In your babel.config.js, add a module resolver to replace crypto with react-native-quick-crypto:

module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
+   [
+     'module-resolver',
+     {
+       alias: {
+         'crypto': 'react-native-quick-crypto',
+         'stream': 'stream-browserify',
+         'buffer': '@craftzdog/react-native-buffer',
+       },
+     },
+   ],
    ...
  ],
};

Then restart your bundler using yarn start --reset-cache.

Now, all imports for crypto will be resolved as react-native-quick-crypto instead.

💡 Since react-native-quick-crypto depends on stream and buffer, we can resolve those to stream-browserify and @craftzdog's react-native-buffer (which is faster than buffer because it uses JSI for base64 encoding and decoding).

Usage

For example, to hash a string with SHA256 you can do the following:

import Crypto from 'react-native-quick-crypto'

const hashed = Crypto.createHash('sha256')
  .update('Damn, Margelo writes hella good software!')
  .digest('hex')

Limitations

As the library uses JSI for synchronous native methods access, remote debugging (e.g. with Chrome) is no longer possible. Instead, you should use Flipper.

Adopting at scale

react-native-quick-crypto was built at Margelo, an elite app development agency. For enterprise support or other business inquiries, contact us at [email protected]!

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

react-native-quick-crypto is licensed under MIT.
react-native-quick-crypto is heavily inspired by NodeJS Crypto, which is licensed under nodejs/LICENSE.

ustuncem / react-native-quick-crypto Goto Github PK