@akord/akord-explorer-api

Akord Explorer API

A decentralized implementation of Akord API to read Akord content directly from the permaweb.

Usage

yarn add @akord/akord-explorer-api

Read your personal content

import { Akord } from "@akord/akord-js";
import { AkordWallet } from "@akord/crypto";
import { ExplorerApi } from "@akord/akord-explorer-api";

const wallet = await AkordWallet.importFromBackupPhrase("your backup phrase here");
const explorerApi = new ExplorerApi({ address: await wallet.getAddress() });
const akord = await Akord.init(wallet, { api: explorerApi });
const vaults = await akord.vault.listAll();

Search through all Akord public content

import { Stack } from "@akord/akord-js";
import { ExplorerApi } from "@akord/akord-explorer-api";

const explorerApi = new ExplorerApi();
// list all public vaults with at least one word/tag within the given list
const vaults = explorerApi.listAllPublicVaults({
  tags: {
    values: ["Health Seychelles Morning dynamic"],
    searchCriteria: "CONTAINS_SOME"
  }
});
// list all Akord public folders
const folders = await explorerApi.listAllPublicNodes<Folder>("Folder");

Development

yarn install
yarn build

To run all tests:

yarn test

To run single test file:

yarn test <path-to-test-file>

yarn test ./src/__tests__/personal-content.test.ts

To run single test file with direct log output:

node --inspect node_modules/.bin/jest <path-to-test-file>

node --inspect node_modules/.bin/jest ./src/__tests__/public-search.test.ts