Interface: iCollectionDoc<T>

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

Extends#

• Doc

Extended by#

• iBitBadgesCollection

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

---

aliasPaths#

aliasPaths: iAliasPath<T>[]

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

The alias (non-wrapping) paths for the collection

---

collectionApprovals#

collectionApprovals: iCollectionApproval<T>[]

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

The collection approved transfers timeline

---

collectionId#

collectionId: string

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

The collection ID

---

collectionMetadata#

collectionMetadata: iCollectionMetadata

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

The collection metadata

---

collectionPermissions#

collectionPermissions: iCollectionPermissions<T>

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

The collection permissions

---

cosmosCoinWrapperPaths#

cosmosCoinWrapperPaths: iCosmosCoinWrapperPath<T>[]

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

The IBC wrapper paths for the collection

---

createdBlock#

createdBlock: T

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

The block number when this collection was created

---

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

---

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)

---

customData#

customData: string

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

The custom data

---

defaultBalances#

defaultBalances: iUserBalanceStore<T>

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

The default balances for users who have not interacted with the collection yet. Only used if collection has "Standard" balance type.

---

invariants#

invariants: iCollectionInvariants<T>

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

Collection-level invariants that cannot be broken. These are set upon genesis and cannot be modified.

---

isArchived#

isArchived: boolean

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

The is archived flag

---

manager#

manager: string

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

The manager

---

mintEscrowAddress#

mintEscrowAddress: string

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

Mint escrow address

---

standards#

standards: string[]

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

The standards

---

tokenMetadata#

tokenMetadata: iTokenMetadata<T>[]

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

The token metadata

---

updateHistory#

updateHistory: iUpdateHistory<T>[]

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

The update history of this collection

---

validTokenIds#

validTokenIds: iUintRange<T>[]

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

Valid token IDs for the collection