Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sweetmantech/music-nft-inspect
verify music nfts
https://github.com/sweetmantech/music-nft-inspect
Last synced: about 13 hours ago
JSON representation
verify music nfts
- Host: GitHub
- URL: https://github.com/sweetmantech/music-nft-inspect
- Owner: SweetmanTech
- License: mit
- Created: 2022-11-24T21:19:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-28T02:22:40.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T21:21:10.568Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://musicnftinspect.xyz
- Size: 2.11 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⏯️ music-nft-inspect 🎧
this package allows you to easily verify music nfts.
This library works alongside the [metadata checker](https://hq.decent.xyz/) and allows for DAOs and individuals to compare nft metadata to the top music metadata standards including Catalog, Sound, Decent & more. Arbitrary music NFTs across a wide variety of contract implementations are supported.
### Main components:
- [evaluateCatalog20220202](https://gist.github.com/bretth18/df8358c840fa94946ec212f753e290dd)
### Quickstart
1. Install package:
```bash
yarn add music-nft-inspect
```
2. Index contract address:
```tsx
import { index } from "music-nft-inspect";
const chainId = 1;
const metadata = index(contractAddress, chainId);
console.log("metadataJson", metadata);
```
3. Evaluate:
```tsx
import { evaluate, index } from "music-nft-inspect";
const metadata = index(contractAddress);
const results = evaluate(metadata);
console.log("missing array", results[0].missing);
console.log("matching array", results[0].matching);
console.log("score", results[0].score);
```
## Contributing
If you're from Sound, Catalog, Ooh La La, Spin Amp, Future Tape, Zora, etc, this section is for you.
There are a few module types you can contribute to.
- Evaluators - input JSON and return `{matching, missing, score, ...}`.
- Indexers - read contract methods using `ethers`
### Adding a new Evaluator
1. `src/schemas/`
1. `src/evaluators/`
1. shared `evaluate()` export in `index.ts`
#### Schemas
- standard metadata JSON for music nfts
- examples found in `src/schemas`
#### Evaluators
- evaluators are the method to validate metadata schemas.
- `evaluate` method - returns `{missing, matching, score}` given a `metadata` JSON object.
- examples found in `src/evaluators`
### Adding a new Indexer
1. `src/abi/`
1. `src/indexers/`
1. shared `index()` export in `index.ts`
#### ABI
- standard contract ABI for music nfts
- examples found in `src/abi`
#### Indexers
- indexers are the method to read contract data and return metadata JSON.
- `index` method - returns `{metadataJson}` given a `contractAddress`.
- examples found in `src/indexers`