https://github.com/decentldotland/weave-aggregator

an aggregator for the Permaweb's feeds
https://github.com/decentldotland/weave-aggregator

Last synced: 3 days ago
JSON representation

an aggregator for the Permaweb's feeds

• Host: GitHub
• URL: https://github.com/decentldotland/weave-aggregator
• Owner: decentldotland
• License: mit
• Created: 2021-11-20T20:54:25.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-13T12:21:00.000Z (almost 2 years ago)
• Last Synced: 2024-08-09T15:29:32.636Z (3 months ago)
• Language: JavaScript
• Size: 173 KB
• Stars: 18
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  
@decentdotland/weave-aggregator


## Synopsis

The weave-aggregator 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   | API ID | 

| :-----------: |:-------------:| :-------------: |

| [ArweaveSaves](https://arconnect)  | [arweave-saves](./src/arweave-saves)| `arweave-saves` |

| [Koii Network](https://koi.rocks)             | [koii](./src/koii)        | `koii` |

| [ardrive.io](https://ardrive.io)             |[ardrive](./src/ardrive)     | `ardrive` |

| [permacast.net](https://permacast.net)             | [permacast](./src/permacast)    | `permacast` |

| [mirror.xyz](https://mirror.xyz)             | [mirror-xyz](./src/mirror-xyz)| `mirror-xyz` |

| [Pianity](https://pianity.com)             | [pianity](./src/pianity)| `pianity` |

| [Lens Protocol](https://lens.dev) | [lens-protocol](./src/lens-protocol) | `lens` |

| [Art By City](https://artby.city) | [art-by-city](./src/art-by-city) | `art-by-city` |

| [ANS](https://ar.page) | [safe-cache-api](./src/ans) | `ans-cache` |

| [Metaweave Permatweets](https://metaweave.xyz) | [metaweave-xyz](./src/metaweave-xyz) | `metaweave-permatweets` |

| [PermaPages IMG](https://img.arweave.dev/) | [permapages/img](./src/permapages/img) | `permapages-img` |

| [PermaPages Stamps](https://permapages.app/) | [permapages/stamps](./src/permapages/stamps) | `permapages-stamps` |

| [ArNS](https://ar.io/arns/) | [arns](./src/arns) | `arns` |

## Usage Example

### get permacast podcasts

```js

import { getWeaveAggregator } from "weave-aggregator";

async function podcasts() {

  const podcastsMetadata = await getWeaveAggregator("permacast");

  return podcastsMetadata;

}

```

### get Koii collectibles

```js

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.

### get Stamps

``` js

import { getWeaveAggregator } from "weave-aggregator";

const address = "...";

async function stamps(address) {

  const stamps = await getWeaveAggregator("permapages-stamps", address);

  return stamps;

}

console.log(await stamps(address))

```

> For ReactJS usage:

>

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

# License

This projects is licensed under the [MIT license](./LICENSE)