Merge pull request #119 from FhenixProtocol/cofhejs-0.3.1

Update cofhejs version + update encrypt usage

Author: tovi-fhe

docs/devdocs/cofhejs/encryption-operations.md

@@ -41,20 +41,20 @@ const logState = (state) => {
     console.log(`Log Encrypt State :: ${state}`);
 };
 
-let result: [CofheInBool] = await cofhejs.encrypt(logState, [Encryptable.bool(true)]);
-let result: [CoFheInUint8] = await cofhejs.encrypt(logState, [Encryptable.uint8(10)]);
-let result: [CoFheInUint16] = await cofhejs.encrypt(logState, [Encryptable.uint16(10)]);
-let result: [CoFheInUint32] = await cofhejs.encrypt(logState, [Encryptable.uint32(10)]);
-let result: [CoFheInUint64] = await cofhejs.encrypt(logState, [Encryptable.uint64(10)]);
-let result: [CoFheInUint128] = await cofhejs.encrypt(logState, [Encryptable.uint128(10)]);
-let result: [CoFheInUint256] = await cofhejs.encrypt(logState, [Encryptable.uint256(10)]);
-let result: [CoFheInAddress] = await cofhejs.encrypt(logState, [Encryptable.address("0x1234567890123456789012345678901234567890")]);
+let result: [CofheInBool] = await cofhejs.encrypt([Encryptable.bool(true)], logState);
+let result: [CoFheInUint8] = await cofhejs.encrypt([Encryptable.uint8(10)], logState);
+let result: [CoFheInUint16] = await cofhejs.encrypt([Encryptable.uint16(10)], logState);
+let result: [CoFheInUint32] = await cofhejs.encrypt([Encryptable.uint32(10)], logState);
+let result: [CoFheInUint64] = await cofhejs.encrypt([Encryptable.uint64(10)], logState);
+let result: [CoFheInUint128] = await cofhejs.encrypt([Encryptable.uint128(10)], logState);
+let result: [CoFheInUint256] = await cofhejs.encrypt([Encryptable.uint256(10)], logState);
+let result: [CoFheInAddress] = await cofhejs.encrypt([Encryptable.address("0x1234567890123456789012345678901234567890")], logState);
 ```
 
 Or, we can use the nested form to encrypt multiple values at once:
 
 ```javascript
-let result = await cofhejs.encrypt(logState, [
+let result = await cofhejs.encrypt([
 	Encryptable.bool(true),
 	Encryptable.uint8(10),
 	Encryptable.uint16(10),
@@ -63,7 +63,7 @@ let result = await cofhejs.encrypt(logState, [
 	Encryptable.uint128(10),
 	Encryptable.uint256(10),
 	Encryptable.address('0x1234567890123456789012345678901234567890'),
-])
+], logState)
 ```
 
 The returned types from the encrypt function will be an array of the type `CoFheInBool`, `CoFheInUint8`, `CoFheInUint16`, `CoFheInUint32` (or 64/128/256) or `CoFheInAddress` depending on the type you specified.

docs/devdocs/cofhejs/index.md

@@ -120,11 +120,11 @@ const logState = (state: EncryptStep) => {
 };
 
 // This will encrypt only the encrypted values (total 4 in this case)
-const encryptedValues = await cofhejs.encrypt(logState, [
+const encryptedValues = await cofhejs.encrypt([
     { a: Encryptable.bool(false), b: Encryptable.uint64(10n), c: "hello" },
     ["hello", 20n, Encryptable.address(contractAddress)],
     Encryptable.uint8("10"),
-] as const);
+] as const, logState);
 
 const contract = new ethers.Contract(CONTRACT_ADDRESS, CONTRACT_ABI, wallet);
 // Use the encrypted value of 10n
@@ -259,7 +259,7 @@ await decryptCounter();
 // Result should be 2
 await readCounterDecryptedValue();
 
-const encryptedValues = await cofhejs.encrypt(logState, [Encryptable.uint64(10n)]);  
+const encryptedValues = await cofhejs.encrypt([Encryptable.uint64(10n)], logState);  
 await resetCounter(encryptedValues.data[0]);
 
 // Result should be 10

docs/devdocs/pay-attention/component-compatibility.md

@@ -13,9 +13,9 @@ This document provides detailed compatibility information for all components in
 | Component | Current Version | Minimum Compatible Version                                                                | Notes |
 |-----------|----------------|-------------------------------------------------------------------------------------------|-------|
 | **cofhe-contracts** | [`0.0.13`](https://github.com/FhenixProtocol/cofhe-contracts/tree/v0.0.13) ([abi](https://cofhe-docs.s3.us-east-1.amazonaws.com/v0.0.13/index.html)) | [`0.0.13`](https://github.com/FhenixProtocol/cofhe-contracts/tree/v0.0.13) ([abi](https://cofhe-docs.s3.us-east-1.amazonaws.com/v0.0.13/index.html))      | Solidity Libraries and Smart contracts for FHE operations. |
-| **Cofhejs** | [`0.3.0`](https://github.com/FhenixProtocol/cofhejs/releases/tag/v0.3.0) | [`0.2.1-alpha.1`](https://github.com/FhenixProtocol/cofhejs/releases/tag/v0.2.1-alpha.1) | JavaScript library for interacting with FHE contracts and the CoFHE coprocessor. |
-| **cofhe-mock-contracts** | [`0.3.0`](https://github.com/FhenixProtocol/cofhe-mock-contracts/releases/tag/v0.3.0) | [`0.2.1-alpha.3`](https://github.com/FhenixProtocol/cofhe-mock-contracts/releases/tag/v0.2.1-alpha.3) | Solidity contracts that mimic CoFHE off-chain behavior. |
-| **cofhe-hardhat-plugin** | [`0.3.0`](https://github.com/FhenixProtocol/cofhe-hardhat-plugin/releases/tag/v0.3.0) | [`0.2.1-alpha.3`](https://github.com/FhenixProtocol/cofhe-hardhat-plugin/releases/tag/v0.2.1-alpha.3) | Hardhat plugin that deploys the cofhe-mock-contracts and exposes utilities. |
+| **Cofhejs** | [`0.3.1`](https://github.com/FhenixProtocol/cofhejs/releases/tag/v0.3.1) | [`0.2.1-alpha.1`](https://github.com/FhenixProtocol/cofhejs/releases/tag/v0.2.1-alpha.1) | JavaScript library for interacting with FHE contracts and the CoFHE coprocessor. |
+| **cofhe-mock-contracts** | [`0.3.1`](https://github.com/FhenixProtocol/cofhe-mock-contracts/releases/tag/v0.3.1) | [`0.2.1-alpha.3`](https://github.com/FhenixProtocol/cofhe-mock-contracts/releases/tag/v0.2.1-alpha.3) | Solidity contracts that mimic CoFHE off-chain behavior. |
+| **cofhe-hardhat-plugin** | [`0.3.1`](https://github.com/FhenixProtocol/cofhe-hardhat-plugin/releases/tag/v0.3.1) | [`0.2.1-alpha.3`](https://github.com/FhenixProtocol/cofhe-hardhat-plugin/releases/tag/v0.2.1-alpha.3) | Hardhat plugin that deploys the cofhe-mock-contracts and exposes utilities. |
 
 
 ## Network Compatibility

docs/devdocs/tutorials/migrating-to-cofhe.md

@@ -214,7 +214,7 @@ const logState = (state) => {
 	// diff-add
 }
 // diff-add
-const encryptedValues = await cofhejs.encrypt(logState, [Encryptable.uint32(10n), Encryptable.uint64(20n)])
+const encryptedValues = await cofhejs.encrypt([Encryptable.uint32(10n), Encryptable.uint64(20n)], logState)
 ```
 
 ### 3. Permits and Unsealing