EVM Batch General Settings

Documentation Index

Fetch the complete documentation index at: https://docs.sqd.dev/llms.txt

Use this file to discover all available pages before exploring further.

• one or both of setGateway() and setRpcEndpoint()
• setFinalityConfirmation() whenever RPC ingestion is enabled, namely when
  • a RPC endpoint was configured with setRpcEndpoint()
  • RPC ingestion has NOT been explicitly disabled by calling setRpcDataIngestionSettings({ disabled: true })

• If you need real-time data and your network has a SQD Network gateway, use both setGateway() and setRpcEndpoint(). The processor will obtain as much data as is currently available from the network, then switch to ingesting recent data from the RPC endpoint.
• If you can tolerate your data being several thousands of blocks behind the chain head, you do not want to use a RPC endpoint and your network has a SQD Network gateway, use setGateway() only.
• If your EVM network does not have a SQD Network gateway, use setRpcEndpoint() only. You can use this regime to work with local development nodes.
• If your squid uses direct RPC queries then setRpcEndpoint() is a hard requirement. You can reduce the RPC usage by adding a Network data source with setGateway(). Further, if you can tolerate a latency of a few thousands of blocks, you can disable RPC ingestion with setRpcDataIngestionSettings({ disabled: true }). In this scenario RPC will only be used for the queries you explicitly make in your code.

​

setGateway(url: string | GatewaySettings)

{
  url: string // gateway URL
  requestTimeout?: number // in milliseconds
}

​

setRpcEndpoint(rpc: ChainRpc)

• RPC ingestion (unless explicitly disabled with setRpcDataIngestionSettings())
• any direct RPC queries you make in your squid code

type ChainRpc = string | {
  url: string // http, https, ws and wss are supported
  capacity?: number // num of concurrent connections, default 10
  maxBatchCallSize?: number // default 100
  rateLimit?: number // requests per second, default is no limit
  requestTimeout?: number // in milliseconds, default 30_000
  headers: Record<string, string> // http headers
}

​

setDataSource(ds: {archive?: string, chain?: ChainRpc}) (deprecated)

​

setRpcDataIngestionSetting(settings: RpcDataIngestionSettings)

type RpcDataIngestionSettings = {
  disabled?: boolean
  preferTraceApi?: boolean
  useDebugApiForStateDiffs?: boolean
  debugTraceTimeout?: string
  headPollInterval?: number
  newHeadTimeout?: number
}

• disabled: Explicitly disables data ingestion from an RPC endpoint.
• preferTraceApi: By default, debug_traceBlockByHash is used to obtain call traces. This flag instructs the processor to utilize trace_ methods instead. This setting is only effective for finalized blocks.
• useDebugApiForStateDiffs: By default, trace_replayBlockTransactions is used to obtain state diffs for finalized blocks. This flag instructs the processor to utilize debug_traceBlockByHash instead. This setting is only effective for finalized blocks. WARNING: this will significantly increase the amount of data retrieved from the RPC endpoint. Expect download rates in the megabytes per second range.
• debugTraceTimeout: If set, the processor will pass the timeout parameter to debug trace config.
• headPollInterval: Poll interval for new blocks in milliseconds. Poll mechanism is used to get new blocks via HTTP connections. Default: 5000.
• newHeadTimeout: When ingesting from a websocket, this setting specifies the timeout in milliseconds after which the connection will be reset and subscription re-initiated if no new blocks were received. Default: no timeout.

​

setFinalityConfirmation(nBlocks: number)

​

setBlockRange({from: number, to?: number})

​

includeAllBlocks(range?: {from: number, to?: number})

​

setPrometheusPort(port: string | number)