FIfireblocks
Contract Templates

Return contract template by id

Return detailed information about the contract template

get/tokenization/templates/{contractTemplateId}

Request

Path parameters

contractTemplateIdstring required

The Contract Template identifier

Response

Contract template was returned successfully

idstring required

The unique identifier of the contract template

namestring required

The name of the contract template

descriptionstring required

A short description of the contract template

longDescriptionstring

A full description of the contract template. May contain to break the lines

ownerstring

The workspace id of the owner of this contract template. If it's a private contract, only this workspace will be allowed to deploy it

isPublicboolean required

Is this a contract that is viewable by all fireblocks's users or is it visible only for this workspace

canDeployboolean

True if the workspace allowed to deploy this contract, false otherwise

type'FUNGIBLE_TOKEN' | 'NON_FUNGIBLE_TOKEN' | 'NON_TOKEN' | 'TOKEN_EXTENSION' | 'TOKEN_UTILITY'

The type of the contract template

implementationContractIdstring
initializationPhase'ON_DEPLOYMENT' | 'POST_DEPLOYMENT' required

Example response

{
  "id": "b70701f4-d7b1-4795-a8ee-b09cdb5b850d",
  "name": "My Contract",
  "description": "an ERC20 implementation",
  "longDescription": "a full ERC20 implementation, containing the following:\n\n - mint\n - burn\n",
  "abi": [
    {
      "inputs": [
        {
          "internalType": "address",
          "name": "implementation",
          "type": "address"
        },
        {
          "internalType": "bytes",
          "name": "_data",
          "type": "bytes"
        }
      ],
      "stateMutability": "payable",
      "type": "constructor"
    }
  ],
  "docs": {
    "details": "A token that can be minted and burned",
    "events": "Upgraded(address): {\"details\": \"Emitted when the implementation is upgraded.\"}",
    "kind": "dev",
    "methods": {
      "constructor": {
        "details": "Initializes the contract"
      }
    },
    "version": 1
  },
  "owner": "b70701f4-d7b1-4795-a8ee-b09cdb5b850d",
  "vendor": {
    "id": "b70701f4-d7b1-4795-a8ee-b09cdb5b4453",
    "name": "Fireblocks"
  },
  "isPublic": true,
  "canDeploy": true,
  "type": "FUNGIBLE_TOKEN"
}

Changes

No recorded changes to this operation across all 1 revision of this API.