Namespace Hiero.Mirror.Filters

Classes

AccountBalanceFilter

Predicate filter on the account.balance query parameter used by the account-list and balance-snapshot endpoints. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

AccountFilter

Predicate filter on the account.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

AccountPublicKeyFilter

Predicate filter on the account.publickey query parameter used by the account-list and balance-snapshot endpoints. Matches accounts whose root public key equals the given endorsement.

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.

BlockHashFilter

Predicate filter on the block.hash query parameter of the contract-results endpoints (/api/v1/contracts/results, /api/v1/contracts/{id}/results). Scopes the returned results to a single block by its hash.

BlockNumberFilter

Predicate filter on the block.number query parameter of the /api/v1/blocks and contract-results endpoints. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

ContractActionIndexFilter

Predicate filter on the index position of a contract action within a transaction's ordered call graph. Construct via one of the static factories — the ctor is private so the operator is always explicit in the call site.

ContractFilter

Predicate filter on the contract.id query parameter of the /api/v1/contracts list endpoint. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

ContractLogIndexFilter

Predicate filter on the index query parameter of the two contract-log list endpoints — /api/v1/contracts/results/logs and /api/v1/contracts/{contractIdOrAddress}/results/logs. Narrows results to contract-log entries at a specific block-local position (or to a comparison range thereof). Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

EvmSenderFilter

Predicate filter on the from query parameter of the contract-results endpoints — the EVM sender (msg.sender) of a contract call, as a 20-byte EVM address. Construct via Is(EvmAddress); the ctor is private.

EvmTopicFilter

Predicate filter on an EVM event-log topic position (topic0 … topic3) on the contract-logs endpoints. Construct via Is(int, BigInteger); the ctor is private.

FileFilter

Predicate filter on the file.id query parameter of the /api/v1/network/nodes endpoint — filters the consensus-node listing to nodes registered in a specific address-book file (typically 0.0.101 or 0.0.102). Construct via Is(EntityId); the ctor is private.

HbarTransferProjectionFilter

Projection toggle on the hbar query parameter — controls whether the mirror node includes the HBAR-transfer subtree in each returned contract-result record. Implements IMirrorProjection: it does not narrow which records are returned, only reshapes each response payload.

InternalProjectionFilter

Projection toggle on the internal query parameter — controls whether the mirror node includes child (internal) transactions alongside top-level results. Implements IMirrorProjection: reshapes each listing's inclusion rather than narrowing which records are returned.

MessageEncodingProjectionFilter

Projection toggle on the encoding query parameter — controls how the mirror node encodes each HCS topic message's payload in the returned JSON. Implements IMirrorProjection: it does not narrow which records are returned, only reshapes each response payload.

NodeFilter

Predicate filter on the node.id query parameter of the /api/v1/network/nodes endpoint. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

OpcodeMemoryProjectionFilter

Projection toggle on the memory query parameter — controls whether the mirror node populates each Memory array in an opcode-trace response. Implements IMirrorProjection: it reshapes each record, not which records are returned.

OpcodeStackProjectionFilter

Projection toggle on the stack query parameter — controls whether the mirror node populates each Stack array in an opcode-trace response. Implements IMirrorProjection: it reshapes each record, not which records are returned.

OpcodeStorageProjectionFilter

Projection toggle on the storage query parameter — controls whether the mirror node populates each Storage dictionary in an opcode-trace response. Implements IMirrorProjection: it reshapes each record, not which records are returned.

PublicKeyFilter

Predicate filter on the publickey query parameter of the /api/v1/tokens list endpoint. Matches tokens whose admin / supply / wipe / etc. key equals the given public key.

ReceiverFilter

Predicate filter on the receiver.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

ResultFilter

Predicate filter on the result query parameter of the /api/v1/transactions list endpoint — restricts the listing to successful or unsuccessful transactions.

ScheduleFilter

Predicate filter on the schedule.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

SenderFilter

Predicate filter on the sender.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

SequenceNumberFilter

Predicate filter on the sequence number of an HCS topic message. Construct via one of the static factories — the ctor is private so the operator is always explicit in the call site.

SerialNumberFilter

Predicate filter on the serialnumber query parameter used by the NFT-listing endpoints. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

SlotFilter

Predicate filter on the slot query parameter for contract state reads. The wire format is a 32-byte 0x-prefixed hex string. Construct via Is(BigInteger); the ctor is private.

SpenderFilter

Predicate filter on the spender.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

TimestampFilter

Predicate filter on the consensus timestamp of a mirror node record. Construct via one of the static factories — the ctor is private so the operator is always explicit in the call site.

TokenFilter

Predicate filter on the token.id query parameter. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

TokenNameFilter

Predicate filter on the name query parameter of the /api/v1/tokens list endpoint. Matches tokens whose name contains the given substring (partial match).

TokenTypeFilter

Predicate filter on the type query parameter of the /api/v1/tokens list endpoint — restricts the listing to fungible, non-fungible, or (default) all tokens.

TransactionHashFilter

Predicate filter on the transaction.hash query parameter of the cross-contract logs endpoint (/api/v1/contracts/results/logs). Scopes the returned log events to a single transaction without needing to know which contract emitted them.

TransactionIndexFilter

Predicate filter on the transaction.index query parameter — narrows contract-result listings to the given in-block position. Construct via Is(int); the ctor is private.

TransactionTypeFilter

Predicate filter on the transactiontype query parameter of the /api/v1/transactions list endpoint — narrows the listing to transactions of a particular HAPI type.

TransferDirectionFilter

Predicate filter on the type query parameter of the /api/v1/transactions list endpoint — narrows the listing to transactions that credit or debit the filtered account.

Interfaces

IMirrorFilter

Marker interface for query parameters that act as predicates — they narrow the result set returned by the mirror node (for example, "where account.id equals this value" or "where timestamp is strictly greater than this consensus time").

IMirrorPaging

Marker interface for query parameters that control paging or ordering of results — they do not change which records the mirror node returns, only the page size, sort direction, or cursor position.

IMirrorProjection

Marker interface for query parameters that reshape the response rather than filter or page it — for example, toggling whether a balance snapshot is included, selecting a transaction-type enum, or asking the mirror node for an opcode-trace sub-section (stack / memory / storage).

IMirrorQueryParameter

Represents a single parameter appended to a Mirror Node REST query string. Covers three conceptual kinds — predicate filters, paging directives, and projection toggles — distinguished by the marker sub-interfaces (see Phase 2 of the refactor).