npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eos-detective

v0.7.1

Published

EOS Detective

Downloads

18

Readme

EOS Detective

EOS Detective Javascript Library https://docs.eosdetective.io API on EOS networks.

Install

Using Yarn:

yarn add eos-detective

or using NPM:

npm install --save eos-detective

Import Module

CommonJS

const detective = require("eos-detective");

Typescript (ES6)

import * as detective from "eos-detective";

Babel (ES6)

import detective from "eos-detective";

Quick Start

const token = "<API TOKEN>";

detective.config(token);
detective.profile("eosnationftw").then((response) => console.log(response.data));
/**
 * {
 *   account: 'eosnationftw',
 *   contract: 'eosio.token',
 *   token: 'EOS',
 *   total_tokens_received: 74747.4845,
 *   score: 87.3,
 *   categories: {
 *     system: {
 *       percentage: 0.9994754378657384,
 *       volume: 74708.2748,
 *       count: 205
 *     }
 *   }
 * }
 */

Profile Score & Category Rating

Google Drive

Advance Configuration

These configurations are required to push detective reports on-chain.

Saving your configuraitons in a .env file will prevent your sensitive data from being exposed in your javascript source code.

.env

# EOS Detective API
DETECTIVE_TOKEN="<API TOKEN>"
DETECTIVE_ENDPOINT="https://graph-api.eosdetective.io/v0/"
DETECTIVE_CONTRACT="eosdetective"

# Publish EOS Detective Reports
ENDPOINT_EOSIO="https://jungle.eosn.io"
PRIVATE_KEY="<EOSIO PRIVATE KEY>"
ACTOR="<EOSIO ACCOUNT>"
PERMISSION="active"

Load your .env filepath by using the config() method.

detective.config(".env")

Publish Reports

Advanced configurations is required before attempting the following steps.

Once a profile is retrieved, it can be published to the EOS Detective smart contract.

// Get Profile
detective.profile("eosnationftw").then(response => {
    const profile = response.data;

    // Post report on chain with scores greater than 70
    if (profile && profile.score >= 70) {
        detective.reports.post(profile).then((trx_id) => {
            console.log("posted report", trx_id);
        });
    }
})

Remove Reports

Use .remove(<account>) to remove an existing published report.

detective.reports.remove("eosnationftw").then((trx_id) => {
    console.log("removed report", trx_id);
});

Get Report

Fetches a single the report of a single account from the contract table data.

detective.reports.get("altcoinomysa").then(data => {
    console.log(data)
})