Skip to main content
⚠️ This is the beta version of the Sui GraphQL schema. The beta schema will replace the alpha GraphQL schema upon its official release.

ServiceConfig

No description

type ServiceConfig {
  mutationTimeoutMs: Int
  queryTimeoutMs: Int
  maxQueryDepth: Int
  maxQueryNodes: Int
  maxOutputNodes: Int
  maxTransactionPayloadSize: Int
  maxQueryPayloadSize: Int
  defaultPageSize(
    type: String!
    field: String!
  ): Int
  maxPageSize(
    type: String!
    field: String!
  ): Int
  maxMultiGetSize: Int
  maxTypeArgumentDepth: Int
  maxTypeArgumentWidth: Int
  maxTypeNodes: Int
  maxMoveValueDepth: Int
}

Fields​

ServiceConfig.mutationTimeoutMs ● Int scalar​

Maximum time in milliseconds spent waiting for a response from fullnode after issuing a transaction to execute. Note that the transaction may still succeed even in the case of a timeout. Transactions are idempotent, so a transaction that times out should be re-submitted until the network returns a definite response (success or failure, not timeout).

ServiceConfig.queryTimeoutMs ● Int scalar​

Maximum time in milliseconds that will be spent to serve one query request.

ServiceConfig.maxQueryDepth ● Int scalar​

Maximum depth of a GraphQL query that can be accepted by this service.

ServiceConfig.maxQueryNodes ● Int scalar​

The maximum number of nodes (field names) the service will accept in a single query.

ServiceConfig.maxOutputNodes ● Int scalar​

Maximum number of estimated output nodes in a GraphQL response.

The estimate is an upperbound of how many nodes there would be in the output assuming every requested field is present, paginated requests return full page sizes, and multi-get queries find all requested keys. Below is a worked example query:

|  0: query {                            # 514 = total
|  1:   checkpoint {                     # 1
|  2:     sequenceNumber                 # 1
|  3:   }
|  4:
|  5:   multiGetObjects([$a, $b, $c]) {  # 1 (* 3)
|  6:     address                        # 3
|  7:     digest                         # 3
|  8:   }
|  9:
| 10:   # default page size is 20
| 11:   transactions {                   # 1 (* 20)
| 12:     pageInfo {                     # 1
| 13:       hasNextPage                  # 1
| 14:       endCursor                    # 1
| 15:     }
| 16:
| 17:     nodes                          # 1
| 18:     {                              # 20
| 19:       digest                       # 20
| 20:       effects {                    # 20
| 21:         objectChanges(first: 10) { # 20 (* 10)
| 22:           nodes                    # 20
| 23:           {                        # 200
| 24:             address                # 200
| 25:           }
| 26:         }
| 27:       }
| 28:     }
| 29:   }
| 30: }

ServiceConfig.maxTransactionPayloadSize ● Int scalar​

Maximum size in bytes allowed for the txBytes and signatures parameters of an executeTransaction or simulateTransaction field, or the bytes and signature parameters of a verifyZkLoginSignature field.

This is cumulative across all matching fields in a single GraphQL request.

ServiceConfig.maxQueryPayloadSize ● Int scalar​

Maximum size in bytes of a single GraphQL request, excluding the elements covered by maxTransactionPayloadSize.

ServiceConfig.defaultPageSize ● Int scalar​

Number of elements a paginated connection will return if a page size is not supplied.

Accepts type and field arguments which identify the connection that is being queried. If the field in question is paginated, its default page size is returned. If it does not exist or is not paginated, null is returned.

ServiceConfig.defaultPageSize.type ● String! non-null scalar​
ServiceConfig.defaultPageSize.field ● String! non-null scalar​

ServiceConfig.maxPageSize ● Int scalar​

Maximum number of elements that can be requested from a paginated connection. A request to fetch more elements will result in an error.

Accepts type and field arguments which identify the connection that is being queried. If the field in question is paginated, its max page size is returned. If it does not exist or is not paginated, null is returned.

ServiceConfig.maxPageSize.type ● String! non-null scalar​
ServiceConfig.maxPageSize.field ● String! non-null scalar​

ServiceConfig.maxMultiGetSize ● Int scalar​

Maximum number of elements that can be requested from a multi-get query. A request to fetch more keys will result in an error.

ServiceConfig.maxTypeArgumentDepth ● Int scalar​

Maximum amount of nesting among type arguments (type arguments nest when a type argument is itself generic and has arguments).

ServiceConfig.maxTypeArgumentWidth ● Int scalar​

Maximum number of type parameters a type can have.

ServiceConfig.maxTypeNodes ● Int scalar​

Maximum number of datatypes that need to be processed when calculating the layout of a single type.

ServiceConfig.maxMoveValueDepth ● Int scalar​

Maximum nesting allowed in datatype fields when calculating the layout of a single type.

Returned By​

serviceConfig query