Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.near.org/llms.txt

Use this file to discover all available pages before exploring further.

NEAR Lake is an indexer built on top of NEAR Indexer Framework to watch the network and store all the event logs such as FT Events and NFT Events as JSON files on AWS S3.
GitHub repoYou can find the Lake Indexer source code in this GitHub repository.

​
Data structure

The data structure used by Lake Indexer is the following: 
    <block_height>/
      block.json
      shard_0.json
      shard_1.json
      ...
      shard_N.json
<block_height> is a 12-character-long u64 string with leading zeros (e.g “000042839521”). See this issue for reasoning. block_json contains JSON-serialized BlockView struct. NB! this struct might change in the future, we will announce it shard_N.json where N is u64 starting from 0. Represents the index number of the shard. In order to find out the expected number of shards in the block you can look in block.json at .header.chunks_included

​
How to use it

We have created the NEAR Lake Framework to have a simple straightforward way to create an indexer on top of the data stored by NEAR Lake itself.
NEAR Lake FrameworkYou can check the NEAR Lake Framework release announcement on the NEAR Governance Forum.
We have prepared this video tutorial with a simple example to give you an overview and some practical ideas.