Add NEAR to the Docs on Substreams.dev #699
Open
+57
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create new NEAR tutorial following TRON pattern - Add NEAR to intro-to-tutorials.md navigation - Add NEAR to SUMMARY.md table of contents - Reference existing NEAR infrastructure (endpoints, dev kit, example repo) - Note that NEAR templates for substreams init are coming soon
maoueh
requested changes
Oct 23, 2025
docs/new/tutorials/near.md
Outdated
Comment on lines
10
to
25
| ## Step 1: Initialize Your NEAR Substreams Project | ||
|
|
||
| 1. [Install the Substreams CLI](../how-to-guides/cli/installing-the-cli.md). | ||
|
|
||
| 2. Currently, NEAR project templates are being developed for the `substreams init` command. In the meantime, you can get started with NEAR Substreams by cloning the existing example: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/streamingfast/substreams-near-hello-world.git | ||
| cd substreams-near-hello-world | ||
| ``` | ||
|
|
||
| This example demonstrates how to extract and process NEAR blockchain data using the [NEAR Full block](https://github.com/streamingfast/firehose-near/blob/develop/proto/sf/near/type/v1/type.proto) as input. | ||
|
|
||
| {% hint style="info" %} | ||
| **Coming Soon**: NEAR project templates will be available through `substreams init` in a future release, similar to other supported blockchains. | ||
| {% endhint %} |
There was a problem hiding this comment.
Change that to leverage substreams init, it will be ready once we publish it, no need to wait for an intermediate version.
On it! I'll update the docs to leverage
substreams initas requested. 🚀💻 View my work • 🛑 Stop
There was a problem hiding this comment.
I'll update the guide to use substreams init as suggested... 🛠️
💻 View my work • 🛑 Stop
There was a problem hiding this comment.
✅ Updated! I've modified the NEAR tutorial to leverage substreams init directly instead of the interim approach.
The tutorial now follows the TRON pattern more closely:
- Removed the manual
git cloneapproach - Updated to use
substreams initwith the near-hello-world template option - Removed the "Coming Soon" hint since the templates will be ready when published
🔄 View Updated PR #699 on Github 🔄
The changes are now pushed and ready for review! 🎯
💻 View my work • 🛑 Stop • React 👍 or 👎
- Remove interim approach with manual git clone - Update to use substreams init with near-hello-world template - Follow TRON tutorial pattern more closely - Remove 'Coming Soon' hint as templates will be ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds NEAR blockchain support to the Substreams documentation, following the same pattern as the existing TRON tutorial (PR #646).
Changes Made
New Tutorial File
docs/new/tutorials/near.md: Complete NEAR tutorial following the established patternsubstreams-near-hello-worldexamplesubstreams initare coming soonNavigation Updates
docs/new/tutorials/intro-to-tutorials.md: Added NEAR to the blockchain listdocs/SUMMARY.md: Added NEAR to the table of contentsNEAR Infrastructure Referenced
The tutorial leverages existing NEAR support:
mainnet.near.streamingfast.io:443andtestnet.near.streamingfast.io:443sf.near.type.v1.BlockFuture Enhancements
The tutorial notes that NEAR project templates for
substreams initare being developed and will be available in a future release, similar to other supported blockchains.Closes BLO-731
💻 View my work • 👤 Initiated by
Josh Kauffman• About Codegen⛔ Remove Codegen from PR • 🚫 Ban action checks