Index API

DijetsNodeGo can be configured to run with an indexer. That is, it saves (indexes) every container (a block, vertex or transaction) it accepts on the Value Chain, Method Chain and Utility Chain. To run DijetsNodeGo with indexing enabled, set command line flag --index-enabled to true. DijetsNodeGo will only index containers that are accepted when running with --index-enabled set to true. To ensure your node has a complete index, run a node with a fresh database and --index-enabled set to true. The node will accept every block, vertex and transaction in the network history during bootstrapping, ensuring your index is complete. It is OK to turn off your node if it is running with indexing enabled. If it restarts with indexing still enabled, it will accept all containers that were accepted while it was offline. The indexer should never fail to index an accepted block, vertex or transaction.

Indexed containers (that is, accepted blocks, vertices and transactions) are timestamped with the time at which the node accepted that container. Note that if the container was indexed during bootstrapping, other nodes may have accepted the container much earlier. Every container indexed during bootstrapping will be timestamped with the time at which the node bootstrapped, not when it was first accepted by the network.

Note that for DAGs (including the Value Chain), nodes may accept vertices and transactions in a different order from one another.

If --index-enabled is changed to false from true, Dijets Node won't start as doing so would cause a previously complete index to become incomplete, unless the user explicitly says to do so with --index-allow-incomplete. This protects you from accidentally running with indexing disabled, after previously running with it enabled, which would result in an incomplete index.

This document shows how to query data from Dijets Node's Index API. The Index API is only available when running with --index-enabled.

Go Client#

There is a Go implementation of an Index API client. This client can be used inside a Go program to connect to a Dijets node instance that is running with the Index API enabled and make calls to the Index API.

Format#

This API uses the json 2.0 RPC format. For more information on making JSON RPC calls, see here.

Endpoints#

Each chain has one or more index. To see if a Utility Chain block is accepted, for example, send an API call to the Utility Chain block index. To see if an Value Chain vertex is accepted, for example, send an API call to the Value Chain vertex index.

Utility Chain Blocks#

Method Chain Blocks#

Value Chain Transactions#

Value Chain Azimuth IDs#

Methods#

index.getContainerByID#

Get container by ID.

Signature:

Request:

• id is the container's ID
• encoding is "hex" only.

Response:

• id is the container's ID
• bytes is the byte representation of the container
• timestamp is the time at which this node accepted the container
• encoding is "hex" only.
• index is how many containers were accepted in this index before this one

Example Call:

Example Response:

index.getContainerByIndex#

Get container by index. The first container accepted is at index 0, the second is at index 1, etc.

Signature:

Request:

• index is how many containers were accepted in this index before this one
• encoding is "hex" only.

Response:

• id is the container's ID
• bytes is the byte representation of the container
• timestamp is the time at which this node accepted the container
• index is how many containers were accepted in this index before this one
• encoding is "hex" only.

Example Call:

Example Response:

index.getContainerRange#

Returns the transactions at index [startIndex], [startIndex+1], ... , [startIndex+n-1]

• If [n] == 0, returns an empty response (for example: null).
• If [startIndex] > the last accepted index, returns an error (unless the above apply.)
• If [n] > [MaxFetchedByRange], returns an error.
• If we run out of transactions, returns the ones fetched before running out.
• numToFetch must be in [0,1024].

Signature:

Request:

• startIndex is the beginning index
• numToFetch is the number of containers to fetch
• encoding is "hex" only.

Response:

• id is the container's ID
• bytes is the byte representation of the container
• timestamp is the time at which this node accepted the container
• encoding is "hex" only.
• index is how many containers were accepted in this index before this one

Example Call:

Example Response:

index.getIndex#

Get a container's index.

Signature:

Request:

• id is the ID of the container to fetch
• encoding is "hex" only.

Response:

• index is how many containers were accepted in this index before this one

Example Call:

Example Response:

index.getLastAccepted#

Get the most recently accepted container.

Signature:

Request:

• encoding is "hex" only.

Response:

• id is the container's ID
• bytes is the byte representation of the container
• timestamp is the time at which this node accepted the container
• encoding is "hex" only.

Example Call:

Example Response:

index.isAccepted#

Returns true if the container is in this index.

Signature:

Request:

• id is the ID of the container to fetch
• encoding is "hex" only.

Response:

• isAccepted displays if the container has been accepted

Example Call:

Example Response: