Mogu Project Documentation

Mogu is a TypeScript-based project that integrates GunDB with IPFS to provide a decentralized and efficient data storage solution. It includes features for real-time updates, backups, and restores via Web3Stash and IPFS.

Table of Contents

• Introduction
• Features
• Installation
• Usage
  • Server Configuration
  • Mogu SDK
  • IPFS Adapter
  • Web3Stash
  • Backup and Restore
• Testing
• File Structure
• License

Introduction

Mogu provides developers with tools to build decentralized and efficient applications using GunDB for data synchronization and IPFS for storage. It supports features like data backup, restore, and real-time updates, making it ideal for decentralized applications (dApps).

Features

• Real-time data synchronization using GunDB
• Data backup and restore using IPFS and Web3Stash
• Supports both local and IPFS-based storage
• Modular design for easy integration with other services
• Backup comparison functionality
• Support for basic CRUD operations
• Reliable backup and restore system
• Support for multiple storage providers (Pinata, Web3.Storage, NFT.Storage)
• Automatic cryptographic key management
• Integrated caching system
• Support for structured and unstructured data

Installation

To set up the project locally, follow these steps:

1. Install the package via npm:

   npm install @scobru/mogu

2. Create a .env file in the root directory with the following variables:

   PINATA_API_KEY=<your-pinata-api-key>
   PINATA_API_SECRET=<your-pinata-api-secret>
   PINATA_GATEWAY=<your-pinata-gateway>
   DB_NAME=<your-db-name>
   PRIVATE_KEY=<your-private-key>
   PROVIDER_URL=<your-provider-url>
   STORAGE=true

3. Import and initialize Mogu in your project:

   import { Mogu } from '@scobru/mogu';
      
   const mogu = new Mogu({
     dbName: process.env.DB_NAME,
     storage: process.env.STORAGE === 'true',
     privateKey: process.env.PRIVATE_KEY,
     providerUrl: process.env.PROVIDER_URL
   });

Usage

Mogu SDK

The Mogu SDK provides a comprehensive set of features to interact with the system. Here's the detailed documentation:

Initialization

import { Mogu } from '@scobru/mogu';

const options = {
  key: "optional-key",
  storageService: "pinata", // or other supported services
  storageConfig: {
    // storage service configuration
  },
  server: {}, // optional GunDB server configuration
  useIPFS: true // enable IPFS usage
};

const mogu = new Mogu(options);

Core Methods

getGunInstance()

Returns the GunDB instance.

const gunInstance = mogu.getGunInstance();

get(key: string)

Retrieves data from the specified key.

const data = await mogu.get("myKey");

put(key: string, data: any)

Puts data at the specified key.

await mogu.put("myKey", { data: "value" });

on(key: string, callback: (data: any) => void)

Subscribes to updates on a specific key.

mogu.on("myKey", (data) => {
  console.log("Updated data:", data);
});

Backup Management

backup()

Performs data backup.

const hash = await mogu.backup();
console.log("Backup hash:", hash);

restore(hash: string)

Restores data from a backup.

const success = await mogu.restore("backupHash");

removeBackup(hash: string)

Removes a specific backup.

await mogu.removeBackup("backupHash");

compareBackup(hash: string)

Compares a backup with local data.

const comparison = await mogu.compareBackup("backupHash");
console.log("Comparison results:", comparison);

Interfaces

interface MoguOptions {
  key?: string;
  storageService?: Web3StashServices;
  storageConfig?: Web3StashConfig;
  server?: any;
  useIPFS?: boolean;
}

interface BackupFileData {
  fileName: string;
  content: string | object;
}

Error Handling

The SDK includes comprehensive error handling. All methods that might fail throw errors that should be handled with try/catch:

try {
  await mogu.backup();
} catch (error) {
  console.error("Backup error:", error);
}

Advanced Usage Examples

Real-Time Synchronization

// Sync configuration
const mogu = new Mogu({ useIPFS: true });

// Subscribe to updates
mogu.on("documents", (data) => {
  console.log("Documents updated:", data);
});

// Update data
await mogu.put("documents", { new: "content" });

Automatic Backup Management

const mogu = new Mogu({
  storageService: "pinata",
  storageConfig: {
    apiKey: process.env.PINATA_API_KEY,
    apiSecret: process.env.PINATA_API_SECRET
  }
});

// Periodic backup
setInterval(async () => {
  try {
    const hash = await mogu.backup();
    console.log("Automatic backup completed:", hash);
  } catch (error) {
    console.error("Automatic backup error:", error);
  }
}, 3600000); // every hour

Testing

The project includes unit and integration tests to ensure code robustness and stability.

File Structure

The project is structured in a modular way, with each component separated and well-defined.

License

Mogu is released under the MIT license.