Skip to content

Interface: iCollectionIndexDoc<T>

Denormalized, indexed record powering the server-side collection-index query (filter/sort/search/facets/paginate over Mongo). ONE doc per (collection × indexed…

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:287

Denormalized, indexed record powering the server-side collection-index query (filter/sort/search/facets/paginate over Mongo). ONE doc per (collection × indexed standard); _docId = ${collectionId}:${standard}``. A collection declaring N indexable standards has N rows. Maintained in real time by the indexer's tx-handlers from the standards-info builder projections, so the client derives nothing. The /pay dashboard is the first consumer (scopes by standard); prediction-market/auction/etc. dashboards reuse the same shape.

Extends

Type Parameters

T

T extends NumberType

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from

Doc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from

Doc._id

amountStr?

optional amountStr?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:310

Headline money amount (exact bigint string), denom paired below — for display.

collectionId

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:289

The collection ID (this row is one of the collection's indexed standards).

createdBlock

createdBlock: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:321

Creation block (cursor sort key, mirrors createdTokens).

createdBy

createdBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:291

Creator bech32 address — dashboards scope per-creator.

createdTimestamp

createdTimestamp: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:323

Creation timestamp (unix ms).

denom?

optional denom?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:312

Headline denom (invoice/sub price/product 'from'/vault backing).

endTime?

optional endTime?: number

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:314

Deadline in unix ms (0/absent = none); used for the query-time expiry rule.

extras?

optional extras?: unknown

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:319

The standard's full computed standardsInfo blob, carried for display.

image

image: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:301

Collection image URI (for the dashboard avatar; '' until metadata lands).

lastSyncedBlock

lastSyncedBlock: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:325

Block this record was last rebuilt at (reorg/idempotency guard).

name

name: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:297

Collection display name (from metadata; '' until the async fetch lands).

nameLower

nameLower: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:299

Lowercased name for case-insensitive search/sort.

payerAddress?

optional payerAddress?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:316

Counterparty addresses (e.g. PaymentRequest payer/recipient) for role filtering.

recipientAddress?

optional recipientAddress?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:317

standard

standard: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:293

THE standard this row represents (the row's primary filter key).

standards

standards: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:295

ALL standards the collection declares (for "is also an X" cross-filtering).

status?

optional status?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:308

Durable, tx-derived status enum (per standard). Clock-only transitions (e.g. PaymentRequest pending → expired past its deadline) are NOT persisted here — they are applied at query time from endTime + the standard's expiry rule so they never go stale without a tx.

Edit this page on GitHub