react-native-quick-crypto 0.7.2 → 1.0.0-beta.1

package/README.md

@@ -1,203 +0,0 @@
-<a href="https://margelo.io">
-  <img src="./docs/img/banner.svg" width="100%" />
-</a>
-
-# ⚡️ 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](https://github.com/browserify/crypto-browserify) or [react-native-crypto](https://github.com/tradle/react-native-crypto)
-
-For example, creating a Wallet using ethers.js uses complex algorithms to generate a private-key/mnemonic-phrase pair:
-
-```ts
-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
-
-<h3>
-  React Native  <a href="#"><img src="./docs/img/react-native.png" height="15" /></a>
-</h3>
-
-```sh
-yarn add react-native-quick-crypto
-cd ios && pod install
-```
-
-<h3>
-  Expo  <a href="#"><img src="./docs/img/expo.png" height="12" /></a>
-</h3>
-
-```sh
-expo install react-native-quick-crypto
-expo prebuild
-```
-
-Optional: override `global.Buffer` and `global.crypto` in your application as early as possible for example in index.js.
-
-```ts
-import { install } from 'react-native-quick-crypto';
-
-install();
-```
-
-## 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!
-
-### Using metro config
-
-Use the [`resolveRequest`](https://facebook.github.io/metro/docs/resolution#resolverequest-customresolver) configuration option in your `metro.config.js`
-
-```js
-config.resolver.resolveRequest = (context, moduleName, platform) => {
-  if (moduleName === 'crypto') {
-    // when importing crypto, resolve to react-native-quick-crypto
-    return context.resolveRequest(
-      context,
-      'react-native-quick-crypto',
-      platform,
-    )
-  }
-  // otherwise chain to the standard Metro resolver.
-  return context.resolveRequest(context, moduleName, platform)
-}
-```
-
-### Using babel-plugin-module-resolver
-
-You need to install `babel-plugin-module-resolver`, it's a babel plugin that will alias any imports in the code with the values you pass to it. It tricks any module that will try to import certain dependencies with the native versions we require for React Native.
-
-```sh
-yarn add --dev babel-plugin-module-resolver
-```
-
-Then, in your `babel.config.js`, add the plugin to swap the `crypto`, `stream` and `buffer` dependencies:
-
-```diff
-module.exports = {
-  presets: ['module:metro-react-native-babel-preset'],
-  plugins: [
-+   [
-+     'module-resolver',
-+     {
-+       alias: {
-+         'crypto': 'react-native-quick-crypto',
-+         'stream': 'readable-stream',
-+         'buffer': '@craftzdog/react-native-buffer',
-+       },
-+     },
-+   ],
-    ...
-  ],
-};
-```
-
-Then restart your bundler using `yarn start --reset-cache`.
-
-## Usage
-
-For example, to hash a string with SHA256 you can do the following:
-
-```ts
-import QuickCrypto from 'react-native-quick-crypto';
-
-const hashed = QuickCrypto.createHash('sha256')
-  .update('Damn, Margelo writes hella good software!')
-  .digest('hex');
-```
-
----
-
-## Sponsors
-
-<!-- Onin -->
-<div align="center">
-<img height="50" src="./docs/img/sponsors/onin.svg" align="center"><br/>
-<a href="https://onin.co"><b>Onin</b></a> - This library is supported by Onin. Plan events without leaving the chat: <a href="https://onin.co">onin.co</a>
-</div>
-<br/>
-<br/>
-
-<!-- Steakwallet -->
-<div align="center">
-<img height="37" src="./docs/img/sponsors/omni.png" align="center"><br/>
-<a href="https://steakwallet.fi"><b>Omni</b></a> - 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!
-</div>
-<br/>
-<br/>
-
-<!-- Litentry -->
-<div align="center">
-<img height="70" src="./docs/img/sponsors/litentry.png" align="center"><br/>
-<a href="https://litentry.com"><b>Litentry</b></a> - A decentralized identity aggregator, providing the structure and tools to empower you and your identity.
-</div>
-<br/>
-<br/>
-
-<!-- WalletConnect -->
-<div align="center">
-<img height="35" src="./docs/img/sponsors/walletconnect.png" align="center"><br/>
-<a href="https://walletconnect.com"><b>WalletConnect</b></a> - The communications protocol for web3, WalletConnect brings the ecosystem together by enabling wallets and apps to securely connect and interact.
-</div>
-<br/>
-<br/>
-
-<!-- WalletConnect -->
-
-<!-- THORSwap -->
-<div align="center">
-<img height="40" src="./docs/img/sponsors/thorswap.png" align="center"><br/>
-<a href="https://thorswap.finance"><b>THORSwap</b></a> - 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.
-</div>
-<br/>
-<br/>
-
-## 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](https://fbflipper.com).
-
-Not all cryptographic algorithms are supported yet. See the [implementation coverage](./docs/implementation-coverage.md) document for more details. If you need a specific algorithm, please open a `feature request` issue and we'll see what we can do.
-
-## Community Discord
-
-[Join the Margelo Community Discord](https://discord.gg/6CSHz2qAvA) to chat about react-native-quick-crypto or other Margelo libraries.
-
-## 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 <a href="mailto:hello@margelo.io?subject=Adopting react-native-quick-crypto at scale">hello@margelo.io</a>!
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) 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](https://github.com/nodejs/node/blob/main/LICENSE).

package/android/src/main/java/com/margelo/quickcrypto/QuickCryptoModule.java

@@ -1,70 +0,0 @@
-package com.margelo.quickcrypto;
-
-import android.util.Log;
-
-import androidx.annotation.NonNull;
-
-import com.facebook.jni.HybridData;
-import com.facebook.proguard.annotations.DoNotStrip;
-import com.facebook.react.bridge.JavaScriptContextHolder;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactMethod;
-import com.facebook.react.module.annotations.ReactModule;
-import com.facebook.react.turbomodule.core.CallInvokerHolderImpl;
-
-@ReactModule(name = QuickCryptoModule.NAME)
-public class QuickCryptoModule extends ReactContextBaseJavaModule {
-  public static final String NAME = "QuickCrypto";
-
-  @DoNotStrip
-  private HybridData mHybridData;
-
-  private native HybridData initHybrid();
-
-  public QuickCryptoModule(ReactApplicationContext reactContext) {
-    super(reactContext);
-  }
-
-  @NonNull
-  @Override
-  public String getName() {
-    return NAME;
-  }
-
-  @ReactMethod(isBlockingSynchronousMethod = true)
-  public boolean install() {
-    try {
-      if (mHybridData != null) {
-        return false;
-      }
-      Log.i(NAME, "Loading C++ library...");
-      System.loadLibrary("reactnativequickcrypto");
-
-      JavaScriptContextHolder jsContext = getReactApplicationContext().getJavaScriptContextHolder();
-      CallInvokerHolderImpl jsCallInvokerHolder = (CallInvokerHolderImpl) getReactApplicationContext()
-                                                  .getCatalystInstance()
-                                                  .getJSCallInvokerHolder();
-
-
-      Log.i(NAME, "Installing JSI Bindings for react-native-quick-crypto...");
-      mHybridData = initHybrid();
-      nativeInstall(jsContext.get(), jsCallInvokerHolder);
-      Log.i(NAME, "Successfully installed JSI Bindings for react-native-quick-crypto!");
-
-      return true;
-    } catch (Exception exception) {
-      Log.e(NAME, "Failed to install JSI Bindings for react-native-quick-crypto!", exception);
-      return false;
-    }
-  }
-
-  public void destroy() {
-    if (mHybridData == null) {
-      return;
-    }
-    mHybridData.resetNative();
-  }
-
-  private native void nativeInstall(long jsiPtr, CallInvokerHolderImpl jsCallInvokerHolder);
-}

package/android/src/main/java/com/margelo/quickcrypto/QuickCryptoPackage.java

@@ -1,25 +0,0 @@
-package com.margelo.quickcrypto;
-
-import androidx.annotation.NonNull;
-
-import com.facebook.react.ReactPackage;
-import com.facebook.react.bridge.NativeModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.uimanager.ViewManager;
-
-import java.util.Collections;
-import java.util.List;
-
-public class QuickCryptoPackage implements ReactPackage {
-  @NonNull
-  @Override
-  public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
-    return Collections.singletonList(new QuickCryptoModule(reactContext));
-  }
-
-  @NonNull
-  @Override
-  public List<ViewManager> createViewManagers(@NonNull ReactApplicationContext reactContext) {
-    return Collections.emptyList();
-  }
-}