Define your collection

This page describes the different ways of defining the collection metadata. This information is used to create the items and inscribe them on-chain during the inscription process.

Programmatically

The recommended way of defining the collection metadata in a dynamic environment is using Typescript/Javascript.

Example programmatic collection metadata

import { Types } from '@handcash/handcash-connect';

const collectionMetadata: Types.CreateCollectionMetadata = {
  name: 'Example collection',
  description: 'A collection with example items',
  mediaDetails: {
    image: {
      url: 'https://res.cloudinary.com/handcash-iae/image/upload/v1685141160/round-handcash-logo_cj47fp_xnteyo_oy3nbd.png',
      contentType: 'image/png',
    },
  },
};

const collectionItems: Types.CreateItemMetadata[] = [
  {
    name: 'An example item',
    rarity: 'Common',
    attributes: [
      {
        name: 'Edition',
        value: 'First',
        displayType: 'string',
      },
    ],
    mediaDetails: {
      image: {
        url: 'https://res.cloudinary.com/handcash-iae/image/upload/v1702398906/items/da2qv0oqma0hs3gqevg7.webp',
        imageHighResUrl: 'https://res.cloudinary.com/handcash-iae/image/upload/v1697465892/items/gh7tsn11svhx7z943znv.png',
        contentType: 'image/png',
      },
    },
    color: '#B19334',
    quantity: 5,
  },
];

Collection Types

Here's an example of collection metadata:

{
  "name": "Example collection",
  "description": "A collection with example items",
  "mediaDetails": {
    "image": {
      "url": "https://handcash.io/asset/000012.png",
      "contentType": "image/png"
    }
  }
}
PropertyDescription
nameCollection name.
descriptionShort description about this collection.
mediaDetailsAn image to represent this collection in the wallet and in the market.

Items

Here's an example of a collection item metadata:

{
  "name": "An example item",
  "rarity": "Common",
  "color": "#B19334",
  "quantity": 5,
  "mediaDetails": {
    "image": {
         "url": "https://handcash.io/item/188272.webp",
         "imageHighResUrl": "https://handcash.io/item/188272.png",
         "contentType": "image/webp"
    }
  },
  "attributes": [
    {
      "name": "Edition",
      "value": "First",
      "displayType": "string"
    }
  ]
}

This is how each of these properties is used:

PropertyDescription
nameItem name.
rarityShould be one of ["Common", "Uncommon", "Rare", "Epic", "Mythic"].
colorHex color to represent this item. (Optional).
quantityTotal quantity of this item.
mediaDetailsAssets to represent this item. (see below)
attributesThese are the attributes for the item, which will show up on the HandCash for the item. (see below)
userThe user id to create the item to (Optional).

Attributes

Each item can be described using the following properties:

PropertyDescription
nameThe attribute name
valueThe attribute value
displayTypeThe way this value should be represented. (see below)

 Display types

These are the supported display types to represent attributes:

  • string: "fire"
  • number: 4
  • date: 23/05/2023
  • boostPercentage: +7%
  • boostNumber: +10

String

{
  "name": "Element",
  "displayType": "string", 
  "value": "Fire"
}

Number

{
  "name": "Attack",
  "displayType": "number", 
  "value": 8
}

Date

Pass in a unix timestamp (seconds) as the value.

{
  "name": "Birthday",
  "displayType": "string", 
  "value": 1688280400
}

Boost Percentage

{
  "name": "Element",
  "displayType": "string", 
  "value": "Fire"
}

Boost Number

{
  "name": "Attack increase",
  "displayType": "boostNumber", 
  "value": 3
}

Media details

The media details define the different assets available to represent the item:

PropertyDescription
imageThe main image used to represent the item in the wallet and in the market
multimediaComplementary asset to represent this item (3D files, audio files, etc...)
{
  "image": {
    "url": "https://handcash.io/item/188272.webp",
    "imageHighResUrl": "https://handcash.io/item/188272.png",
    "contentType": "image/webp"
  },
  "multimedia": {
    "url": "https://handcash.io/asset/3dImage.glb",
    "contentType": "application/glb"
  }
}
PropertyDescription
urlCan reference either a path to a local file or a URI to a remote file.
contentTypeOne of ["image/png", "image/jpg", "image/gif", "text/html", "audio/mpeg", "application/fbx", "application/glb"]

 Expected image sizes

image.url max size is 50kb and image.imageHighResUrl has no limit.

image.url will be put on chain and should be a lower resolution image, image.imageHighResUrl will be used to display the item in the inventory and market. It should follow the guidelines below for best results. Please reach out to Handcash Support or Sales with any questions or if you would like to put larger files on chain.

ContextAspect ratioOptimal resolution
Collection2:1600x300
Collection itemsFrom 1:1 to 2:3From 728:728 to 2048:2048