Skip to content

Latest commit

 

History

History
168 lines (125 loc) · 5.58 KB

README.md

File metadata and controls

168 lines (125 loc) · 5.58 KB
Raw

⚡️ 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-crypto 🐢:

Creating a Wallet took 16862 ms

With react-native-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')

Sponsors


Onin - This library is supported by Onin. Plan events without leaving the chat: onin.co



Omni - Web3 for all. Access all of Web3 in one easy to use wallet. Omni supports more blockchains so you get more tokens, more yields, more NFTs, and more fun!



Litentry - A decentralized identity aggregator, providing the structure and tools to empower you and your identity.



WalletConnect - The communications protocol for web3, WalletConnect brings the ecosystem together by enabling wallets and apps to securely connect and interact.



THORSwap - THORSwap is a cross-chain DEX aggregator that enables users to swap native assets across chains, provide liquidity to earn yield, and more. THORSwap is fully permissionless and non-custodial. No account signup, your wallet, your keys, your coins.


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 hello@margelo.io!

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.