Skip to content

Interface: iBitBadgesCollection<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:102

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

iCollectionDoc._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

iCollectionDoc._id

activity

activity: iTransferActivityDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:116

The fetched activity for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

aliasPaths

aliasPaths: iAliasPathWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:156

The alias (non-wrapping) paths for the collection, with off-chain metadata populated.

Overrides

iCollectionDoc.aliasPaths

approvalTrackers

approvalTrackers: iApprovalTrackerDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:122

The fetched approval trackers for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

challengeTrackers

challengeTrackers: iMerkleChallengeTrackerDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:120

The fetched merkle challenge trackers for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

claims

claims: iClaimDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:144

Details about any off-chain claims for this collection. Only applicable when outsourced to BitBadges.

collectionApprovals

collectionApprovals: iCollectionApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:104

The collection approvals for this collection, with off-chain metadata populated.

Overrides

iCollectionDoc.collectionApprovals

collectionId

collectionId: string

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

The collection ID

Inherited from

iCollectionDoc.collectionId

collectionMetadata

collectionMetadata: iCollectionMetadata

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:109

The collection metadata for this collection, with off-chain metadata populated.

Overrides

iCollectionDoc.collectionMetadata

collectionPermissions

collectionPermissions: iCollectionPermissionsWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:106

The collection permissions for this collection, with off-chain metadata populated.

Overrides

iCollectionDoc.collectionPermissions

cosmosCoinWrapperPaths

cosmosCoinWrapperPaths: iCosmosCoinWrapperPathWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:153

The IBC wrapper paths for the collection, with off-chain metadata populated.

Overrides

iCollectionDoc.cosmosCoinWrapperPaths

createdBlock

createdBlock: T

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

The block number when this collection was created

Inherited from

iCollectionDoc.createdBlock

createdBy

createdBy: string

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

The BitBadges address of the user who created this collection

Inherited from

iCollectionDoc.createdBy

createdTimestamp

createdTimestamp: T

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

The timestamp when this collection was created (milliseconds since epoch)

Inherited from

iCollectionDoc.createdTimestamp

customData

customData: string

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

The custom data

Inherited from

iCollectionDoc.customData

defaultBalances

defaultBalances: iUserBalanceStoreWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:114

The default balances for users upon genesis, with off-chain metadata populated.

Overrides

iCollectionDoc.defaultBalances

invariants

invariants: iCollectionInvariantsWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:159

Collection-level invariants with EVM query challenge metadata populated (WithDetails).

Overrides

iCollectionDoc.invariants

isArchived

isArchived: boolean

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

The is archived flag

Inherited from

iCollectionDoc.isArchived

listings

listings: iUtilityPageDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:125

The listings for this collection.

manager

manager: string

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

The manager

Inherited from

iCollectionDoc.manager

mintEscrowAddress

mintEscrowAddress: string

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

Mint escrow address

Inherited from

iCollectionDoc.mintEscrowAddress

nsfw?

optional nsfw?: iCollectionNSFW<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:128

The token IDs in this collection that are marked as NSFW.

owners

owners: iBalanceDocWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:118

The fetched owners of this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

reported?

optional reported?: iCollectionNSFW<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:130

The token IDs in this collection that have been reported.

standards

standards: string[]

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

The standards

Inherited from

iCollectionDoc.standards

standardsConformance?

optional standardsConformance?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:172

Standards conformance results for this collection. Populated by the indexer after evaluating each declared standard (e.g. NFTMarketplace, NFTPricingDenom) against the on-chain collection state. Conformance is deterministic, so the indexer recomputes on each fetch rather than caching.

The key is the standard name (e.g. "NFTMarketplace"); the value is a { conforms, errors?, warnings? } object where errors lists rule violations that cause conforms to be false, and warnings lists soft advisories that do not affect conformance.

Index Signature

[standardName: string]: object

standardsInfo?

optional standardsInfo?: iStandardsInfo

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:187

Per-standard core-details object attached by the indexer. Companion to standardsConformance. Only contains data that requires an extra fetch (e.g. an escrow balance) or is a derived status enum — does NOT duplicate data already on the collection doc (approvals, metadata, amounts), which is derivable client-side.

stats?

optional stats?: iCollectionStatsDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:147

The stats for this collection.

tokenFloorPrices?

optional tokenFloorPrices?: iTokenFloorPriceDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:150

The floor prices for this collection.

tokenMetadata

tokenMetadata: iTokenMetadata<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:111

The token metadata for this collection, with off-chain metadata populated.

Overrides

iCollectionDoc.tokenMetadata

updateHistory

updateHistory: iUpdateHistory<T>[]

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

The update history of this collection

Inherited from

iCollectionDoc.updateHistory

validTokenIds

validTokenIds: iUintRange<T>[]

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

Valid token IDs for the collection

Inherited from

iCollectionDoc.validTokenIds

views

views: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesCollection.ts:133

The views for this collection and their pagination Doc. Views will only include the doc _ids. Use the pagination to fetch more. For example, if you want to fetch the activity for a view, you would use the view's pagination to fetch the doc _ids, then use the corresponding activity array to find the matching docs.

Index Signature

[viewId: string]: { ids: string[]; pagination: PaginationInfo; type: string; } | undefined

Edit this page on GitHub