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

@kodadot1/uniquery

v0.7.2-rc.0

Published

Universal GraphQL query builder for KodaDot

Downloads

425

Readme

@kodadot1/uniquery


Universal GraphQL query builder for KodaDot

npm version npm downloads Github Actions

GraphQL builder for KodaDot API

image

Usage

Add Uniquery to your project

# with npm
npm install @kodadot1/uniquery

# with yarn
yarn add @kodadot1/uniquery

# with pnpm
pnpm install @kodadot1/uniquery

Import:

// ESM
import { getClient } from '@kodadot1/uniquery'

// CommonJS
const  { getClient } = require('@kodadot1/uniquery')
const client = getClient()
const query = client.collectionListByIssuer('vikiival')

console.log(query)
{
  query: 'query  { collections: collectionEntities(filter: { issuer: { equalTo: vikiival } })  { nodes { id, metadata, currentOwner, issuer } } }',
  variables: {}
}

✨ Rationale

As we were onboarding developers for our NFT Gallery, most of the developers have seen GraphQL for the first. We wanted to make it easier for them to get started with KodaDot API. Uniquery is a simple tool to help you build GraphQL queries for KodaDot API.

Without Uniquery you would have to write something like this:

query itemListByCollectionIdList {
  nft: nftEntities(where: {collection: { id_eq: "2305670031" }}) {
    id
    metadata
    currentOwner
    issuer
  }
}

With Uniquery you can write this:

const id = '2305670031'
const client = getClient()
const query = client.itemListByCollectionId(id)

To be aware every client function returns GraphQuery object

This GraphQuery object represents a GraphQL query that should be passed to your preffered fetch library (fetch, axios, ohmyfetch)

Note: Uniquery is not a GraphQL client. It's a tool to help you build GraphQL queries It's possible to use it with any GraphQL client (such as Apollo)

We have currently two implementations

    1. Client
import { getClient } from '@kodadot1/uniquery'

const client = getClient('bsx')
const id = '2305670031'
const query = client.collectionById(id)
const result = await client.fetch(query)

⚠️: If you want to use .fetch method on client, you need to pass chain prefix as parameter

    1. REST
import { ask } from '@kodadot1/uniquery'
const id = '2305670031'
const result = await ask(`/bsx/itemByCollection/${id}`)

⚓️ Exported functions

✔️ Uniquery

  • extendFields - extends default list with newly provided values
  • getClient - returns GrahpQL query builder
  • getUrl - returns GrahpQL indexer url
  • SquidClient - returns SquidClient instance

From REST:

  • ask - obtain data from GraphQL indexer by selected route
  • pathToRequest - converts route to corresponding GraphQL query

✔️ Uniquery.client

  • collectionById - returns collection by id
  • collectionListByIssuer - returns collections where issuer (creator) is equal to provided address
  • collectionListByName - returns collections where name contains provided name
  • collectionListByOwner - returns collections where owner is equal to provided address
  • eventList - returns all events
  • eventListByAddress - returns events by address
  • eventListByCollectionId - returns events for nfts that belong to collection
  • eventListByCollectionIdAndInteraction - returns events for nfts that belong to collection and interaction
  • eventListByCollectionIdAndInteractionList - returns events for nfts that belong to collection and list of interactions
  • eventListByInteraction - returns events by interaction
  • eventListByItemId - returns events by nft id
  • eventListByItemIdAndInteraction - returns events by nft id and interaction
  • eventListByItemIdAndInteractionList - returns events by nft id and list of interactions
  • itemById - returns NFT by id
  • itemListByCollectionId - returns NFTs where collection id is equal to provided id
  • itemListByCollectionIdAndOwner - returns NFTs where collection id is equal to provided id and owner is equal to provided address
  • itemListByCollectionIdList - return list of NFTs by list of collectionIds
  • itemListByIssuer - returns NFTs where issuer (creator) is equal to provided address
  • itemListByName - returns NFTs where name contains provided name
  • itemListByMetadataId - returns NFTs where metadata is equal to provided uri
  • itemListByMetadataIdMatch -returns NFTs where metadata can match provided CID
  • itemListByOwner - returns NFTs where owner is equal to provided address
  • itemListCollectedBy - returns NFTs where owner is equal to provided address however it's not the issuer of the NFT
  • itemListForSale - returns NFTs where price is greater than 0
  • itemListForSaleByCollectionId - returns NFTs where price is greater than 0 and belong to particular collection
  • itemListSoldBy - no idea :shrug:
  • fetch - generic function to fetch data from provided query

✔️ REST

  • collection/:id
  • collectionByIssuer/:issuer
  • collectionByOwner/:owner
  • eventByAddress/:address
  • eventByInteraction/:interaction
  • eventByNftId/:id
  • item/:id
  • itemByCollection/:id
  • itemByCollectionList/:ids
  • itemByIssuer/:issuer
  • itemByCid/:id
  • itemByOwner/:owner
  • itemCollectedBy/:address
  • itemSoldBy/:address

⚠️ Caveats

REST implementation supports only functions that requires exactly one parameter. Please open a pull-request if you know how to fix this

✔️ Missing functions

  • collectionStatListById - returns collection metrics by id
  • lastNftIdbyCollectionId - returns last token id for collection by id

Development 💻

  • Clone this repository
git clone https://github.com/kodadot/uniquery.git
  • Navigate to the packages directory
cd uniquery
corepack enable

or

npm i -g corepack
  • Install Dependencies
pnpm install
  • Run interactive tests
pnpm dev

License

Made with 💛

Published under MIT License.