Class BalanceProjectionFilter
Projection toggle on the balance query parameter —
controls whether the mirror node includes balance information
in each returned record. Implements IMirrorProjection
rather than IMirrorFilter: it does not narrow
which records are returned, only reshapes each response payload.
Inherited Members
Namespace: Hiero.Mirror.Filters
Assembly: Hiero.dll
Syntax
public sealed class BalanceProjectionFilter : IMirrorProjection, IMirrorQueryParameter
Remarks
The mirror-node default is balance=true; passing
Exclude opts out to reduce payload size when
the caller doesn't need the balance subtree. When balance is
included, token balances within it are capped at 50 entries
per account per HIP-367.
This is the first concrete IMirrorProjection implementation in the SDK; the marker interface was introduced in Phase 2 for exactly this category of wire parameter.
Fields
| Edit this page View SourceExclude
Omit the balance subtree from each returned record.
Declaration
public static readonly BalanceProjectionFilter Exclude
Field Value
| Type | Description |
|---|---|
| BalanceProjectionFilter |
Include
Include the balance subtree in each returned record (the server's default behavior — explicit here for call-site clarity).
Declaration
public static readonly BalanceProjectionFilter Include
Field Value
| Type | Description |
|---|---|
| BalanceProjectionFilter |
Properties
| Edit this page View SourceName
The query parameter name recognized by the remote mirror node.
Declaration
public string Name { get; }
Property Value
| Type | Description |
|---|---|
| string |
Value
The value of the query parameter sent to the mirror node.
Declaration
public string Value { get; }
Property Value
| Type | Description |
|---|---|
| string |