Skip to content

rahulsainlll/ar-indexer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@arindexer — Arweave Indexer

Overview

Arweave Indexer (arindexer) is a lightweight indexing and query utility for the Arweave network. It enables developers to efficiently index, discover, and retrieve structured data for decentralized applications built on Arweave and the AO ecosystem.

Features

  • Fast querying of indexed data
  • Simple API for indexing structured content
  • Native support for Arweave and AO ecosystem
  • Fully typed TypeScript interface
  • Integration-ready for ARLINK deployments

Installation

npm install arweave-indexer

Usage

Query Data

import { query } from "arweave-indexer";

async function search() {
  const results = await query("web3");
  console.log(results);
}

Index Data

import { index } from "arweave-indexer";

async function indexProject() {
  const result = await index(
    JSON.stringify({
      title: "My Web3 Project",
      description: "A decentralized application"
    }),
    window.arweaveWallet
  );

  console.log(result);
}

Advanced Querying

const results = await query("web3", {
  process: "custom-process-id",
  tags: [
    { name: "Category", value: "Blockchain" }
  ]
});

API Reference

query(searchTerm: string, options?: IndexerOptions)

Queries indexed data on the AO network.

Returns an array of results or null.

index(data: string, wallet: any, options?: IndexerOptions)

Indexes structured data into the AO network.

Returns the message result or null.

Types

interface Project {
  title: string;
  link: string;
  description: string;
  twitter?: string;
}

interface IndexerOptions {
  process?: string;
  tags?: { name: string; value: string }[];
}

Ecosystem

Package Information

  • Version: 1.1.0
  • Weekly Downloads: 100+
  • License: MIT

About

Lightweight indexing and query utility for Arweave, designed for building and retrieving structured data in decentralized applications.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors