This repository has been archived by the owner on Oct 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into 1276/fix-failing-transfer-out-test
- Loading branch information
Showing
85 changed files
with
1,905 additions
and
1,174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Designing a Schema | ||
|
||
The Fuel indexer uses GraphQL in order to allow users to query for indexed data. In this chapter, you can find information on how to leverage our supported features to efficiently get the data you want. | ||
|
||
> ⚠️ Please note that the Fuel indexer does not support the full GraphQL specification; however, we do our best to reasonably support as much as we can. | ||
- [Types](./types.md) | ||
- [Scalars](./scalars.md) | ||
- [Directives](./directives.md) | ||
- [Relationships](./relationships.md) | ||
|
||
## Supported Functionality | ||
|
||
While we do our best to maintain compliance with the GraphQL specification and parity with other implementations, there are a few things that are under development or will not be implemented. Here's a table describing our GraphQL functionality: | ||
|
||
Legend: | ||
|
||
- 🟩 : Functionally complete | ||
- 🟨 : Partially complete | ||
- 🟥 : Planned but incomplete | ||
- ⛔ : Not planned | ||
|
||
| Functionality | Status | Notes | | ||
|------|----------|-------| | ||
| Arguments | 🟩 | [read the Search and Filtering section](../querying/search-and-filtering.md) | | ||
| Aliases | 🟩 | | | ||
| Fragments | 🟨 | inline fragments are currently not supported | | ||
| Introspection | 🟩 | | | ||
| GraphQL Playground | 🟩 | [read the Playground section](../querying/playground.md) | | ||
| Pagination | 🟨 | [read the Pagination section](../querying/pagination.md) | | ||
| Directives |🟨 | [read the Directives section](./directives.md) | | ||
| List Types |🟨 | | | ||
| Union Types |🟨 | | | ||
| Federation |⛔ | | | ||
| Variables | ⛔ | | | ||
| Mutations | ⛔ | | | ||
| Enums | 🟨 | | | ||
| Interfaces | ⛔ | | | ||
| Input Types| ⛔ | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Scalars | ||
|
||
The Fuel indexer has a collection of GraphQL scalars that cover virtually any value type in use on the Fuel network. The following list contains each GraphQL scalar type along with its equivalent Rust type. | ||
|
||
| GraphQL Scalar | Rust Type | Notes | | ||
--- | --- | --- | ||
| Address | `u8[32]` | | ||
| AssetId | `u8[32]` | | ||
| Blob | `Vec<u8>` | Byte blob of arbitary size | | ||
| BlockId | `u8[32]` | 32-byte block ID | | ||
| Boolean | `bool` | | ||
| Bytes4 | `u8[4]` | | ||
| Bytes8 | `u8[8]` | | ||
| Bytes32 | `u8[32]` | | ||
| Bytes64 | `u8[64]` | | ||
| Charfield | `String` | String of arbitrary size | | ||
| ContractId | `u8[32]` | | ||
| HexString | `Vec<u8>` | Byte blob of arbitrary size | | ||
| ID | `SizedAsciiString<64>` | Alias of `UID` | ||
| Int1 | `i8` | | ||
| Int4 | `i32` | | ||
| Int8 | `i64` | | ||
| Int16 | `i128` | | ||
| Json | `String` | JSON string of arbitary size | | ||
| MessageId | `u8[32]` | | ||
| Nonce | `u8[32]` | | ||
| Salt | `u8[32]` | | ||
| Signature | `u8[64]` | 64-byte signature | | ||
| Tai64Timestamp | `Tai64` | `Tai64` timestamp | | ||
| Timestamp | `u64` | | ||
| UID | `SizedAsciiString<64>` | 32-byte unique ID | | ||
| UInt1 | `u8` | | ||
| UInt4 | `u32` | | ||
| UInt8 | `u64` | | ||
| UInt16 | `u128` | | ||
| Virtual | `String` | Used to store types tagged with `@virtual` directive | |
Oops, something went wrong.