Skip to content

A public resource of standardized metadata for collections curated on the Ethereum Phunks marketplace. This repository provides easy access to collection metadata, TypeScript type definitions, and example usage for developers building tools and applications with Ethereum Phunks data.

License

Notifications You must be signed in to change notification settings

Ethereum-Phunks/curated-metadata

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Curated Collections Metadata

This repository contains metadata for collections curated on the Ethereum Phunks marketplace. It serves as a public resource for builders and tinkerers who want to work with the metadata of collections featured on our platform.

Purpose

The repository aims to:

  • Provide easy access to metadata for all collections curated on Ethereum Phunks
  • Enable developers to build tools and applications using this metadata
  • Maintain a standardized format for collection metadata

Usage

TypeScript Support

The repository includes TypeScript type definitions for the metadata structure. You can import these types in your project:

import { Metadata, CollectionMetadata, CollectionItem, Attribute } from './types';

Example Usage

import { CollectionMetadata } from './types';
import dystoPhunksMetadata from './metadata/dysto-phunks.json';

// Access collection information
console.log(dystoPhunksMetadata.name);
console.log(dystoPhunksMetadata.description);

// Access individual items
const firstItem = dystoPhunksMetadata.collection_items[0];
console.log(firstItem.name);
console.log(firstItem.attributes);

// Or load dynamically
import fs from 'fs';
const collectionData: CollectionMetadata = JSON.parse(
  fs.readFileSync('./metadata/ethereum-phunks.json', 'utf8')
);

Metadata Structure

Each collection metadata file follows this structure:

interface CollectionMetadata {
  name: string;
  logo_image: string | null;
  banner_image: string | null;
  total_supply: number;
  slug: string;
  description: string;
  website_url: string | null;
  twitter_url: string | null;
  discord_url: string | null;
  background_color: string | null;
  collection_items: CollectionItem[];
}

License

This metadata is released into the public domain under The Unlicense.

Note: While this metadata is released into the public domain, the original collections may have their own licenses. Please refer to the respective collection's terms and conditions for information about the underlying assets.

Support

For questions or support, please:

  • Open an issue in this repository
  • Follow us on Twitter

About

A public resource of standardized metadata for collections curated on the Ethereum Phunks marketplace. This repository provides easy access to collection metadata, TypeScript type definitions, and example usage for developers building tools and applications with Ethereum Phunks data.

Resources

License

Stars

Watchers

Forks