Skip to main content

Type Alias: ServiceConfig

type ServiceConfig = {
  defaultPageSize: number;
  enabledFeatures: Feature[];
  maxMoveValueDepth: number;
  maxOutputNodes: number;
  maxPageSize: number;
  maxQueryDepth: number;
  maxQueryNodes: number;
  maxQueryPayloadSize: number;
  maxTypeArgumentDepth: number;
  maxTypeArgumentWidth: number;
  maxTypeNodes: number;
  mutationTimeoutMs: number;
  requestTimeoutMs: number;
};

Generated factory for ServiceConfig record objects.

Properties​

defaultPageSize​

defaultPageSize: number;

Default number of elements allowed on a single page of a connection.

enabledFeatures​

enabledFeatures: Feature[];

List of all features that are enabled on this RPC service.

maxMoveValueDepth​

maxMoveValueDepth: number;

Maximum estimated cost of a database query used to serve a GraphQL request. This is measured in the same units that the database uses in EXPLAIN queries. Maximum nesting allowed in struct fields when calculating the layout of a single Move Type.

maxOutputNodes​

maxOutputNodes: number;

The maximum number of output nodes in a GraphQL response. Non-connection nodes have a count of 1, while connection nodes are counted as the specified 'first' or 'last' number of items, or the default_page_size as set by the server if those arguments are not set. Counts accumulate multiplicatively down the query tree. For example, if a query starts with a connection of first: 10 and has a field to a connection with last: 20, the count at the second level would be 200 nodes. This is then summed to the count of 10 nodes at the first level, for a total of 210 nodes.

maxPageSize​

maxPageSize: number;

Maximum number of elements allowed on a single page of a connection.

maxQueryDepth​

maxQueryDepth: number;

The maximum depth a GraphQL query can be to be accepted by this service.

maxQueryNodes​

maxQueryNodes: number;

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

maxQueryPayloadSize​

maxQueryPayloadSize: number;

Maximum length of a query payload string.

maxTypeArgumentDepth​

maxTypeArgumentDepth: number;

Maximum nesting allowed in type arguments in Move Types resolved by this service.

maxTypeArgumentWidth​

maxTypeArgumentWidth: number;

Maximum number of type arguments passed into a generic instantiation of a Move Type resolved by this service.

maxTypeNodes​

maxTypeNodes: number;

Maximum number of structs that need to be processed when calculating the layout of a single Move Type.

mutationTimeoutMs​

mutationTimeoutMs: number;

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 resubmitted until the network returns a definite response (success or failure, not timeout).

requestTimeoutMs​

requestTimeoutMs: number;

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