Skip to content

IIP5: update API result examples #30

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

Open
Thoralf-M wants to merge 4 commits into
base: main
Choose a base branch
from
Open

IIP5: update API result examples #30

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ef6931
IIP5: update API result examples
Thoralf-M Jan 19, 2026
90e4180
Fix argument order
Thoralf-M Jan 19, 2026
cae91fa
fix graphql query example
Thoralf-M Jan 19, 2026
728c7d8
fix graphql type names
Thoralf-M Jan 19, 2026
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
55 changes: 30 additions & 25 deletions iips/IIP-0005/iip-0005.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ The following example can be taken as a reference for the API model.
"functionName": "0x5e7a300e640f645a4030aeb507c7be16909e6fa9711e7ca2d4397bbd967d5c50::auction::get_auction_metadata",
"typeArgs": [],
"arguments": [
"auc.iota",
"0x31deb8cbd320867089d52c37fed2d443520aac0fc5a957de1f64f9135b83f42b"
"0x31deb8cbd320867089d52c37fed2d443520aac0fc5a957de1f64f9135b83f42b",
"auc.iota"
]
}
}
Expand All @@ -81,12 +81,16 @@ The following example can be taken as a reference for the API model.

```json
{
"results": [
"start": "447575403174913",
"end": "447576324774913",
"address": "0xc9f649324694c0c18c6278c3a81945fb3ef0c9b91f21dd5b6a4364447ee348df",
"value": "500000000"
]
"jsonrpc": "2.0",
"id": 0,
"result": {
"functionReturnValues": [
"1748341418652",
"1748345018652",
"0xc9f649324694c0c18c6278c3a81945fb3ef0c9b91f21dd5b6a4364447ee348df",
"500000000"
]
}
}
```

Expand All @@ -95,26 +99,26 @@ The following example can be taken as a reference for the API model.
A new GraphQL read query is added to the IOTA GraphQL RPC interface with the following structure:

```graphql
view(
moveViewCall(
functionName: String!
typeArguments: [String]
arguments: [String]
): ViewResults!
): MoveViewResult!
```

#### Example

Query:

```graphql
view(
functionName: "0x5e7a300e640f645a4030aeb507c7be16909e6fa9711e7ca2d4397bbd967d5c50::auction::get_auction_metadata"
typeArgs: []
arguments: [ "auc.iota", "0x31deb8cbd320867089d52c37fed2d443520aac0fc5a957de1f64f9135b83f42b"]
) {
errors
results {
json
{
moveViewCall(
functionName: "0x5e7a300e640f645a4030aeb507c7be16909e6fa9711e7ca2d4397bbd967d5c50::auction::get_auction_metadata"
typeArgs: []
arguments: ["0x31deb8cbd320867089d52c37fed2d443520aac0fc5a957de1f64f9135b83f42b", "auc.iota"]
) {
error
results
}
}
```
Expand All @@ -124,13 +128,14 @@ Response:
```graphql
{
"data": {
"view": {
"results": {
"start": "447575403174913",
"end": "447576324774913",
"address": "0xc9f649324694c0c18c6278c3a81945fb3ef0c9b91f21dd5b6a4364447ee348df",
"value": "500000000"
}
"moveViewCall": {
"error": null,
"results": [
"1748341418652",
"1748345018652",
"0xc9f649324694c0c18c6278c3a81945fb3ef0c9b91f21dd5b6a4364447ee348df",
"500000000"
]
}
}
}
Expand Down