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.

Sign up for GitHub

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

docs: Update ASSETS.md #617

Closed
wants to merge 1 commit into from
Closed

docs: Update ASSETS.md #617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/graphql/ASSETS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,36 @@ the result contains a JSON with the asset information, here are the details abou
| verified | true if asset is in Fuel's verified assets list |
| owner | Current assetId owner (NFTs only) |
| uri | Parsed URL from “metadata.uri” or “metadata.URI”. Some [logic](https://github.com/FuelLabs/fuel-ex-demo/blob/ee73408a0ef0323eeb92414d5ed92d65e3f3f78f/packages/graphql/src/infra/gateway/AssetGateway.ts#L63-L95) is applied to try defining a reasonable uri for the API consumer |

### Instructions for consuming Assets data owned by an Account from Indexer API

API endpoint:
`/accounts/<address>/assets?last=<size>` - get assets owned by an account (including NFTs)

URLs to consume:
- Mainnet: https://mainnet-explorer.fuel.network
- Testnet: https://explorer-indexer-testnet.fuel.network


`curl` example of usage
```
curl 'https://mainnet-explorer.fuel.network/accounts/0x196a68Ba237e921FeC5F01552E5e4df60b2619900254DD4cDe42557814508F57/assets?last=10'
```


the result contains a JSON with an array of asset information and balance of each asset, here are the details about each prop:
| Property | Description |
|----------|-------------|
| balance | Balance of the asset owner by account |
| assetId | Actual ID of the asset |
| contractId | Contract ID that minted the asset |
| subId | SubId used to calculate the assetId |
| name | Asset name |
| symbol | Asset symbol |
| decimals | Asset decimals configuration |
| suspicious | true if symbol matches any verified asset symbols |
| metadata | Key-value object with SRC7/SRC9 standard metadata |
| isNFT | true if asset is NFT ( [supply=1, decimals=0](https://docs.fuel.network/docs/sway-standards/src-20-native-asset/#non-fungible-asset-restrictions) )|
| verified | true if asset is in Fuel's verified assets list |
| owner | Current assetId owner (NFTs only) |
| uri | Parsed URL from “metadata.uri” or “metadata.URI”. Some [logic](https://github.com/FuelLabs/fuel-ex-demo/blob/ee73408a0ef0323eeb92414d5ed92d65e3f3f78f/packages/graphql/src/infra/gateway/AssetGateway.ts#L63-L95) is applied to try defining a reasonable uri for the API consumer |
Loading