Skip to content

doc update: Indexer v3#626

Open
gyrationtechs wants to merge 4 commits intomainfrom
feat/indexer-v3-doc-update
Open

doc update: Indexer v3#626
gyrationtechs wants to merge 4 commits intomainfrom
feat/indexer-v3-doc-update

Conversation

@gyrationtechs
Copy link
Contributor

@vercel
Copy link

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
midnight-wiki Ready Ready Preview, Comment Feb 13, 2026 11:09am

Request Review

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

🚀 Preview Deployment

Deployment Ready

🔗 Preview URL: https://pr-626-midnight-docs.vercel.app

📝 Latest commit: 3e7eabb
Updated: Feb 13, 2026, 11:08 AM UTC


This preview updates automatically when you push new commits to this PR.

@gyrationtechs
Copy link
Contributor Author

@DianaHackmamba Thanks for the feedback. Changes have been implemented.

Ps: I replaced the v1 schema file in the static folder on the docs repo with the latest v3 schema


Subscribes to unshielded transaction events for a specific address. Emits events whenever transactions involve unshielded UTXOs for the given address.

**Parameters**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use bold text as headings. Apply throughout.

### Regenerating the Schema
## Regenerate the schema

If you're using the Indexer API and modify the code defining the GraphQL schema, you'll need to regenerate the schema file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you're using the Indexer API and modify the code defining the GraphQL schema, you'll need to regenerate the schema file.
If you're using the Indexer API and modify the code defining the GraphQL schema, then you'll need to regenerate the schema file.

## Example queries and mutations

:::note
These are examples only. Refer to the [schema file](https://github.com/midnightntwrk/midnight-indexer/blob/release/3.0.0/indexer-api/graphql/schema-v3.graphql) to confirm exact field names and structures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To..., refer....

:::

**Example:**
**Example (by hash)**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use bold text as headings. Apply throughout.

```

**Example (by block height):**
**Example (by block height)**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrite these without parentheses.


The `currentCapacity` field represents the maximum DUST generation capacity based on the Night UTXO balance and elapsed time. This value:
- Is accurate until the first DUST fee payment.
- May be higher than actual balance after fee payments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- May be higher than actual balance after fee payments.
- Might be higher than actual balance after fee payments.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Periods are not needed in this list.


All contract action types include an `unshieldedBalances` field that returns the token balances held by the contract:

- **ContractDeploy**: Always returns empty balances (contracts are deployed with zero balance).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrite the list without parentheses.

All contract action types include an `unshieldedBalances` field that returns the token balances held by the contract:

- **ContractDeploy**: Always returns empty balances (contracts are deployed with zero balance).
- **ContractCall**: Returns balances after the call execution (may be modified by `unshielded_inputs`/`unshielded_outputs`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **ContractCall**: Returns balances after the call execution (may be modified by `unshielded_inputs`/`unshielded_outputs`).
- **ContractCall**: Returns balances after the call execution (might be modified by `unshielded_inputs`/`unshielded_outputs`).

### DustGenerationStatus

DUST generation status for a Cardano stake key:
- `cardanoRewardAddress`: The Bech32-encoded Cardano stake address (e.g., stake_test1... or stake1...)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use e.g. Rewrite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants