@zama-fhe/relayer-sdk 0.1.0-1

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Zama
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,55 @@
+<p align="center">
+<img width=600 src="https://github.com/user-attachments/assets/6173e401-7c1b-4911-9731-ca2eb436e85f" />
+</p>
+<hr/>
+<p align="center">
+  <!-- TODO: Migrate documentation links to https://docs.zama.ai/relayer -->
+  <a href="https://docs.zama.ai/fhevm">📃 Read white paper</a> | <a href="https://docs.zama.ai/fhevm">📒 Read documentation</a> | <a href="https://zama.ai/community">💛 Community support</a>
+</p>
+<p align="center">
+<!-- Version badge using shields.io -->
+  <a href="https://github.com/zama-ai/relayer-sdk/releases"><img src="https://img.shields.io/github/v/release/zama-ai/relayer-sdk?style=flat-square"/></a>
+<!-- Zama Bounty Program -->
+  <a href="https://github.com/zama-ai/bounty-program"><img src="https://img.shields.io/badge/Contribute-Zama%20Bounty%20Program-yellow?style=flat-square"/></a>
+</p>
+<hr/>
+
+fhevm SDK is a javascript library that enables developers to interact with blockchains using Zama's cutting-edge technology based on TFHE (Fully Homomorphic Encryption over the Torus). This library provides a seamless integration of TFHE encryption capabilities into web3 applications, allowing for secure and private interactions with smart contracts.
+
+## Installation
+
+```bash
+# Using npm
+npm install @zama-fhe/relayer-sdk
+
+# Using Yarn
+yarn add @zama-fhe/relayer-sdk
+
+# Using pnpm
+pnpm add @zama-fhe/relayer-sdk
+```
+
+This will download and install the fhevm Relayer SDK and its dependencies into your project.
+
+## Contributing
+
+There are two ways to contribute to the Relayer SDK:
+
+- you can open issues to report bugs or typos, or to suggest new ideas
+- you can ask to become an official contributor by emailing hello@zama.ai. (becoming an approved contributor involves signing our Contributor License Agreement (CLA))
+  Only approved contributors can send pull requests, so please make sure to get in touch before you do!
+
+## Credits
+
+This library uses several dependencies and we would like to thank the contributors of those libraries.
+
+## Need support?
+
+<a target="_blank" href="https://community.zama.ai">
+  <img src="https://github.com/zama-ai/relayer-sdk/assets/1384478/4fc4e460-ca1d-4910-8bc2-cd1d50c7d020">
+</a>
+
+## License
+
+This software is distributed under the BSD-3-Clause-Clear license. If you have any questions,
+please contact us at `hello@zama.ai`.

package/bin/relayer.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+'use strict';
+
+import { program } from 'commander';
+import { toHexString, prependHttps, throwError } from './utils.js';
+import { createInstance } from '../lib/node.cjs';
+
+const allowedBits = [1, 4, 8, 16, 32, 64];
+
+const FHE_LIB_ADDRESS = '0x000000000000000000000000000000000000005d';
+
+let _instance;
+
+const getInstance = async (networkUrl) => {
+  if (_instance) return _instance;
+
+  try {
+    _instance = await createInstance({ networkUrl });
+  } catch (e) {
+    return throwError(
+      `This network (${networkUrl}) doesn't seem to use Fhevm or use an incompatible version.`,
+    );
+  }
+  return _instance;
+};
+
+program
+  .command('encrypt')
+  .argument('<contractAddress>', 'address of the contract')
+  .argument('<userAddress>', 'address of the account')
+  .argument('<values:bits...>', 'values with number of bits eg: 1:1 3324242:64')
+  .action(async (contractAddress, userAddress, valuesArr, options) => {
+    const host = prependHttps(options.node);
+    const instance = await getInstance(host);
+    const encryptedInput = instance.createEncryptedInput(
+      contractAddress,
+      userAddress,
+    );
+    valuesArr.forEach((str, i) => {
+      const [value, bits] = str.split(':');
+      if (!allowedBits.includes(+bits)) throwError('Invalid number of bits');
+      const suffix = +bits === 1 ? 'Bool' : bits === '160' ? 'Address' : bits;
+      try {
+        encryptedInput[`add${suffix}`](parseInt(value, 10));
+      } catch (e) {
+        return throwError(e.message);
+      }
+    });
+    const result = await encryptedInput.encrypt();
+
+    console.log('Input proof:');
+    console.log(`0x${toHexString(result.inputProof)}`);
+    console.log('Handles:');
+    result.handles.forEach((handle, i) => {
+      console.log(`Handle ${i}`);
+      console.log(`0x${toHexString(handle)}`);
+    });
+  })
+  .requiredOption('-n, --node <url>', 'url of the blockchain');
+
+program.parseAsync(process.argv);

package/bin/utils.js

@@ -0,0 +1,14 @@
+export const prependHttps = (host) => {
+  if (!/^https?:\/\//i.test(host)) {
+    return 'https://' + host;
+  }
+  return host;
+};
+
+export const toHexString = (bytes) =>
+  bytes.reduce((str, byte) => str + byte.toString(16).padStart(2, '0'), '');
+
+export const throwError = (error) => {
+  console.error(`Error: ${error}`);
+  process.exit();
+};