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

@peeramid-labs/sdk

v2.0.3

Published

Peeramid Labs js client library

Downloads

288

Readme

SDK

This is SDK for use with Rankify game. You can ease interaction with smart contracts.

Prerequisites

Before setting up the local development environment, ensure you have the following installed:

  1. Node.js and pnpm

    # Using homebrew
    brew install node
    npm install -g pnpm
  2. Foundry (for Anvil)

    curl -L https://foundry.paradigm.xyz | bash
    foundryup
  3. tmux

    # Using homebrew
    brew install tmux

Local Development Setup

To set up your local development environment:

  1. Create your environment file:

    cp .env.example .env

    Then edit .env to set your local repository paths.

  2. Set the required environment variables:

    export RANKIFY_CONTRACTS_PATH="/path/to/rankify/contracts"
    export EDS_PATH="/path/to/eds"
    export MULTIPASS_PATH="/path/to/multipass"
  3. Make the setup script executable:

    chmod +x scripts/setup-local-dev.sh
  4. Run the setup script:

    source .env && ./scripts/setup-local-dev.sh

This will:

  • Start a local Anvil development network in a tmux session (or use existing one if running)
  • Install dependencies for all repositories
  • Run local deployment scripts (playbook/utils/deploy-to-local-anvil.sh) in each repository
  • Set up local pnpm links between packages

The script uses a fixed mnemonic for consistent addresses across runs.

Managing Anvil

  • View Anvil logs: tmux attach -t anvil
  • Detach from logs: Press Ctrl+B then D
  • Stop Anvil: tmux kill-session -t anvil

Documentation

The SDK comes with comprehensive API documentation generated using TypeDoc. The documentation is automatically generated during the package build process and is included in the npm package.

Generating Documentation

To generate the documentation locally:

pnpm run docs

This will create a docs directory with the generated documentation.

For development, you can use the watch mode:

pnpm run docs:watch

Accessing Documentation

  • Local Development: Open docs/index.html in your browser after generating the documentation
  • Published Package: Documentation is available through the npm package page