martonlederer / weave-aggregator

an aggregator for the Permaweb's feeds

@decentdotland/weave-aggregator

🐊 the alligator of the permaweb 🐊

Synopsis

The weave-alligator library aggregates data and feeds from the Permaweb, and make the access for it easier. The weave-aggregator aggregates especially public feeds from protocols that use Arweave as a storage solution.

The library will be under continious development mode to keep on track with the new & currently unsupported protocols that use Arweave. By aggregating data from different protocols, the weave-aggregator allows developers to create a frontend for the "timeline of the Permaweb".

Install

npm install weave-aggregator

Current Supported Protocols

protocol name	directory
ArweaveSaves	arweave-saves
Koii Network	koii
ardrive.io	ardrive
permacast.net	permacast
argora.xyz	argora-xyz
mirror.xyz	mirror-xyz
Pianity	pianity
Lens Protocol	lens-protocol

Usage Example

get permacast podcasts

import { getWeaveAggregator } from "weave-aggregator";

async function podcasts() {
  const podcastsMetadata = await getWeaveAggregator("permacast");

  return podcastsMetadata;
}

get Koii collectibles

import { getWeaveAggregator } from "weave-aggregator";

const address = "...";

async function nftsOf(address) {
  const collectibles = await getWeaveAggregator("koii", address);

  return collectibles;

omiting the address parameter returns the recent feed of the requested network. The networks that support per address filtering are: ArweaveSaves, Koii, and Ardrive.

For ReactJS usage:

Modifying utils/arweave/arweave.js no longer required for ReactJS.

License

This projects is licensed under the MIT license