bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface iBitBadgesCollection<T>

    interface iBitBadgesCollection<T extends NumberType> {
        _docId: string;
        _id?: string;
        activity: iTransferActivityDoc<T>[];
        approvalTrackers: iApprovalTrackerDoc<T>[];
        challengeTrackers: iMerkleChallengeTrackerDoc<T>[];
        claims: iClaimDetails<T>[];
        collectionApprovals: iCollectionApprovalWithDetails<T>[];
        collectionId: string;
        collectionMetadataTimeline: iCollectionMetadataTimelineWithDetails<T>[];
        collectionPermissions: iCollectionPermissionsWithDetails<T>;
        cosmosCoinWrapperPaths: iCosmosCoinWrapperPathWithDetails<T>[];
        createdBlock: T;
        createdBy: string;
        createdTimestamp: T;
        customDataTimeline: iCustomDataTimeline<T>[];
        defaultBalances: iUserBalanceStoreWithDetails<T>;
        invariants: iCollectionInvariants<T>;
        isArchivedTimeline: iIsArchivedTimeline<T>[];
        listings: iUtilityPageDoc<T>[];
        managerTimeline: iManagerTimeline<T>[];
        mintEscrowAddress: string;
        nsfw?: iCollectionNSFW<T>;
        owners: iBalanceDocWithDetails<T>[];
        reported?: iCollectionNSFW<T>;
        standardsTimeline: iStandardsTimeline<T>[];
        stats?: iCollectionStatsDoc<T>;
        tokenFloorPrices?: iTokenFloorPriceDoc<T>[];
        tokenMetadataTimeline: iTokenMetadataTimelineWithDetails<T>[];
        updateHistory: iUpdateHistory<T>[];
        validTokenIds: iUintRange<T>[];
        views: {
            [viewId: string]:
                | undefined
                | { ids: string[]; pagination: PaginationInfo; type: string };
        };
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    _docId _id? activity approvalTrackers challengeTrackers claims collectionApprovals collectionId collectionMetadataTimeline collectionPermissions cosmosCoinWrapperPaths createdBlock createdBy createdTimestamp customDataTimeline defaultBalances invariants isArchivedTimeline listings managerTimeline mintEscrowAddress nsfw? owners reported? standardsTimeline stats? tokenFloorPrices? tokenMetadataTimeline updateHistory validTokenIds views

    Properties

    _docId

    _docId: string

    A unique stringified document ID

    Optional_id

    _id?: string

    A unique document ID (Mongo DB ObjectID)

    activity: iTransferActivityDoc<T>[]

    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.

    approvalTrackers: iApprovalTrackerDoc<T>[]

    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: iMerkleChallengeTrackerDoc<T>[]

    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: iClaimDetails<T>[]

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

    collectionApprovals: iCollectionApprovalWithDetails<T>[]

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

    collectionId: string

    The collection ID

    collectionMetadataTimeline: iCollectionMetadataTimelineWithDetails<T>[]

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

    collectionPermissions: iCollectionPermissionsWithDetails<T>

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

    cosmosCoinWrapperPaths: iCosmosCoinWrapperPathWithDetails<T>[]

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

    createdBlock: T

    The block number when this collection was created

    createdBy: string

    The BitBadges address of the user who created this collection

    createdTimestamp: T

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

    customDataTimeline: iCustomDataTimeline<T>[]

    The custom data timeline

    defaultBalances: iUserBalanceStoreWithDetails<T>

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

    invariants: iCollectionInvariants<T>

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

    isArchivedTimeline: iIsArchivedTimeline<T>[]

    The is archived timeline

    listings: iUtilityPageDoc<T>[]

    The listings for this collection.

    managerTimeline: iManagerTimeline<T>[]

    The manager timeline

    mintEscrowAddress: string

    Mint escrow address

    nsfw?: iCollectionNSFW<T>

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

    owners: iBalanceDocWithDetails<T>[]

    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?: iCollectionNSFW<T>

    The token IDs in this collection that have been reported.

    standardsTimeline: iStandardsTimeline<T>[]

    The standards timeline

    stats?: iCollectionStatsDoc<T>

    The stats for this collection.

    tokenFloorPrices?: iTokenFloorPriceDoc<T>[]

    The floor prices for this collection.

    tokenMetadataTimeline: iTokenMetadataTimelineWithDetails<T>[]

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

    updateHistory: iUpdateHistory<T>[]

    The update history of this collection

    validTokenIds: iUintRange<T>[]

    Valid token IDs for the collection

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

    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.

    Settings

    Member Visibility

    On This Page

    Properties