\n Polygen allows you to run WebAssembly Modules in your React Native apps, with near native speed.\n\n \n \n Report a Bug\n ·\n Request Feature\n
\n\n## Getting started\n\n> [!WARNING]\n> This library is still under active development. Feel free to hack around, but use at your own risk.\n\n## How it works?\n\nInstead of interpreting the WebAssembly modules, or doing Just-in-Time compilation, Polygen instead leverages the Ahead-of-Time compilation.\nThis solution can be used in iOS applications and other Apple devices, where JIT compilation is not allowed,\nwithout impacting performance.\n\nIt uses the wonderful [`wasm2c`](https://github.com/WebAssembly/wabt/tree/main/wasm2c) tool to generate C code from every `WebAssembly` module.\nThen, additional React Native/JSI glue native code is generated that allows to call the generated C code from JavaScript.\n\nThis gives us the ability to run WebAssembly modules in a statically compiled way, without the need for JIT compilation.\n\n## Features\n\n| Feature | Status |\n|----------------------|----------|\n| WebAssembly 2.0 | ๐ฉ |\n| - Exceptions | ๐ฅ |\n| - Threads | ๐ฅ |\n| - Garbage Collection | ๐ฅ |\n| - Multiple Memories | ๐จ |\n| - Mutable Globals | ๐จ |\n| WebAPI | ๐จ |\n| - Fetch | ๐ฉ |\n| Native | ๐จ |\n| - Metro | ๐จ |\n| - Re.Pack | ๐ฅ |\n\n\n## Requirements\n\n- React Native 0.75+\n- Only new RN Architecture is supported\n\n## Prerequisites\n\nBecause Polygen Codegen depends on [`wasm2c`](https://github.com/WebAssembly/wabt) tool, you need to have it installed on your machine.\nYou can install it using your package manager:\n\n ```sh\n # macOS\n brew install wabt\n\n # linux\n sudo apt install wabt\n ```\n\n\nOther installation options\n\nIf for some reason:\n\n - you cannot use the package manager method,\n - you are on Windows,\n - or the version there is outdated,\n\nyou can still install `wabt` in a few other ways:\n\n**Option 1: Downloading prebuild binaries**\n\nDownload precompiled binaries from the [releases page](https://github.com/WebAssembly/wabt/releases) of `wabt` project.\nSelect correct version for your platform and extract it to the directory of your choice.\n\n**Option 2: Building from source**\n\nYou can also build `wabt` from source. To do this, you need to have `cmake` and `git` installed on your machine.\n\n```sh\n$ git clone --recursive https://github.com/WebAssembly/wabt\n$ cd wabt\n$ git submodule update --init\n$ cmake -B build -S .\n$ cmake --build build\n```\n\n**Install binaries**\n\nYou need to make binaries visible to Polygen. You can do this by adding the directory with the binaries to your system environment:\n\n```sh\n# Using WABT_PATH variable:\n$ export WABT_PATH=/path/to/wabt/binaries\n\n# or adding to PATH:\n$ export PATH=\"$PATH:/path/to/wabt/binaries\"\n```\n\n> If you built WABT from source, the path should point to the `build` directory.\n\nTo make those changes persistent, add them to your `.bashrc`/`.zshrc`/`.profile` file.\n\n\n\n## Installation\n\nIn your React Native project run:\n\n```sh\nnpx @callstack/polygen init\n# or\nyarn dlx @callstack/polygen init\n```\n\n## Usage\n\nIn your application folder run:\n\n```sh\n## npm\nnpx polygen scan\n# apply changes in config\nnpx polygen generate\n\n## yarn\nyarn polygen scan\n# apply changes in config\nyarn polygen generate\n```\n\nRun `polygen scan` to search for changes in found WebModules. All modules must be explictly listed in `polygen.config.[mc]js`\nRun `polygen generate` after any of the WebAssembly module changed.\n\nTo use WebAssembly API, import `@callstack/polygen/polyfill` in your application (before any other imports):\n\n```js\nimport '@callstack/polygen/polyfill';\n```\n\n### Metro\n\nPolygen has a Metro plugin that allows you to import WebAssembly modules in your application.\n\n> [!WARNING]\n> Currently, only modules from the current package are supported. This will be implemented in the next version.\n\nAdd `@callstack/polygen-metro-config` dependency to your project:\n\n```sh\nyarn add -D @callstack/polygen-metro-config\n```\n\nThen, in your `metro.config.js` file, add the following:\n\n```js\nconst { withPolygenConfig } = require('@callstack/polygen-metro-config');\n```\n\nAnd wrap your Metro configuration with `withPolygenConfig` call:\n\n```js\nconst config = {\n // ...\n};\n\nmodule.exports = withPolygenConfig(\n mergeConfig(getDefaultConfig(__dirname), config)\n);\n```\n\nThen, you should be able to import module buffers in your application:\n\n```js\nimport example from '../table_test.wasm';\n\nconst instance = new WebAssembly.Instance(new WebAssembly.Module(example));\n```\n\n### Using Fetch\n\nYou can also pass WebAssembly module binary loaded using `fetch`, or any other method:\n\n```js\nawait WebAssembly.compileStreaming(\n fetch('http://localhost:8000/example.wasm')\n)\n```\n\nThe downloaded module is not actually executed, but a native counterpart is searched based on the module checksum.\n\nThis does not require any additional setup, but it has the overhead of fetching the module on runtime, just for it to\nbe discarded.\n\nFor it to work, you need:\n\n - Place exactly the same WebAssembly Module in `src` directory of your application.\n - The module binary checksums must match\n\n## Examples\n\nSee `apps` directory for usage examples.\n\n## Contributing\n\nSee the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.\n\n\n## Made with โค๏ธ at Callstack\n\nPolygen is an open source project and will always remain free to use. If you think it's cool, please star it ๐. [Callstack](https://callstack.com) is a group of React and React Native geeks, contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these or just want to say hi!\n\nLike the project? โ๏ธ [Join the team](https://callstack.com/careers/?utm_campaign=Senior_RN&utm_source=github&utm_medium=readme) who does amazing stuff for clients and drives React Native Open Source! ๐ฅ\n","readmeFilename":"README.md"}
![\"Build](\"https://img.shields.io/github/actions/workflow/status/callstackincubator/polygen/ci.yml?style=flat-square\")
![\"Version\"](\"https://img.shields.io/npm/v/@callstack/polygen?style=flat-square\")
![\"License\"](\"https://img.shields.io/github/license/callstackincubator/polygen?color=green&style=flat-square\")
![\"Issues\"](\"https://img.shields.io/github/issues/callstackincubator/polygen?color=green&style=flat-square\")
![\"Discord\"](\"https://img.shields.io/discord/426714625279524876.svg?style=flat-square&colorB=758ED3\")
\n\n\n\n ![\"Callstack](\"https://callstack.com/images/callstack-badge.svg\"){kind=icon}
\n\n