Aptos · Schema

MoveFunction

Move function

BlockchainWeb3MoveLayer 1CryptocurrencyNFTSmart ContractsDeFiTransactionsAccountsGraphQLgRPC

Properties

Name Type Description
name object
visibility object
is_entry boolean Whether the function can be called as an entry function directly in a transaction
is_view boolean Whether the function is a view function or not
generic_type_params array Generic type params associated with the Move function
params array Parameters associated with the move function
return array Return type of the function
View JSON Schema on GitHub

JSON Schema

MoveFunction.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/aptos/json-schema/MoveFunction.json",
  "title": "MoveFunction",
  "type": "object",
  "description": "Move function",
  "required": [
    "name",
    "visibility",
    "is_entry",
    "is_view",
    "generic_type_params",
    "params",
    "return"
  ],
  "properties": {
    "name": {
      "$ref": "#/components/schemas/IdentifierWrapper"
    },
    "visibility": {
      "$ref": "#/components/schemas/MoveFunctionVisibility"
    },
    "is_entry": {
      "type": "boolean",
      "description": "Whether the function can be called as an entry function directly in a transaction"
    },
    "is_view": {
      "type": "boolean",
      "description": "Whether the function is a view function or not"
    },
    "generic_type_params": {
      "type": "array",
      "description": "Generic type params associated with the Move function",
      "items": {
        "$ref": "#/components/schemas/MoveFunctionGenericTypeParam"
      }
    },
    "params": {
      "type": "array",
      "description": "Parameters associated with the move function",
      "items": {
        "$ref": "#/components/schemas/MoveType"
      }
    },
    "return": {
      "type": "array",
      "description": "Return type of the function",
      "items": {
        "$ref": "#/components/schemas/MoveType"
      }
    }
  }
}