NEAR Indexer Framework 0.9.0 Release notes

[khorolets]

This version expected to be included in the nearcore release of version 1.19. Please, update your indexers before the next Protocol Version upgrade land to the network (the current Protocol Version is 44).

We recommend to use this commit hash for nearcore dependency of your indexer
Commit hash 379f87e5dd5d3c1e798baf164068e0a0517fdcfc

See CHANGELOG for brief information about the changes.

Here I'll try to provide information about the migration to version 0.9.0 from 0.8.1

The most important change is that we've introduced a new structure IndexerShard now contains chunks and execution outcomes.

The structure of StreamerMessage has changed:

• field chunks: Vec<IndexerChunkView> was replaced with shards: Vec<IndexerShard>

StreamerMessage changes

If in your indexer you were iterating over the chunks to get transactions, receipts or execution outcomes for receipts you'll need to change the iterator:

BEFORE

for chunk in streamer_message.chunks {
    for transaction in chunk.transactions { ... }
    for receipt in chunk.receipts { ... }
    for execution_outcome in chunk.receipt_execution_outcomes { ... }
}

AFTER

for shard in streamer_message.shards {
    // Chunk is Option<IndexerChunkView> as NEAR protocol sharding design tolerates missing 
    // blocks and chunks in blocks, so it is totally fine when a shard does not have a chunk
    if let Some(chunk) = shard.chunk {
        for transaction in chunk.transactions { ... }
        for receipt in chunk.receipts { ... }
    }

    // Execution outcomes for receipts belongs to shard but not to chunk as we had it before
    // two blocks on the mainnet missed chunks yet contained execution outcomes
    // fixed (https://github.com/near/nearcore/pull/4228)
    // However we decided to explicitly show shard structure so this makes our data representation closer to the protocol
    for execution_outcome in shard.receipt_execution_outcomes { ... }
}

IndexerExecutionOutcomeWithReceipt changes

Previously (before 0.9.0) we use the same structure for transaction execution outcomes and for receipt ones. It was IndexerExecutionOutcomeWithReceipt since 0.9.0 we've separate structures.

So IndexerTransactionWithOutcome uses IndexerExecutionOutcomeWithOptionalReceipt which correspondingly contains optional receipt field.

And original IndexerExecutionOutcomeWithReceipt field receipt is not optional anymore.

So if you had been using something like:

if let Some(receipt) = transaction.outcome.receipt { ... }

You should use:

let receipt = transaction.outcome.receipt;

That's pretty much all the changes on the usage side of things.

If you have any questions according to the migration or the release of NEAR Indexer Framework 0.9.0 feel free to ask it here in the comments.