Use backend-agnostic Rust types in fuel-client-core instead of GraphQL types
#1121
Closed
5 tasks done
Assignees
Comments
Voxelot
changed the title
bvrooman
changed the title
fuel-client-core instead of GraphQL types
This was referenced Apr 21, 2023
Closed
xgreenx
added a commit
that referenced
this issue
May 22, 2023
Related issues: - #1121 This PR introduces a module of Rust types used by the `Client` in the `fuel-core-client` crate. These types are referred to as client types and they are used to compose the `Client` interface. All function signatures in the Client interface now use only client types and Rust primitives. All references to GraphQL schema types are removed from the interface's function signatures. Specifically, this PR introduces the following client types: - `Balance` - `Block` (as well as its constituent parts `Header`, `Consensus`, `Genesis`, and `PoAConsensus`) - `ChainInfo` - `Coin`, `MessageCoin`, and `CoinType` - `ConsensusParameters` - `Contract` and `ContractBalance` - `MerkleProof` - `Message` and `MessageProof` - `NodeInfo` While GraphQL types are used inside the client methods, all types returned by the GraphQL server are transformed back into client types so that the `Client` returns only these client types. This is enabled by defining a number of `From` traits, that transform the GraphQL schema type into the client type. --------- Co-authored-by: green <xgreenx9999@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The fuel-core-client currently exposes graphql specific types on its public api.
In order to make fuel-core graphql agnostic, all public types in fuel-core-client should be plain rust types that aren't specific to any backend server implementation or transport mechanism (i.e. grpc vs graphql).
Create a module in
fuel-core-clientcontaining all the plain Rust types, similar tofuel-core-types. These types should be optimized for user friendliness and SDK experience. This task will be considered as complete when there are no public types exposed byfuel-core-clientthat depend oncynic.Acceptance Criteria:
fuel-client-corecontains atypesmodule for agnostic Rust typestypesmodule is self-contained and does not depend on or reuse existing Fuel types, such asfuel-core-typesfuel-client-coreconsumersfuel-core-clientdepend oncynicThe text was updated successfully, but these errors were encountered: