Class CollectionDoc<T>

Type Parameters

Hierarchy (view full)




_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

aliasAddress: string

The alias cosmos address for the collection

badgeMetadataTimeline: BadgeMetadataTimeline<T>[]

The badge metadata timeline

balancesType: "Standard" | "Off-Chain - Indexed" | "Non-Public" | "Off-Chain - Non-Indexed"

The type of balances (i.e. "Standard", "Off-Chain - Indexed", "Non-Public, "Off-Chain - Non-Indexed")

collectionApprovals: CollectionApproval<T>[]

The collection approved transfers timeline

collectionId: T

The collection ID

collectionMetadataTimeline: CollectionMetadataTimeline<T>[]

The collection metadata timeline

collectionPermissions: CollectionPermissions<T>

The collection permissions

createdBlock: T

The block number when this collection was created

createdBy: string

The cosmos address of the user who created this collection

createdTimestamp: T

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

customDataTimeline: CustomDataTimeline<T>[]

The custom data timeline

defaultBalances: UserBalanceStore<T>

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

isArchivedTimeline: IsArchivedTimeline<T>[]

The is archived timeline

managerTimeline: ManagerTimeline<T>[]

The manager timeline

offChainBalancesMetadataTimeline: OffChainBalancesMetadataTimeline<T>[]

The off-chain balances metadata timeline

standardsTimeline: StandardsTimeline<T>[]

The standards timeline

updateHistory: UpdateHistory<T>[]

The update history of this collection


  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters


    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

  • Gets the is archived at a specific time ( by default).


    Returns undefined | boolean

  • Gets the standards at a specific time ( by default).


    Returns undefined | string[]

  • Parameters

    Returns {
        badgeMetadata: BadgeMetadata<bigint>[];
        collectionMetadata: undefined | CollectionMetadata;
        customData: undefined | string;
        isArchived: undefined | boolean;
        manager: undefined | string;
        offChainBalancesMetadata: undefined | OffChainBalancesMetadata;
        standards: undefined | string[];