gun-eth 1.3.5 → 2.0.0

package/types/types.d.ts

@@ -0,0 +1,244 @@
+/**
+ * This contains a subscribable function that will return a boolean of whether or not the user is authenticated or not.
+ */
+declare var isAuthenticated: any;
+
+/**
+ * This function will check and see whether the user is authenticated or not.
+ */
+declare function checkAuth(): void;
+
+/**
+ * This function will authenticate a user who has registered.
+ * @param credentials - The users authentication credentials that they used when registering.
+ * @param callback - The callback function returns error messages or a success message.
+ */
+declare function loginUser(credentials: {
+    username: any;
+    password: any;
+}, callback: (...params: any[]) => any): void;
+
+/**
+ * This function will check to see if the email is already in use.
+ * @returns Promise<boolean>
+ */
+declare function checkUsernameInUse(username: string): any;
+
+/**
+ * This function will create a user.
+ * @param credentials - The users authentication credentials that they want to use when logging in.
+ * @param callback - The callback function returns error messages or a success message.
+ */
+declare function registerUser(credentials: {
+    username: any;
+    password: any;
+}, callback: (...params: any[]) => any): void;
+
+/**
+ * Genera un certificato per le richieste di amicizia.
+ * @param callback - Funzione di callback chiamata al completamento dell'operazione.
+ */
+declare function generateFriendRequestsCertificate(callback: (...params: any[]) => any): Promise<void>;
+
+/**
+ * Genera un certificato per aggiungere un amico.
+ * @param publicKey - Chiave pubblica dell'amico da aggiungere.
+ * @param callback - Funzione di callback chiamata al completamento dell'operazione.
+ */
+declare function generateAddFriendCertificate(publicKey: string, callback: (...params: any[]) => any): Promise<void>;
+
+/**
+ * Modulo per la gestione dei certificati nell'applicazione.
+ */
+declare module "certificates" { }
+
+/**
+ * Crea un certificato per le chat con un utente specifico.
+ * @param publicKey - La chiave pubblica dell'utente per cui creare il certificato.
+ * @param [callback] - Funzione di callback opzionale chiamata al completamento dell'operazione.
+ */
+declare function createChatsCertificate(publicKey: string, callback?: (...params: any[]) => any): Promise<void>;
+
+/**
+ * Crea un certificato per i messaggi con un utente specifico.
+ * @param publicKey - La chiave pubblica dell'utente per cui creare il certificato.
+ * @param [callback] - Funzione di callback opzionale chiamata al completamento dell'operazione.
+ */
+declare function createMessagesCertificate(publicKey: string, callback?: (...params: any[]) => any): Promise<void>;
+
+/**
+ * Accetta una richiesta di amicizia.
+ * @param params - Parametri della funzione.
+ * @param params.key - Chiave della richiesta di amicizia.
+ * @param params.publicKey - Chiave pubblica dell'utente che ha inviato la richiesta.
+ * @param [callback] - Funzione di callback opzionale.
+ */
+declare function acceptFriendRequest(params: {
+    key: string;
+    publicKey: string;
+}, callback?: (...params: any[]) => any): void;
+
+/**
+ * Invia una richiesta di amicizia a un utente specifico.
+ * @param publicKey - La chiave pubblica dell'utente a cui inviare la richiesta di amicizia.
+ * @param [callback] - Funzione di callback opzionale chiamata al completamento dell'operazione.
+ */
+declare function addFriendRequest(publicKey: string, callback?: (...params: any[]) => any): Promise<void>;
+
+/**
+ * Questo Observable emette oggetti contenenti informazioni sulle richieste di amicizia.
+Ogni oggetto emesso può avere le seguenti proprietà:
+- key: La chiave della richiesta di amicizia
+- pub: La chiave pubblica dell'utente che ha inviato la richiesta
+- alias: L'alias dell'utente che ha inviato la richiesta
+- displayName: Il nome visualizzato dell'utente (se disponibile)
+- about: Informazioni aggiuntive sull'utente (se disponibili)
+
+Se non ci sono richieste di amicizia, l'Observable emetterà `undefined`.
+ */
+declare var friendRequests: Observable;
+
+/**
+ * Modulo per la gestione della lista degli amici.
+ */
+declare module "friendsList" {
+    /**
+     * Questo Observable emette oggetti contenenti informazioni sugli amici dell'utente.
+    Ogni oggetto emesso può avere le seguenti proprietà:
+    - key: La chiave dell'amico
+    - pub: La chiave pubblica dell'amico
+    - alias: L'alias dell'amico
+    - displayName: Il nome visualizzato dell'amico (se disponibile)
+    - about: Informazioni aggiuntive sull'amico (se disponibili)
+    
+    Se non ci sono amici nella lista, l'Observable emetterà `undefined`.
+     */
+    var friendsList: Observable;
+}
+
+/**
+ * Modulo per la gestione delle amicizie
+ */
+declare module "friends" {
+    /**
+     * Aggiunge una richiesta di amicizia
+     */
+    var addFriendRequest: any;
+    /**
+     * Accetta una richiesta di amicizia
+     */
+    var acceptFriendRequest: any;
+    /**
+     * Rifiuta una richiesta di amicizia
+     */
+    var rejectFriendRequest: any;
+    /**
+     * Ottiene l'elenco delle richieste di amicizia
+     */
+    var friendRequests: any;
+    /**
+     * Ottiene l'elenco degli amici
+     */
+    var friendsList: any;
+}
+
+/**
+ * Rifiuta una richiesta di amicizia.
+ * @param key - La chiave della richiesta di amicizia da rifiutare.
+ * @param [callback] - Funzione di callback opzionale chiamata al completamento dell'operazione.
+ */
+declare function rejectFriendRequest(key: string, callback?: (...params: any[]) => any): void;
+
+/**
+ * Questo Observable si sottoscrive ai cambiamenti nella lista delle chat dell'utente
+e emette un nuovo oggetto per ogni chat aggiornata. Ogni oggetto chat contiene:
+- roomId: l'identificatore univoco della stanza di chat
+- pub: la chiave pubblica associata alla chat
+- latestMessage: l'ultimo messaggio nella chat
+ * @example
+ * chatsList.subscribe(chat => {
+  console.log('Chat aggiornata:', chat);
+});
+ */
+declare var chatsList: Observable;
+
+/**
+ * Modulo per la creazione di una nuova chat.
+ */
+declare module "createChat" {
+    /**
+     * Questa funzione crea una nuova chat tra l'utente corrente e un altro utente specificato dalla sua chiave pubblica.
+    Verifica prima se la chat esiste già, poi controlla i certificati necessari e infine crea la chat per entrambi gli utenti.
+     * @example
+     * createChat("chiavePubblicaUtente", (result) => {
+      if (result.success) {
+        console.log("Chat creata:", result.chat);
+      } else {
+        console.error("Errore:", result.errMessage);
+      }
+    });
+     * @param publicKey - La chiave pubblica dell'utente con cui creare la chat.
+     * @param [callback] - Funzione di callback opzionale chiamata al completamento dell'operazione.
+     */
+    function createChat(publicKey: string, callback?: (...params: any[]) => any): Promise<void>;
+}
+
+/**
+ * Modulo per la gestione dei messaggi e delle chat
+ */
+declare module "messaging" {
+    /**
+     * Crea una nuova chat
+     */
+    var createChat: any;
+    /**
+     * Ottiene la lista delle chat
+     */
+    var chatsList: any;
+    /**
+     * Ottiene la lista dei messaggi di una chat
+     */
+    var messageList: any;
+    /**
+     * Invia un messaggio di testo
+     */
+    var sendMessage: any;
+    /**
+     * Invia un messaggio vocale
+     */
+    var sendVoiceMessage: any;
+}
+
+/**
+ * Questa funzione crea un Observable che si sottoscrive ai messaggi di una specifica chat.
+Decripta i messaggi utilizzando la chiave pubblica dell'altro utente e emette sia un array iniziale
+di messaggi che singoli messaggi man mano che vengono ricevuti.
+ * @example
+ * const messages$ = messageList('room123', 'publicKey123');
+messages$.subscribe(({ initial, individual }) => {
+  if (initial) {
+    console.log('Messaggi iniziali:', initial);
+  } else if (individual) {
+    console.log('Nuovo messaggio:', individual);
+  }
+});
+ * @param roomId - L'identificatore univoco della stanza di chat.
+ * @param pub - La chiave pubblica dell'altro utente nella chat.
+ * @returns Un Observable che emette oggetti contenenti messaggi iniziali e individuali.
+ */
+declare function messageList(roomId: string, pub: string): Observable;
+
+/**
+ * Modulo per l'inizializzazione e la configurazione di Gun.js
+ */
+declare module "gun" {
+    /**
+     * Inizializza un'istanza di Gun con configurazioni specifiche
+     */
+    var gun: Gun;
+    /**
+     * Inizializza un utente Gun e richiama la sessione da sessionStorage
+     */
+    var user: GunUser;
+}
+

package/TUTORIAL.md

@@ -1,103 +0,0 @@
-# Tutorial: Illuminating Your Data with SHINE in GunDB 🌟
-
-Hey there, GunDB aficionado! Ready to take your decentralized data game to the next level? Enter SHINE: your ticket to blockchain-verified data integrity. It's not just about storing data anymore; it's about making it cryptographically awesome!
-
-## Step 0: Wallet Integration - Your Blockchain Passport
-
-Before we dive into the SHINE pool, remember: this plugin requires a browser-based wallet provider. Think of it as your blockchain passport. Here's how to check if you're ready to roll:
-
-```javascript
-async function connectWallet() {
-  if (typeof window.ethereum !== "undefined") {
-    console.log("Ethereum object detected");
-    try {
-      await window.ethereum.request({ method: "eth_requestAccounts" });
-      console.log("Wallet connected successfully");
-      return true;
-    } catch (error) {
-      console.error("Wallet connection denied:", error);
-      return false;
-    }
-  } else {
-    console.log(
-      "Please install MetaMask or another Ethereum-compatible wallet"
-    );
-    return false;
-  }
-}
-
-// Make sure to call this before using SHINE
-await connectWallet();
-```
-
-Pro tip: Always ensure your wallet is connected before invoking SHINE functions. No wallet, no blockchain magic!
-
-## Step 1: Installation - Equipping Your Toolbelt
-
-Let's add SHINE to your development arsenal:
-
-```bash
-npm install gun-eth
-```
-
-If your terminal responds without errors, you're locked and loaded!
-
-## Step 2: Import - Assembling the Pieces
-
-Time to bring Gun and SHINE into your JavaScript playground:
-
-```javascript
-import Gun from "gun";
-import "gun-eth";
-const gun = Gun();
-```
-
-## Step 3: SHINE in Action - Blockchain Meets Database
-
-Let's say you've got some mission-critical data to store. Here's how you'd use SHINE to give it that blockchain-grade integrity:
-
-```javascript
-const criticalData = {
-  key1: "Encrypted message",
-  key2: "Top secret algorithm",
-  key3: "42",
-};
-
-gun.shine("optimismSepolia", null, criticalData, (ack) => {
-  if (ack.ok) {
-    console.log("Data successfully anchored to the blockchain");
-    console.log("Node ID for future reference:", ack.nodeId);
-  } else {
-    console.error("Blockchain anchoring failed:", ack.err);
-  }
-});
-```
-
-Remember, your wallet needs to be ready to sign this transaction. It's like pushing code without commit access - it just won't fly!
-
-## Step 4: Verification - Trust the Crypto, Not the Hearsay
-
-When it's time to verify your data's integrity:
-
-```javascript
-const nodeId = "your-data-node-id";
-gun.shine("optimismSepolia", nodeId, null, (ack) => {
-  if (ack.ok) {
-    console.log("Data integrity verified on the blockchain");
-    console.log("Timestamp:", ack.timestamp);
-    console.log("Last updater:", ack.updater);
-  } else {
-    console.error("Integrity check failed:", ack.err);
-  }
-});
-```
-
-Again, wallet connection is crucial. No blockchain access, no verification!
-
-## Step 5: Reap the Benefits
-
-Congratulations! You've just leveled up your data management game. Your data is now cryptographically verifiable, tamper-evident, and blockchain-secured.
-
-Remember: With SHINE, you're not just storing data; you're creating a cryptographic proof of its existence and integrity. Use this power wisely!
-
-P.S. SHINE responsibly. With great cryptographic power comes great responsibility. Happy coding, and may your data always maintain its integrity! 🚀🔐

package/src/examples/eth2gun.html

@@ -1,163 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>💎 Ethereum to 🔫 Gun Key Pair Demo</title>
-    <!-- Include Gun -->
-    <script src="https://cdn.jsdelivr.net/npm/gun/gun.js"></script>
-    <!-- Include SEA (part of Gun) -->
-    <script src="https://cdn.jsdelivr.net/npm/gun/sea.js"></script>
-    <!-- Include Ethers.js -->
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/ethers/6.7.0/ethers.umd.min.js"></script>
-    <!-- Include the Gun-Eth plugin -->
-    <script src="https://cdn.jsdelivr.net/npm/gun-eth/src/gun-eth.js""></script>
-    <style>
-        body {
-          font-family: Arial, sans-serif;
-          margin: 0;
-          padding: 20px;
-          background-color: #f0f0f0;
-        }
-        .container {
-          max-width: 400px;
-          background-color: white;
-          border: 1px solid #000;
-          padding: 10px;
-        }
-        h1,
-        h2 {
-          margin: 0 0 10px 0;
-          font-size: 16px;
-        }
-        form, div {
-          margin-bottom: 15px;
-        }
-        input,
-        button {
-          display: inline-block;
-          margin: 2px 0;
-          padding: 2px;
-          font-size: 12px;
-        }
-        input {
-          width: 150px;
-        }
-        button {
-          width: 100px;
-        }
-        label {
-          display: inline-block;
-          width: 70px;
-          font-size: 12px;
-        }
-        #configStatus,
-        .result {
-          font-weight: bold;
-          margin-bottom: 10px;
-        }
-        .result {
-          color: blue;
-        }
-    </style>
-</head>
-<body>
-    <div class="container">
-        <h1>💎 Ethereum to 🔫 Gun Key Pair Demo</h1>
-        
-        <form id="configForm">
-            <h2>🔧 Configuration</h2>
-            <label for="rpcUrl">🌐 RPC URL:</label>
-            <br>
-            <input type="text" id="rpcUrl" name="rpcUrl" required>
-            <br>
-            <label for="privateKey">🔑 Private Key:</label>
-            <br>
-            <input type="password" id="privateKey" name="privateKey" required>
-            <br>
-            <button type="submit">⚙️ Configure</button>
-        </form>
-
-        <div id="createPairSection">
-            <h2>🔒 Create and Store Encrypted Pair</h2>
-            <button id="createPairBtn">🔐 Create Pair</button>
-        </div>
-
-        <div id="retrievePairSection">
-            <h2>🔓 Retrieve and Decrypt Pair</h2>
-            <button id="retrievePairBtn">🔎 Retrieve Pair</button>
-        </div>
-
-        <div id="resultSection">
-            <h2>📊 Result</h2>
-            <p id="resultText"></p>
-        </div>
-    </div>
-
-    <script>
-        let gun;
-        const MESSAGE_TO_SIGN = "GunDB access with Ethereum";
-
-        document.getElementById('configForm').addEventListener('submit', function(event) {
-            event.preventDefault();
-            const rpcUrl = document.getElementById('rpcUrl').value;
-            const privateKey = document.getElementById('privateKey').value;
-
-            gun = Gun();
-            gun.setStandaloneConfig(rpcUrl, privateKey);
-
-            console.log('Standalone configuration set');
-            document.getElementById('resultText').innerText = '✅ Configuration set successfully';
-        });
-
-        document.getElementById('createPairBtn').addEventListener('click', async function() {
-            if (!gun) {
-                alert('⚠️ Please configure Gun first');
-                return;
-            }
-
-            try {
-                const signature = await gun.createSignature(MESSAGE_TO_SIGN);
-                if (!signature) {
-                    throw new Error('Failed to create signature');
-                }
-
-                const signer = new ethers.Wallet(document.getElementById('privateKey').value);
-                const address = await signer.getAddress();
-
-                await gun.createAndStoreEncryptedPair(address, signature);
-                
-                document.getElementById('resultText').innerText = '✅ Encrypted pair created and stored successfully';
-            } catch (error) {
-                document.getElementById('resultText').innerText = '❌ Error: ' + error.message;
-            }
-        });
-
-        document.getElementById('retrievePairBtn').addEventListener('click', async function() {
-            if (!gun) {
-                alert('⚠️ Please configure Gun first');
-                return;
-            }
-
-            try {
-                const signature = await gun.createSignature(MESSAGE_TO_SIGN);
-                if (!signature) {
-                    throw new Error('Failed to create signature');
-                }
-
-                const signer = new ethers.Wallet(document.getElementById('privateKey').value);
-                const address = await signer.getAddress();
-
-                const pair = await gun.getAndDecryptPair(address, signature);
-                
-                document.getElementById('resultText').innerHTML = `
-                    <strong>🔑 Retrieved pair:</strong> 
-                    <br>
-                    ${JSON.stringify(pair, null, 2)}
-                `;
-            } catch (error) {
-                document.getElementById('resultText').innerText = '❌ Error: ' + error.message;
-            }
-        });
-    </script>
-</body>
-</html>

package/src/examples/gun2eth.html

@@ -1,164 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Gun to Ethereum Address Demo</title>
-    <!-- Include Gun -->
-    <script src="https://cdn.jsdelivr.net/npm/gun/gun.js"></script>
-    <!-- Include SEA (part of Gun) -->
-    <script src="https://cdn.jsdelivr.net/npm/gun/sea.js"></script>
-    <!-- Include Ethers.js -->
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/ethers/6.7.0/ethers.umd.min.js"></script>
-    <!-- Include the Gun-Eth plugin -->
-    <script src="https://cdn.jsdelivr.net/npm/gun-eth/src/gun-eth.js""></script>
-    <style>
-        body {
-          font-family: Arial, sans-serif;
-          margin: 0;
-          padding: 20px;
-          background-color: #f0f0f0;
-        }
-        .container {
-          max-width: 400px;
-          background-color: white;
-          border: 1px solid #000;
-          padding: 10px;
-        }
-        h1,
-        h2 {
-          margin: 0 0 10px 0;
-          font-size: 16px;
-        }
-        form {
-          margin-bottom: 15px;
-        }
-        input,
-        button {
-          display: inline-block;
-          margin: 2px 0;
-          padding: 2px;
-          font-size: 12px;
-        }
-        input {
-          width: 150px;
-        }
-        button {
-          width: 100px;
-        }
-        label {
-          display: inline-block;
-          width: 70px;
-          font-size: 12px;
-        }
-        #configStatus,
-        .result {
-          font-weight: bold;
-          margin-bottom: 10px;
-        }
-        .result {
-          color: blue;
-        }
-        .disclaimer {
-          background-color: #ffffd0;
-          border: 1px solid #e6e600;
-          padding: 10px;
-          margin-bottom: 15px;
-          font-size: 14px;
-        }
-      </style>
-</head>
-<body>
-    <div class="container">
-        <h1>🔫 Gun to 💎 Ethereum Address Demo</h1>
-        
-        <form id="gunUserForm">
-            <h2>👤 User Login/Registration</h2>
-            <label for="gunAlias">👤 Alias:</label>
-            <br>
-            <input type="text" id="gunAlias" name="gunAlias" required>
-            <br>
-            <label for="gunPassword">🔑 Password:</label>
-            <br>
-            <input type="password" id="gunPassword" name="gunPassword" required>
-            <br>
-            <button type="submit">🚀 Create/Login</button>
-        </form>
-
-        <div id="conversionSection" style="display:none;">
-            <h2>🔄 Convert Gun User to Ethereum Address</h2>
-            <button id="convertBtn">🔄 Convert
-        </div>
-
-        <div id="resultSection">
-            <h2>Result</h2>
-            <p id="resultText"></p>
-        </div>
-    </div>
-
-    <script>
-        let gun = Gun();
-        let currentUser = null;
-
-        document.getElementById('gunUserForm').addEventListener('submit', function(event) {
-            event.preventDefault();
-            const alias = document.getElementById('gunAlias').value;
-            const password = document.getElementById('gunPassword').value;
-
-            console.log('Attempting to create or login user:', alias);
-
-            gun.user().create(alias, password, function(ack) {
-                if (ack.err) {
-                    console.log('User creation failed, trying to login:', ack.err);
-                    gun.user().auth(alias, password, function(authAck) {
-                        if (authAck.err) {
-                            document.getElementById('resultText').innerText = 'Error logging in: ' + authAck.err;
-                        } else {
-                            currentUser = gun.user();
-                            document.getElementById('resultText').innerText = 'User logged in successfully.';
-                            document.getElementById('conversionSection').style.display = 'block';
-                        }
-                    });
-                } else {
-                    console.log('User created successfully:', ack);
-                    currentUser = gun.user();
-                    document.getElementById('resultText').innerText = 'User created and logged in successfully.';
-                    document.getElementById('conversionSection').style.display = 'block';
-                }
-            });
-        });
-
-        document.getElementById('convertBtn').addEventListener('click', function() {
-            if (!currentUser) {
-                alert('Please login first');
-                return;
-            }
-
-            console.log('Current user:', currentUser);
-            console.log('User pair:', currentUser._.sea);
-
-            try {
-                const pair = currentUser._.sea;
-                if (!pair || !pair.priv) {
-                    throw new Error('Unable to retrieve Gun user private key');
-                }
-
-                const ethAccount = gun.gunToEthAccount(pair.priv);
-                
-                document.getElementById('resultText').innerHTML = `
-                    <strong>Gun User</strong> 
-                    <br>
-                    ${currentUser.is.alias}
-                    <br>
-                    <br>
-                    <strong>Ethereum Address:</strong>
-                    <br>
-                    ${ethAccount.publicKey}
-                `;
-            } catch (error) {
-                document.getElementById('resultText').innerText = 'Error: ' + error.message;
-                console.error('Conversion error:', error);
-            }
-        });
-    </script>
-</body>
-</html>