Crate sui_gql_client

Crate sui_gql_client 

Source
Expand description

§Sui GraphQL client

First version of Aftermath’s Sui GraphQL client using cynic.

The main item here is the GraphQlClient trait, defining the common interface for clients interacting with an RPC. See the reqwest feature for a pre-made implementation.

The queries inclued here (under feature queries) were constructed with the help of cynics generator and use the scalars defined in sui_gql_schema.

§Custom queries

Users building their own queries should first:

  1. add sui_gql_schema as a build dependency
  2. register its schema in a build.rs file;
  3. import the schema module in any module defining new fragments

For steps 1 and 2, you can check this crate’s [build-dependencies] and build.rs for an example of how to do so. Read more about schema crates in https://cynic-rs.dev/large-apis.

Then, to create query structs, we recommend using the generator with Sui’s GraphQL schema and to try reusing the scalars defined in scalars as those automatically convert opaque types to more useful ones like af_sui_types.

§Features

  • move-types: compatibility with af-move-type types
  • mutations: enables the mutations submodule
  • queries: enables the queries submodule with pre-made queries
  • reqwest: enables the reqwest submodule with an implementation of GraphQlClient
  • scalars: re-exports the scalars module of sui_gql_schema
  • Query builder: generator.cynic-rs.dev. When prompted either
    • click the “A URL” button and pass in:
      • https://sui-testnet.mystenlabs.com/graphql to build queries against the testnet schema
      • https://sui-mainnet.mystenlabs.com/graphql for the mainnet one
    • click the “I’ll Paste It” button and paste the schema
  • Cynic’s guide

Re-exports§

pub use cynic;

Modules§

extractDeprecated
Defines extract! and its Error.
queries
reqwest
scalars

Macros§

extractDeprecated
Helper for extracting data from GraphQL responses.
missing_data
Helper to generate Error::MissingData.

Structs§

GraphQlErrors
Error for GraphQlResponseExt::try_into_data.
PagedResponse
Pages resulting from GraphQL queries.

Enums§

RawClientError

Traits§

GraphQlClient
A generic GraphQL client. Agnostic to the backend used.
GraphQlResponseExt
Adds try_into_data.
Paged
Interface for paged queries to allow automatic pagination.
RawClient
Client that takes a Cynic operation and return the GraphQL response as JSON.

Type Aliases§

PagesDataResult
The initial page data and subsequent ones’, if any.