M3tering Arweave Gateway Interface

This project is a GraphQL interface for interacting with M3tering Protocol meter data. It integrates with Arweave and MongoDB to manage and query meter data efficiently.

Prerequisites

Before setting up the project, ensure you have the following installed:

• Node.js (v16 or later)
• npm (comes with Node.js)
• MongoDB (running instance)
• An Arweave Gateway URL

Setup Instructions

1. Clone the Repository:

   git clone <repository-url>
   cd m3tering-arweave-gateway-interface

2. Install Dependencies: Install the required dependencies using npm:

   npm install

3. Configure Environment Variables: Create a .env file in the root directory by copying the provided .env.example file:

   cp .env.example .env

   Update the .env file with your Arweave Gateway URL and MongoDB URI:

   ARWEAVE_GATEWAY_URL=<your-arweave-gateway-url>
   MONGODB_URI=<your-mongodb-uri>

4. Compile the TypeScript Code: Compile the TypeScript code into JavaScript:

   npm run compile

5. Run the Application: Start the application:

   npm start

   Alternatively, for development with hot-reloading:

   npm run dev

6. Access the GraphQL Interface: Once the application is running, you can access the GraphQL interface at:

   http://localhost:4001/graphql
   

Project Structure

• src/: Contains the source code, including utilities and constants.
• .env: Environment variables for configuration.
• package.json: Project metadata and scripts.

Key Environment Variables

• ARWEAVE_GATEWAY_URL: The URL of the Arweave gateway to interact with.
• MONGODB_URI: The connection string for your MongoDB instance.

Scripts

• npm run compile: Compiles the TypeScript code.
• npm start: Starts the application.
• npm run dev: Starts the application in development mode with hot-reloading.

Dependencies

• @apollo/server: For setting up the GraphQL server.
• mongoose: For interacting with MongoDB.
• warp-contracts: For interacting with Arweave contracts.

License

This project is licensed under the ISC License.