@jeevanmkj/elizaos-plugin-neo4j v0.1.0

Eliza Neo4j Plugin for Giveth

This plugin allows Eliza to query and interact with Giveth projects stored in a Neo4j database through a REST API.

Giveth is a platform that empowers changemakers to accept crypto donations for nonprofit projects and social causes.

Features

• Query Giveth projects using natural language
• Get detailed information about specific projects
• List recent projects
• Secure API communication with authentication

Installation

From Package

----This plugin should be available soon with Eliza.----

Manual Installation

1. Add repository directly into ~/eliza/packages

    pnpm add github:JeevanMKJ/elizaos-plugin-neo4j

   When running this command you might get this error:

   ERR_PNPM_ADDING_TO_ROOT  Running this command will add the dependency to the workspace root, which might not be what you want - if you really meant it, make it explicit by running this command again with the -w flag (or --workspace-root). If you don't want to see this warning anymore, you may set the ignore-workspace-root-check setting to true.

   Run the same command with the -w flag:

   pnpm add github:JeevanMKJ/elizaos-plugin-neo4j -w

2. Install dependencies:

   pnpm install

3. Build the plugin:

   pnpm build

Configuration

To configure the Neo4j plugin for Giveth, you need to:

1. Add the plugin to your character file
2. Set up your Giveth Neo4j access (API key and URL)
3. Obtain a Giveth API key (see section below)

Method 1: Character File Configuration

Add the Neo4j plugin to your character file:

{
  "name": "Your Eliza Character",
  "plugins": ["@elizaos/plugin-neo4j"],
  "settings": {
    "secrets": {
      "neo4j": {
        "apiKey": "YOUR_API_KEY",
        "apiUrl": "https://api.giveth.io/neo4j"
      }
    }
  }
}

Method 2: Environment Variables

You can also configure the plugin using environment variables in a .env file in the root directory of Eliza:

# Neo4j Configuration
NEO4J_API_KEY=your_api_key_here
NEO4J_API_URL=https://api.giveth.io/neo4j

If you don't have a .env file set up yet, you can create one easily by copying the example file:

cp .env.example .env

Then edit the .env file to add your API key and URL.

Obtaining a Giveth API Key

The Giveth Neo4j API is not publicly available through a self-service process. To obtain an API key:

1. Visit the Giveth website
2. Connect with the Giveth team via email info@giveth.io.
3. Explain your use case and request access to the Neo4j API
4. Once approved, you'll receive an API key to use with this plugin

Usage

This plugin provides the following actions that Eliza can use:

queryNeo4j

Query Giveth projects using natural language.

queryNeo4j("Show me projects related to climate change")

getGivethProjectDetails

Get detailed information about a specific Giveth project.

getGivethProjectDetails("project-123")

getRecentGivethProjects

Get a list of recent Giveth projects.

getRecentGivethProjects(5)

Example Conversations

User: "What projects are working on climate change?" Eliza: Uses queryNeo4j to find and display climate change projects

User: "Tell me more about the first project" Eliza: Uses getGivethProjectDetails to show detailed information

User: "What are the newest projects on Giveth?" Eliza: Uses getRecentGivethProjects to list recent projects

Development

Project Structure

• /src/actions - Actions for Eliza to query Neo4j
• /src/providers - API communication with the Neo4j server
• /src/types.ts - TypeScript type definitions
• /src/environment.ts - Configuration management
• /src/index.ts - Plugin entry point