/parseSmartContractDefinitionForCreate

1 min

POST

Parse and validate a new contract definition file. Returns parsed contract data. Requires admin user.

************** Request example **********************

parseSmartContractDefinitionForCreate( file_bytes={ "functions": [ { "name": "create_user", "inputs": [ { "name": "caller", "type_": "address" }, { "name": "wallet_address", "type_": "address" }, { "name": "role_id", "type_": { "bytes_n": { "n": 32 } } }, { "name": "user_type", "type_": { "udt": { "name": "UserType" } } }, { "name": "jurisdiction_type", "type_": { "udt": { "name": "JurisdictionType" } } } ], "outputs": [] } ], coin_symbol="XLM" )

************** Response example *********************

  {
      "FunctionData": {
          "ParsedPreview": {
            "ParsedContract": {
              "ContractAddress": "CA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJVSGZ",
              "ContractName": "XLM_MMF",
              "CoinSymbol": "XLM",
              "Functions": [
                {
                  "SourceIndex": 0,
                  "Schema": {
                    "FunctionId": "create_user",
                    "StateAccess": "Write",
                    "Sections": [
                      {
                        "SectionName": "Data",
                        "Parameters": [
                          { "Name": "caller", "InputType": "creatable-single-select", "DataType": "address", "IsRequired": true },
                          { "Name": "wallet_address", "InputType": "creatable-single-select", "DataType": "address", "IsRequired": true },
                          { "Name": "role_id", "InputType": "input", "DataType": "bytes", "IsRequired": true },
                          { "Name": "user_type", "InputType": "array-single-select", "DataType": "enum(((Individual,void),(Corporation,void),(Trust,void),(Llc,void),(Partnership,void),(Admin,void),(System,void)))", "IsRequired": true },
                          { "Name": "jurisdiction_type", "InputType": "array-single-select", "DataType": "enum(((None,void),(Domestic,void),(International,void)))", "IsRequired": true }
                        ]
                      }
                    ]
                  }
                }
              ],
              "FailedFunctions": []
            }
          },
      "Meta": {
            "AccessToken": "58f08df6e369fa4d126e1ba5c7f66cf85c9c79df32d05fee8f3c542121c87cf5",
            "Destination": "044fd7dc60304b8aceeb662ce41bf9d9cc132278c0871c0a72fb4f3cecbabb25a86e43ae28dab21a95c64e2db76abdcfffb9bfdeec67a21399cfa5f555f01d054b",
            "Source": "be1f60e490b8ccabcc02a4595817b8edf45905d24944e87b8e3cae27f158df63843bfc4b09d37a5e752017b74ea2d136af272bea210f059e768e1ea8777aaf21e9",
            "Time": "2025-10-19 15:04:13.129"
      }
  }

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	2	File exceeds smartContractIdlMaxFileSizeKb / SMART_CONTRACT_DEFINITION_FILE_IS_TOO_LARGE	"StatusCode": 2
Backend Response	400	3	Coin has no mapped definition language/ UNKNOWN_SMART_CONTRACT_DEFINITION_LANGUAGE	"StatusCode": 3,
Backend Response	400	4	Blocking parse failure (includes invalid JSON)/ CONTRACT_PARSE_FAILED	"StatusCode": 4
Backend Response	400	5	Global preview cap (1000) exceeded / MAXIMUM_NUMBER_OF_SIMULTANEOUS_PREVIEWS_REACHED	"StatusCode": 5
Backend Response	400	6	Missing or unknown CoinSymbol / COIN_SYMBOL_IS_NOT_SUPPORTED	"StatusCode": 6

file_bytesobjectRaw bytes of the contract definition file

coin_symbolstringCoin symbol used by the server to select the appropriate parser

contract_addressstringOptional contract address override

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/parseSmartContractDefinitionForCreate?file_bytes=%0A{%0A%20%20%22functions%22%3A%20[%0A%20%20%20%20{%0A%20%20%20%20%20%20%22name%22%3A%20%22create_user%22%2C%0A%20%20%20%20%20%20%22inputs%22%3A%20[%0A%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22caller%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22type_%22%3A%20%22address%22%0A%20%20%20%20%20%20%20%20}%2C%0A%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22wallet_address%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22type_%22%3A%20%22address%22%0A%20%20%20%20%20%20%20%20}%2C%0A%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22role_id%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22type_%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%22bytes_n%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22n%22%3A%2032%0A%20%20%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20}%2C%0A%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22user_type%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22type_%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%22udt%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22UserType%22%0A%20%20%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20}%2C%0A%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22jurisdiction_type%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22type_%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%22udt%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22JurisdictionType%22%0A%20%20%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20]%2C%0A%20%20%20%20%20%20%22outputs%22%3A%20[]%0A%20%20%20%20}%0A%20%20]%0A}%0A&coin_symbol=XLM&contract_address=string' \
     --header 'accept: application/json'