Skip to content

Add Blaze SDK + Yaci Store integration guide#186

Open
danbaruka wants to merge 2 commits intoIntersectMBO:mainfrom
danbaruka:docs/blaze-yaci-store-integration
Open

Add Blaze SDK + Yaci Store integration guide#186
danbaruka wants to merge 2 commits intoIntersectMBO:mainfrom
danbaruka:docs/blaze-yaci-store-integration

Conversation

@danbaruka
Copy link
Member

Description

This PR adds a technical integration guide for using Yaci Store as a local Blockfrost-compatible indexer with Blaze SDK on Cardano, under a new "Integration Guides" section in the docs. This is collaborative documentation between the Developer Advocate team, the Yaci team, and the Blaze SDK team.

  • What problem does this PR solve? Developers need clear documentation on how to use Yaci Store as a local provider for Blaze SDK (Blockfrost-compatible API), including architecture, configuration, and trade-offs.
  • What is the purpose of this change? To document the Blaze + Yaci Store setup (flow, config, advantages, limitations) and point to official Blaze and Yaci DevKit resources, as part of the DevEx collaboration with the Blaze and Yaci teams.

Related Issue

N/A (or link an issue if one exists).

Type of Change

Check the type of change this PR introduces:

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor (improves code structure or readability without changing functionality)
  • Other (please describe):

Changes Made

  • New: docs/guides/_category_.yml — "Integration Guides" category (sidebar position 12).
  • New: docs/guides/blaze-yaci-store-integration.md — Technical guide with:
    • Architecture and data flow (App → Blaze → Yaci Store → node) and Mermaid diagrams.
    • Prerequisites and configuration (Yaci Store base URL http://localhost:8080/api/v1, Blaze Blockfrost provider, env vars).
    • Interactions table (UTXOs, tx submission, protocol params) and end-to-end flow.
    • Advantages (local control, same API surface, fast dev/CI, cost, ecosystem alignment).
    • Limitations (operational overhead, API/CORS).
    • Compatibility notes and references (Blaze docs, Yaci DevKit, Docker setup).

Checklist

Ensure you have completed the following steps before submitting your PR:

  • My code follows the project's coding style and guidelines.
  • I have performed a self-review of my own code.
  • I have commented my c

- Revised description for clarity and consistency.
- Improved explanation of the integration flow between Blaze SDK, Yaci Store, and Cardano node.
- Added sections on advantages and limitations of using Yaci Store as a local Blockfrost-compatible indexer.
- Updated references formatting for better readability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Medium Priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant