Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(repo): Introduce FuelStreams Types #320

Merged
merged 6 commits into from
Nov 26, 2024

Conversation

Jurshsmith
Copy link
Member

Currently, fuel-core types are directly exposed to users for streaming. However, this approach has several drawbacks:

  1. The serialized structures are tailored for Rust, making them difficult to integrate with existing SDKs.
  2. The unstructured serialized output complicates compatibility efforts.
  3. Exposing fuel-core types could mislead users into assuming related APIs, which require a configured environment, are usable directly with streams.

This PR addresses these issues by introducing FuelStreams types, designed as aggregation types optimized for broad use cases. These types are derived from the GraphQL interface used in frontend projects, ensuring a structured and user-friendly format.

Moving forward, we will expand these types to include additional fields based on user needs, making them more versatile and compatible across different integrations.

Closes DS-113

Subtasks:
Closes DS-114, DS-115, DS-116, DS-117, DS-118

@Jurshsmith Jurshsmith self-assigned this Nov 23, 2024
@Jurshsmith Jurshsmith force-pushed the aj/DS-113/introduce-core-fuel-streams-types branch 3 times, most recently from 9785d79 to ec728d9 Compare November 23, 2024 11:30
…aphQL's

This change introduces Block, Transaction, Receipt, Utxo, Log, Input, Output structs
instead of exposing fuel-core's for stream consumers. We cache and aggregate all necessary
fields in these structures and try to align them with their respective GraphQL's interfaces.
@Jurshsmith Jurshsmith force-pushed the aj/DS-113/introduce-core-fuel-streams-types branch from 6521ff3 to 49e0ac2 Compare November 25, 2024 17:55
@Jurshsmith Jurshsmith merged commit 3aa67dd into main Nov 26, 2024
15 checks passed
@Jurshsmith Jurshsmith deleted the aj/DS-113/introduce-core-fuel-streams-types branch November 26, 2024 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants