TIP-26 UTXO Indexer REST API

[lzpap]

UTXO Indexer REST API specification for the Stardust update.

Complements #57 by exposing UTXO specific routes from an opt-in node indexer plugin or standalone application:

• api/indexer/v1/outputs/basic: for fetching Basic Outputs
• api/indexer/v1/outputs/alias: for fetching Alias Outputs
• api/indexer/v1/outputs/foundry: for fetching Foundry Outputs
• api/indexer/v1/outputs/nft: for fetching NFT Outputs

All routes support additional query parameters to filter outputs based on content. The output objects can be fetched from the core API based on the returned outputIds.

Rendered document

[Thoralf-M]

For /api/plugins/indexer/v1/nfts/{nftId} the example shows

{
  "data": {
    "ledgerIndex": 101,
    "limit": 1000,
    "count": 1,
    "outputIds": [
      "0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000"
    ]
  }
}

but hornet currently returns

{"ledgerIndex":83,"count":1,"data":["1784a3ca7578c0154dff9b6eab231adb136520c56df365b914a715a9c2d4653c0000"]}

without the limit
What needs to be changed?

[Thoralf-M]

Extended outputs need to be renamed to basic outputs

[lzpap]

Extended outputs need to be renamed to basic outputs

Done!

[grtlr]

Is the length of the example correct here? confirmationMs should be 8 digits and outputId should be 68 digits. So everything up until the . should be 76 digits, but it's only 68 digits long.

[lzpap]

You are right, the examples need to be updated with realisitc values from an actual network.

[Alex6323]

Aaah, Germans

[jorgemmsilva]

api/indexer/v1/outputs: for fetching Basic Outputs

imo this should be renamed to api/indexer/v1/basicoutputs. so It is explicit that it will only query basic outputs.

---

related to that, could we have api/indexer/v1/outputs to query for ANY output, regardless of type?
search criteria being "any UTXO that can be unlocked by a given address"