Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Required / optional fields are not documented in the Token Standard #2284

Open
mikemaccana opened this issue Feb 22, 2023 · 1 comment
Open

Comments

@mikemaccana
Copy link

What fields are required vs optional in https://docs.metaplex.com/programs/token-metadata/token-standard#the-non-fungible-standard ?

Eg 'symbol' is in the standard, but not used in the example.

If Metaplex could add a 'required' column to the table it would be helpful. ❤️

@mikemaccana
Copy link
Author

Found it: @metaplex-foundation/js/dist/types/plugins/nftModule/models/JsonMetadata.d.ts

/** @group Models */
export type JsonMetadata<Uri = string> = {
    name?: string;
    symbol?: string;
    description?: string;
    seller_fee_basis_points?: number;
    image?: Uri;
    external_url?: Uri;
    attributes?: Array<{
        trait_type?: string;
        value?: string;
        [key: string]: unknown;
    }>;
    properties?: {
        creators?: Array<{
            address?: string;
            share?: number;
            [key: string]: unknown;
        }>;
        files?: Array<{
            type?: string;
            uri?: Uri;
            [key: string]: unknown;
        }>;
        [key: string]: unknown;
    };
    collection?: {
        name?: string;
        family?: string;
        [key: string]: unknown;
    };
    [key: string]: unknown;
};

Someone (maybe me?) should add it to the docs though so keeping open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant