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

leaderboard-ts-sdk

v0.0.6

Published

SDK to interact with leaderboards smart contract

Downloads

147

Readme

NPC Labs is a core contributor to B3 - the gaming ecosystem L3 Onchain Leaderboards with B3

Overview

The On-Chain Leaderboard Smart Contract allows game developers to integrate on-chain leaderboards for tracking and displaying player scores securely on the blockchain. The leaderboard is managed by game admins, who can create, set, update, increment, and decrement player scores using player wallet addresses. Additionally, a TypeScript SDK will be provided to facilitate interaction with the contract.

  • Purpose: Provide an on-chain solution for managing game leaderboards where scores are stored and updated transparently and securely.
  • Primary User: Game admins (authorized by the contract).
  • Secondary User: Players whose scores are tracked.

Typescript SDK

  • Fetch Leaderboard Data: Allow easy retrieval of leaderboard standings and individual player scores from the contract.
  • Update Scores: Provide functionality for admins to interact with the contract methods for setting, updating, incrementing, or decrementing scores.

Example Methods in the SDK:

  • createLeaderboard(label: string): Promise
  • setScore(label: string, player: string, score: number): Promise
  • updateScore(label: string, player: string, score: number): Promise
  • incrementScore(label: string, player: string, increment: number): Promise
  • decrementScore(label: string, player: string, decrement: number): Promise
  • getLeaderboard(label: string): Promise
  • getScore(label: string, player: string): Promise
  • getPlayerCount(label: string): Promise<number | undefined> // New method
  • getLeaderboardSize(label: string): Promise<number | undefined> // New method
  • getTopPercentage(label: string, percentage: number): Promise<[string[], number[]]> // New method
  • getLeaderboardStartTime(label: string): Promise<number | undefined> // New method
  • getLeaderboardEndTime(label: string): Promise<number | undefined> // New method
  • isLeaderboardActive(label: string): Promise // New method