Skip to content
/ sol-rayz Public
forked from NftEyez/sol-rayz

💫 Package to simplify parsing NFTs on Solana and build NFT galleries

License

Notifications You must be signed in to change notification settings

ilmoi/sol-rayz

 
 

Repository files navigation

@nfteyez/sol-rayz

These packages created to simplify the process of parsing NFTs on Solana.

It consists of:

  • @nfteyez/sol-rayz - package basic things like fetch all NFTs for specific wallet. Designed to be used in browser or Node.JS env.
  • @nfteyez/sol-rayz-react - bunch of hooks and utils to be used within React app.

Install

You need install @solana/web3.js in your project, since it is used as peer dependency.

npm i @solana/web3.js
npm i @nfteyez/sol-rayz

or if you want to use code with React

npm i @solana/web3.js
npm i @nfteyez/sol-rayz-react

How to use

getParsedNftAccountsByOwner - return parsed list of NFTs (SPL Tokens) for given wallet public address. Each item in array have all data specified on the blockchain. The NFT metadata stored separately, you need to pick uri property for each token and fetch data youself.

import {
  getParsedNftAccountsByOwner
} from "@nfteyez/sol-rayz";

const tokenList = getParsedNftAccountsByOwner();

createConnectionConfig - method for creating a "connection" with Solana, have two params: clusterApi and commitment.

getParsedNftAccountsByOwner - method to get array of parsed NFTs by owner address. Have three params: wallet address(required), connection , serialization (true/false).

isValidSolanaAddress - check if provided string is valid Solana address.

TBD

TODO list:

  • Create descriptive README
  • Add React Hooks

Development

Instructions for starting project for the contributors. Clone repo, run in root of the project:

yarn
yarn run build

Add New new dependency to some package

Here is example how to add new dependency module @solana/spl-name-service to @nfteyez/sol-rayz package:

 lerna add @solana/spl-name-service --scope=@nfteyez/sol-rayz

About

💫 Package to simplify parsing NFTs on Solana and build NFT galleries

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 92.0%
  • HTML 5.3%
  • CSS 2.0%
  • JavaScript 0.7%