GraphQL Client

[ryangoree]

GraphQL clients are well suited for RPC APIs. Every function call is potentially another RPC request unless batched.

The base schema could look something like this:

type Query {
  # Network queries
  getChainId: Int!
  getBlock(block: Int | Hash | BlockTag = latest): Block
  getBalance(address: Address!, block: Int | Hash | BlockTag): Int!
  getTransaction(hash: String!): Transaction
}

scalar HexString
scalar Address # semantic alias for HexString
scalar Bytes # semantic alias for HexString
scalar Hash # semantic alias for HexString

enum BlockTag {
  latest
  earliest
  pending
  safe
  finalized
}

Contract calls could either be implemented as generic operations like:

type Query {
  read(
    address: Address!
    fn: String! # e.g., "balanceOf(address)"
    args: JSON! # e.g., "{\"address\":\"0x123...\"}" or "[\"0x123...\"]"
    options: ReadOptions # e.g., { block: "latest" }
  ): JSON! # Returns the raw result as JSON
}

type ReadOptions {
  block: Int | Hash | BlockTag
}

Or, a codegen tool could generate schemas based on the ABI:

# Generated from ERC20 ABI
type ERC20 {
  name(options: ReadOptions): String!
  totalSupply(options: ReadOptions): Int!
  balanceOf(account: Address!, options: ReadOptions): Int!
  # ...
}

type Query {
  erc20(address: Address!): ERC20!
}