@arcium-hq/client 0.1.46 → 0.1.47

package/README.md

@@ -9,12 +9,10 @@ npm install @arcium-hq/client
 
 or
 
-```bash
 yarn add @arcium-hq/client
 
 or
 
-```bash
 pnpm add @arcium-hq/client
 ```
 
@@ -23,6 +21,7 @@ pnpm add @arcium-hq/client
 To send private data for computation within Arcium, you need to encrypt it using a shared secret derived from your keypair and the Arcium MXE's public key. The client SDK provides utilities for this using X25519 key exchange and the Rescue cipher.
 
 1.  **Generate a client keypair:**
+
     ```typescript
     import { x25519 } from "@arcium-hq/client";
 
@@ -31,7 +30,8 @@ To send private data for computation within Arcium, you need to encrypt it using
     ```
 
 2.  **Obtain the MXE's public key:**
-    *This key is typically specific to the Arcium cluster you are interacting with. You might obtain it through configuration or environment variables.*
+    _This key is typically specific to the Arcium cluster you are interacting with. You might obtain it through configuration or environment variables._
+
     ```typescript
     // Example public key (replace with the actual key)
     const mxePublicKey = new Uint8Array([
@@ -40,11 +40,13 @@ To send private data for computation within Arcium, you need to encrypt it using
     ```
 
 3.  **Compute the shared secret:**
+
     ```typescript
     const sharedSecret = x25519.getSharedSecret(privateKey, mxePublicKey);
     ```
 
 4.  **Initialize the Rescue cipher:**
+
     ```typescript
     import { RescueCipher } from "@arcium-hq/client";
 
@@ -52,7 +54,8 @@ To send private data for computation within Arcium, you need to encrypt it using
     ```
 
 5.  **Prepare plaintext and encrypt:**
-    *The plaintext should be an array of BigInts.*
+    _The plaintext should be an array of BigInts._
+
     ```typescript
     import { randomBytes } from "crypto";
 
@@ -68,7 +71,8 @@ To send private data for computation within Arcium, you need to encrypt it using
     ```
 
 6.  **Send data to Arcium:**
-    *You typically send the `ciphertext`, your `publicKey`, and the `nonce` (often converted to a `BN`) when calling an Arcium program instruction that requires encrypted inputs.*
+    _You typically send the `ciphertext`, your `publicKey`, and the `nonce` (often converted to a `BN`) when calling an Arcium program instruction that requires encrypted inputs._
+
     ```typescript
     // Example structure (actual usage depends on the specific program)
     // await program.methods.yourInstruction(
@@ -81,15 +85,18 @@ To send private data for computation within Arcium, you need to encrypt it using
     ```
 
 7.  **Decrypting results:**
-    *When your program receives results from Arcium (e.g., via an event), they will likely be encrypted. Use the same `cipher` instance and the `nonce` provided in the result/event to decrypt.*
+    _When your program receives results from Arcium (e.g., via an event), they will likely be encrypted. Use the same `cipher` instance and the `nonce` provided in the result/event to decrypt._
+
     ```typescript
     // Assuming `event.encryptedResult` is a Uint8Array or number[]
     // and `event.resultNonce` is a Uint8Array or number[] from the Arcium callback
     const resultCiphertextArray = [event.encryptedResult];
     const resultNonceArray = new Uint8Array(event.resultNonce);
 
-    const decryptedResult = cipher.decrypt(resultCiphertextArray, resultNonceArray);
+    const decryptedResult = cipher.decrypt(
+      resultCiphertextArray,
+      resultNonceArray
+    );
     // decryptedResult will be an array of bigints
     const resultValue = decryptedResult[0];
     ```
-