bigfoot.marketplace v1.5.7

BigFoot Marketplace Interfaces

Table of content

Usage

Interfaces

1. Collection
2. Account
3. Item

Usage

// NodeJS with TS
import { Collection } from "bigfoot.marketplace"

class CollectionModel implements Collection {
    // ...
}


// React With TS
import { Item } from "bigfoot.marketplace"


const App = () => {
    const [item, setItem] = useState<Item | null>(null)
    
    // ...
}

Unwrapped interfaces

Collection

interface Collection {
    address: string;
    external: {
        name: string;
        external_link: string;
        description: string;
        slug: string;
        image_url: string;
        banner_image_url: string;
    };
    metadata: {
        owner: string;
        created_date: Date;
        contract_type: ContractType;
    };
}

Account

interface Account {
    address: string;
    user: {
        username?: string;
        avatar?: string;
    };
    config: {
        verified: boolean;
        created_collections: string[] | Collection[];
    };
}

Item

interface Item {
    collection_id: string;
    token_id: number;
    image_url: string;
    owner: string;
    metadata: {
        name: string;
        description: string;
        image_url: string;
        traits: {
            trait_type: string
            value: any[];
        };
    };
}