Deploy an Inscription

Deploy an Inscription with a name, ticker, max, limit, metadata, and memo.

Deployment HCS-20 Structure

This is the stucture that is used to send to the topic, this payload has been humanised to be more understandable.

{
  "p": "hcs-20",
  "op": "deploy",
  "name": "point_name",
  "tick": "unique_point_identifier",
  "max": "max_supply",
  "lim": "optional_limit_of_mint_per_transaction",
  "metadata": "optional_metadata",
  "m": "optional_memo"
}

Overview

There are 3 required fields needed to deploy an inscription:

• name

• ticker

• max (supply)

These are the optional fields you can use:

• topic_id (your private application for controlling all points or inscriptions)

• limit (the amount of points or inscription amount that can be sent in one tx)

• metadata (any HIP412 compliant data, can be used for NFT/Art)

• memo (an additional memo at the deployment level)

POST https://hedera-serverless-consensus.vercel.app/api/inscription/deploy

Deploy an Inscription

Headers

Name	Type	Description
x-api-key*	String	The API_SECRET_KEY from the client's environment variables.

Request Body

Name	Type	Description
ticker*		Unique ticker of the inscription
name*	String	Name of the inscription
max*	Int	Supply of the inscription
topic_id	String	your private topic for limiting access
limit	Int
metadata	String
memo	String

200: OK Inscription Deployed

{
    // Response
}

401: Unauthorized Header Auth Missing/invalid

{
    // Response
}

422: Unprocessable Entity Missing params in body

{
    // Response
}