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.
- Loading branch information
Showing
3 changed files
with
142 additions
and
142 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| # Automatically generating GraphQL schema from JSON ABI | ||
|
|
||
| `forc index new` supports automatically generating GraphQL schema from a contract JSON ABI. | ||
|
|
||
| Sway `struct`s are translated into GrapQL `type`s, and the following `struct` field types are supported: | ||
|
|
||
| | Sway Type | GraphQL Type | | ||
| |-----------|--------------| | ||
| | u128 | U128 | | ||
| | u64 | U64 | | ||
| | u32 | U32 | | ||
| | u8 | U8 | | ||
| | i128 | I128 | | ||
| | i64 | I64 | | ||
| | i32 | I32 | | ||
| | i8 | I8 | | ||
| | bool | Boolean | | ||
| | u8[64] | Bytes64 | | ||
| | u8[32] | Bytes32 | | ||
| | u8[8] | Bytes8 | | ||
| | u8[4] | Bytes4 | | ||
| | Vec<u8>| Bytes | | ||
| | SizedAsciiString<64> | ID | | ||
| | String | String | | ||
| | str[32] | Bytes32 | | ||
| | str[64] | Bytes64 | | ||
|
|
||
| Sway `enum` types can also be translated. However, all enum variants must have `()` type. For example: | ||
|
|
||
| ```rust | ||
| pub enum SimpleEnum { | ||
| One: (), | ||
| Two: (), | ||
| Three: (), | ||
| } | ||
| ``` | ||
|
|
||
| Will be translated to GraphQL as: | ||
|
|
||
| ```GraphQL | ||
| enum SimpleEnumEntity { | ||
| ONE | ||
| TWO | ||
| THREE | ||
| } | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| Using the `DAO-contract-abi.json`, which can be found in the `fuel-indexer` repository: | ||
|
|
||
| ```bash | ||
| forc index new --json-abi ./packages/fuel-indexer-tests/trybuild/abi/DAO-contract-abi.json dao-indexer | ||
| ``` | ||
|
|
||
| We get the following schema: | ||
|
|
||
| ```GraphQL | ||
| enum CreationErrorEntity { | ||
| DURATIONCANNOTBEZERO | ||
| INVALIDACCEPTANCEPERCENTAGE | ||
| } | ||
| enum InitializationErrorEntity { | ||
| CANNOTREINITIALIZE | ||
| CONTRACTNOTINITIALIZED | ||
| } | ||
| enum ProposalErrorEntity { | ||
| INSUFFICIENTAPPROVALS | ||
| PROPOSALEXECUTED | ||
| PROPOSALEXPIRED | ||
| PROPOSALSTILLACTIVE | ||
| } | ||
| enum UserErrorEntity { | ||
| AMOUNTCANNOTBEZERO | ||
| INCORRECTASSETSENT | ||
| INSUFFICIENTBALANCE | ||
| INVALIDID | ||
| VOTEAMOUNTCANNOTBEZERO | ||
| } | ||
| type CallDataEntity { | ||
| id: ID! | ||
| arguments: U64! | ||
| function_selector: U64! | ||
| } | ||
| type CreateProposalEventEntity { | ||
| id: ID! | ||
| proposal_info: ProposalInfoEntity! | ||
| } | ||
| type DepositEventEntity { | ||
| id: ID! | ||
| amount: U64! | ||
| user: Identity! | ||
| } | ||
| type ExecuteEventEntity { | ||
| id: ID! | ||
| acceptance_percentage: U64! | ||
| user: Identity! | ||
| } | ||
| type InitializeEventEntity { | ||
| id: ID! | ||
| author: Identity! | ||
| token: ContractId! | ||
| } | ||
| type ProposalEntity { | ||
| id: ID! | ||
| amount: U64! | ||
| asset: ContractId! | ||
| call_data: CallDataEntity! | ||
| gas: U64! | ||
| } | ||
| type ProposalInfoEntity { | ||
| id: ID! | ||
| acceptance_percentage: U64! | ||
| author: Identity! | ||
| deadline: U64! | ||
| executed: Boolean! | ||
| no_votes: U64! | ||
| proposal_transaction: ProposalEntity! | ||
| yes_votes: U64! | ||
| } | ||
| type UnlockVotesEventEntity { | ||
| id: ID! | ||
| user: Identity! | ||
| vote_amount: U64! | ||
| } | ||
| type VoteEventEntity { | ||
| id: ID! | ||
| user: Identity! | ||
| vote_amount: U64! | ||
| } | ||
| type VotesEntity { | ||
| id: ID! | ||
| no_votes: U64! | ||
| yes_votes: U64! | ||
| } | ||
| type WithdrawEventEntity { | ||
| id: ID! | ||
| amount: U64! | ||
| user: Identity! | ||
| } | ||
| ``` |