soohanpark / nft-snapshooter

NFT Owner Snapshot

Home Page:https://soohan-park.github.io/nft-snapshooter/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NFT SNAPSHOOTER

Script for NFT holder snapshots.
It supports Klaytn, Ethereum, Polygon networks.

TL;DR

# SET UP
npm install -g yarn
npm install -g typescript ts-node
yarn install
# RUN
yarn start <"ETH" | "KLAY" | "MATIC"> <CONTRACT_ADDRESS>

Getting Started

Prerequisites

Install yarn.

npm install -g yarn

Install typescript && ts-node.
(If you don't wanna using ts-node, you can use compiled file.)

npm install -g typescript ts-node

Fill out your network RPC providers in /config/networkConfig.ts.

const networkConfig = {
  eth: {
    name: "ETH",
    chainId: 1,
    providerUrl: "<YOUR RPC PROVIDER URL>",
  },
  klay: {
    name: "KLAY",
    chainId: 8217,
    providerUrl: "<YOUR RPC PROVIDER URL>",
  },
  matic: {
    name: "MATIC",
    chainId: 137,
    providerUrl: "<YOUR RPC PROVIDER URL>",
  },
};

export default networkConfig;

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

yarn install

Run

When it all installed,

yarn start <NETWORK_NAME> <CONTRACT_ADDRESS>
  • NETWORK_NAME will be such as KLAY, ETH, and MATIC.
  • CONTRACT_ADDRESS will be an address what you want to snapshot.

Finally, you can find the result in /out/snapshot_<DATETIME>.csv.

Built With

  • ts-node - run typescript file for node.js.
  • caver-js - Used to communicate with Klaytn network.
  • web3.js - Ethereum JavaScript API

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details

About

NFT Owner Snapshot

https://soohan-park.github.io/nft-snapshooter/

License:MIT License


Languages

Language:HTML 90.2%Language:TypeScript 9.8%