Class BitBadgesCollection<T>

BitBadgesCollection is the type for collections returned by the BitBadges API. It extends the base CollectionDoc type and adds additional accompanying Docrmation such as metadata, activity, balances, preferred chain, etc.

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

CollectionDoc<T>
- BitBadgesCollection

Implements

Index

Constructors

constructor

Methods

checkCanArchiveCollection checkCanDeleteCollection checkCanUpdateBadgeMetadata checkCanUpdateCollectionApprovals checkCanUpdateCollectionMetadata checkCanUpdateCustomData checkCanUpdateManager checkCanUpdateOffChainBalancesMetadata checkCanUpdateStandards checkCanUpdateValidBadgeIds clone convert equals fetchAllForView fetchAndUpdate fetchBadgeBalances fetchMetadata fetchNextForView filterBadgesInCollection generateAliasForBadgeId getActivityView getApprovalTrackersView getBadgeActivity getBadgeBalanceInfo getBadgeBalances getBadgeIdRange getBadgeMetadata getBadgeMetadataDetails getBadgeMetadataTimelineValue getChallengeTrackersView getCollectionMetadata getCollectionMetadataDetails getCollectionMetadataTimelineValue getCurrentBadgeMetadata getCustomData getDefaultUserBalance getIsArchived getListingsView getManager getMaxBadgeId getMintCollectionApprovals getNonMintCollectionApprovals getNumberFieldNames getOffChainBalancesMetadata getOwnersForBadge getOwnersView getRefreshStatus getStandards getUnhandledCollectionApprovals getView getViewBookmark getViewPagination hasNumberFields isRedundantRequest mustGetBadgeBalanceInfo mustGetBadgeBalances pruneMetadataToFetch prunePayload refresh setBadgeMetadataForTimes setCollectionMetadataForTimes toJson toJsonString updateWithNewResponse validateBadgeMetadataUpdate validateCollectionApprovalsUpdate validateCustomDataUpdate validateIsArchivedUpdate validateManagerUpdate validateOffChainBalancesMetadataUpdate validatePermissionsUpdate validatePermissionUpdate validateStandardsUpdate viewHasMore FetchAndInitialize FetchAndInitializeBatch FilterBadgesInCollection GetBadgeActivity GetBadgeBalanceByAddress GetCollections GetOwnersForBadge GetRefreshStatus RefreshMetadata

Constructors

constructor

new BitBadgesCollection<T extends NumberType>(
data: iBitBadgesCollection<T>,
): BitBadgesCollection<T>
Type Parameters
- T extends NumberType
Parameters
- data: iBitBadgesCollection<T>
Returns BitBadgesCollection<T>
Overrides CollectionDoc.constructor
- Defined in src/api-indexer/BitBadgesCollection.ts:183

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

activity

activity: TransferActivityDoc<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.

aliasAddress

aliasAddress: string

The alias BitBadges address for the collection

approvalTrackers

approvalTrackers: ApprovalTrackerDoc<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.

badgeMetadataTimeline

badgeMetadataTimeline: BadgeMetadataTimelineWithDetails<T>[]

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

balancesType

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")

challengeTrackers

challengeTrackers: MerkleChallengeTrackerDoc<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

claims: ClaimDetails<T>[]

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

collectionApprovals

collectionApprovals: CollectionApprovalWithDetails<T>[]

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

collectionId

collectionId: T

The collection ID

collectionMetadataTimeline

collectionMetadataTimeline: CollectionMetadataTimelineWithDetails<T>[]

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

collectionPermissions

collectionPermissions: CollectionPermissionsWithDetails<T>

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

createdBlock

createdBlock: T

The block number when this collection was created

createdBy

createdBy: string

The BitBadges address of the user who created this collection

createdTimestamp

createdTimestamp: T

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

customDataTimeline

customDataTimeline: CustomDataTimeline<T>[]

The custom data timeline

defaultBalances

defaultBalances: UserBalanceStoreWithDetails<T>

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

isArchivedTimeline

isArchivedTimeline: IsArchivedTimeline<T>[]

The is archived timeline

listings

listings: UtilityListingDoc<T>[]

The listings for this collection.

managerTimeline

managerTimeline: ManagerTimeline<T>[]

The manager timeline

`Optional`nsfw

nsfw?: { badgeIds: UintRangeArray<T>; reason: string }

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

offChainBalancesMetadataTimeline

offChainBalancesMetadataTimeline: OffChainBalancesMetadataTimeline<T>[]

The off-chain balances metadata timeline

owners

owners: BalanceDocWithDetails<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.

`Optional`reported

reported?: { badgeIds: UintRangeArray<T>; reason: string }

The badge IDs in this collection that have been reported.

standardsTimeline

standardsTimeline: StandardsTimeline<T>[]

The standards timeline

updateHistory

updateHistory: UpdateHistory<T>[]

The update history of this collection

validBadgeIds

validBadgeIds: UintRangeArray<T>

Valid badge IDs for the collection

views

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.

Methods

checkCanArchiveCollection

checkCanArchiveCollection(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:552

checkCanDeleteCollection

checkCanDeleteCollection(time?: NumberType): null | Error
Checks if this permission is executable at a specific time (Date.now() by default).

Wrapper for ActionPermission.check.
Parameters
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:543

checkCanUpdateBadgeMetadata

checkCanUpdateBadgeMetadata(
 details: {
 badgeIds: iUintRange<NumberType>[];
 timelineTimes: iUintRange<NumberType>[];
 }[],
 time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).
Parameters
- details: { badgeIds: iUintRange<NumberType>[]; timelineTimes: iUintRange<NumberType>[] }[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:638

checkCanUpdateCollectionApprovals

checkCanUpdateCollectionApprovals(
 details: {
 amountTrackerIdList: iAddressList;
 approvalIdList: iAddressList;
 badgeIds: iUintRange<NumberType>[];
 challengeTrackerIdList: iAddressList;
 fromList: iAddressList;
 initiatedByList: iAddressList;
 ownershipTimes: iUintRange<NumberType>[];
 timelineTimes: iUintRange<NumberType>[];
 toList: iAddressList;
 transferTimes: iUintRange<NumberType>[];
 }[],
 time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- details: {
 amountTrackerIdList: iAddressList;
 approvalIdList: iAddressList;
 badgeIds: iUintRange<NumberType>[];
 challengeTrackerIdList: iAddressList;
 fromList: iAddressList;
 initiatedByList: iAddressList;
 ownershipTimes: iUintRange<NumberType>[];
 timelineTimes: iUintRange<NumberType>[];
 toList: iAddressList;
 transferTimes: iUintRange<NumberType>[];
 }[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:657

checkCanUpdateCollectionMetadata

checkCanUpdateCollectionMetadata(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:614

checkCanUpdateCustomData

checkCanUpdateCustomData(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:602

checkCanUpdateManager

checkCanUpdateManager(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:565

checkCanUpdateOffChainBalancesMetadata

checkCanUpdateOffChainBalancesMetadata(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:578

checkCanUpdateStandards

checkCanUpdateStandards(
timelineTimes: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- timelineTimes: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:590

checkCanUpdateValidBadgeIds

checkCanUpdateValidBadgeIds(
badgeIds: iUintRange<T>[],
time?: NumberType,
): null | Error
Checks if this permission is executable for the provided values at a specific time (Date.now() by default).

Wrapper for TimedUpdatePermission.check.
Parameters
- badgeIds: iUintRange<T>[]
- Optionaltime: NumberType
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:626

clone

clone(): BitBadgesCollection<T>
Deep copies the object and returns a new instance.

Returns BitBadgesCollection<T>
Implementation of CustomType.clone
Overrides CollectionDoc.clone
- Defined in src/api-indexer/BitBadgesCollection.ts:211

convert

convert(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): BitBadgesCollection
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns BitBadgesCollection
Implementation of CustomType.convert
Overrides CollectionDoc.convert
- Defined in src/api-indexer/BitBadgesCollection.ts:207

equals

equals>(
other: undefined | null | CustomType,
normalizeNumberTypes?: boolean,
): boolean
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
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Implementation of CustomType.equals
Inherited from CollectionDoc.equals
- Defined in src/common/base.ts:147

fetchAllForView

fetchAllForView(
 api: BaseBitBadgesApi<T>,
 viewType: CollectionViewKey,
 viewId: string,
 oldestFirst?: boolean,
 address?: string,
): Promise<void>
Fetches the entire view (all pages) for a specific view. This will update the current collection with the new response information.

There is a 1 second delay between each page fetch to prevent rate limiting.
Parameters
- api: BaseBitBadgesApi<T>
- viewType: CollectionViewKey
- viewId: string
- OptionaloldestFirst: boolean
- Optionaladdress: string
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesCollection.ts:963

fetchAndUpdate

fetchAndUpdate(
 api: BaseBitBadgesApi<T>,
 options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload,
 forceful?: boolean,
): Promise<void>
Specify a new fetch request for the current collection. This will update the current collection with the new response information. For example, paginations, metadata, views, etc. will all be handled automatically.
Parameters
- api: BaseBitBadgesApi<T>
- options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
- Optionalforceful: boolean
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesCollection.ts:871

fetchBadgeBalances

fetchBadgeBalances(
 api: BaseBitBadgesApi<T>,
 address: string,
 forceful?: boolean,
): Promise<BalanceDocWithDetails<T>>
Fetches the owner information (balances) for a specific address for the current collection. This will update the current collection with the new response information.
Parameters
- api: BaseBitBadgesApi<T>
- address: string
- Optionalforceful: boolean
Returns Promise<BalanceDocWithDetails<T>>
Remarks
Returns the cached value if already fetched. Use forceful to force a new fetch.
- Defined in src/api-indexer/BitBadgesCollection.ts:771

fetchMetadata

fetchMetadata(
 api: BaseBitBadgesApi<T>,
 options: GetMetadataForCollectionPayload,
 forceful?: boolean,
): Promise<void>
Wrapper for fetchAndUpdate that fetches collection metadata.
Parameters
- api: BaseBitBadgesApi<T>
- options: GetMetadataForCollectionPayload
- Optionalforceful: boolean
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesCollection.ts:908

fetchNextForView

fetchNextForView(
 api: BaseBitBadgesApi<T>,
 viewType: CollectionViewKey,
 viewId: string,
 oldestFirst?: boolean,
 address?: string,
): Promise<void>
Fetches the next page for a specific view. This will update the current collection with the new response information (handling paginations).

If the view has no more pages, this will do nothing.
Parameters
- api: BaseBitBadgesApi<T>
- viewType: CollectionViewKey
- viewId: string
- OptionaloldestFirst: boolean
- Optionaladdress: string
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesCollection.ts:942

filterBadgesInCollection

filterBadgesInCollection(
api: BaseBitBadgesApi<T>,
bodyOptions: Omit<iFilterBadgesInCollectionPayload, "collectionId">,
): Promise<FilterBadgesInCollectionSuccessResponse<T>>
Execute a filter query for the collection. You have to handle the pagination yourself.
Parameters
- api: BaseBitBadgesApi<T>
- bodyOptions: Omit<iFilterBadgesInCollectionPayload, "collectionId">
Returns Promise<FilterBadgesInCollectionSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1222

generateAliasForBadgeId

generateAliasForBadgeId(badgeId: T): string
Generates the alias for a specific badge ID. Collection alias is stored in the root of the collection.

Wrapper for generateAlias.
Parameters
- badgeId: T
Returns string
- Defined in src/api-indexer/BitBadgesCollection.ts:1039

getActivityView

getActivityView(viewId: string): TransferActivityDoc<T>[]
Gets the documents for a specific view.
Parameters
- viewId: string
Returns TransferActivityDoc<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:993

getApprovalTrackersView

getApprovalTrackersView(viewId: string): ApprovalTrackerDoc<T>[]
Gets the documents for a specific view.
Parameters
- viewId: string
Returns ApprovalTrackerDoc<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1028

getBadgeActivity

getBadgeActivity(
 api: BaseBitBadgesApi<T>,
 badgeId: T,
 body: iGetBadgeActivityPayload,
): Promise<GetBadgeActivitySuccessResponse<T>>
Get the badge activity for a specific badge ID. You have to handle the pagination yourself.
Parameters
- api: BaseBitBadgesApi<T>
- badgeId: T
- body: iGetBadgeActivityPayload
Returns Promise<GetBadgeActivitySuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1158

getBadgeBalanceInfo

getBadgeBalanceInfo(address: string): undefined | BalanceDocWithDetails<T>
Gets the badge balance document for a specific address from the cached owners array. Returns undefined if not fetched yet. The balance document includes the balances, outgoing approvals, and other details. Use getBadgeBalances to only get the balances.
Parameters
- address: string
Returns undefined | BalanceDocWithDetails<T>
Remarks
This does not fetch the balance from the API. It only returns the cached balance. To fetch the balance, this can either be done directly, or if the collection balances are indexable then the balances can also be fetched via the views and / or the other fetch methods.
Example
```
const collection: BitBadgesCollection<bigint> = { ... }
const address = 'bb1...'
const balance = collection.getBadgeBalance(address)
console.log(balance?.balances)
console.log(balance?.outgoingApprovals)
```
- Defined in src/api-indexer/BitBadgesCollection.ts:354

getBadgeBalances

getBadgeBalances(address: string): undefined | BalanceArray<T>
Gets the badge balances for a specific address from the cached owners array. Returns undefined if not fetched yet. This returns the balances only, not the other details. Use getBadgeBalanceInfo to get the other details for a user balance store (approvals, etc.).
Parameters
- address: string
Returns undefined | BalanceArray<T>
Remarks
This does not fetch the balance from the API. It only returns the cached balance. To fetch the balance, this can either be done directly, or if the collection balances are indexable (i.e. balances type is anything but Off-Chain - Non-Indexed), then the balances can also be fetched via the views and / or the other fetch methods.
Example
```
const collection: BitBadgesCollection<bigint> = { ... }
const address = 'bb1...'
const balances = collection.getBadgeBalances(address)
console.log(balances)
```
- Defined in src/api-indexer/BitBadgesCollection.ts:383

getBadgeIdRange

getBadgeIdRange(): UintRangeArray<bigint>
Gets a UintRangeArray of 1 - Max Badge ID for the collection (i.e. [{ start: 1n, end: maxBadgeId }]).

Returns UintRangeArray<bigint>
- Defined in src/api-indexer/BitBadgesCollection.ts:323

getBadgeMetadata

getBadgeMetadata(badgeId: T): undefined | Metadata<T>
Get the metadata for a specific badge ID. This is the fetched metadata, not the timeline values.

This only returns the metadata object (name, image, etc.) and not the URI or other accompanying details. For those, use getBadgeMetadataDetails.
Parameters
- badgeId: T
Returns undefined | Metadata<T>
Example
```
const collection: BitBadgesCollection<bigint> = { ... }
const badgeId = 123n
const metadata = collection.getBadgeMetadata(badgeId)
const metadataImage = metadata.image
```
- Defined in src/api-indexer/BitBadgesCollection.ts:307

getBadgeMetadataDetails

getBadgeMetadataDetails(badgeId: T): undefined | BadgeMetadataDetails<T>
Gets the details for a specific badge ID. This includes the metadata, URI, and custom data.

If you only want the metadata, use getBadgeMetadata, or you can access it via result.metadata.
Parameters
- badgeId: T
Returns undefined | BadgeMetadataDetails<T>
- Defined in src/api-indexer/BitBadgesCollection.ts:316

getBadgeMetadataTimelineValue

getBadgeMetadataTimelineValue(time?: NumberType): BadgeMetadata<bigint>[]
Gets the badge metadata at a specific time (Date.now() by default).

This gets the timeline value. For the actual fetched value, use getBadgeMetadata() instead.
Parameters
- Optionaltime: NumberType
Returns BadgeMetadata<bigint>[]
Inherited from CollectionDoc.getBadgeMetadataTimelineValue
- Defined in src/api-indexer/docs/docs.ts:199

getChallengeTrackersView

getChallengeTrackersView(viewId: string): MerkleChallengeTrackerDoc<T>[]
Gets the documents for a specific view.
Parameters
- viewId: string
Returns MerkleChallengeTrackerDoc<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1011

getCollectionMetadata

getCollectionMetadata(): undefined | Metadata<T>
Get the cached collection metadata. This is the fetched metadata, not the timeline values.

Returns undefined | Metadata<T>
Example
```
const collection: BitBadgesCollection<bigint> = { ... }
const metadata = collection.getCollectionMetadata()
const metadataImage = metadata.image
```
- Defined in src/api-indexer/BitBadgesCollection.ts:225

getCollectionMetadataDetails

getCollectionMetadataDetails(): undefined | CollectionMetadataDetails<T>
Returns undefined | CollectionMetadataDetails<T>
- Defined in src/api-indexer/BitBadgesCollection.ts:229

getCollectionMetadataTimelineValue

getCollectionMetadataTimelineValue(
time?: NumberType,
): undefined | CollectionMetadata
Gets the collection metadata at a specific time (Date.now() by default).

This gets the timeline value. For the actual fetched value, use getCollectionMetadata() instead.
Parameters
- Optionaltime: NumberType
Returns undefined | CollectionMetadata
Inherited from CollectionDoc.getCollectionMetadataTimelineValue
- Defined in src/api-indexer/docs/docs.ts:190

getCurrentBadgeMetadata

getCurrentBadgeMetadata(): BadgeMetadataDetails<T>[]
Returns BadgeMetadataDetails<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:289

getCustomData

getCustomData(time?: NumberType): undefined | string
Gets the custom data at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string
Inherited from CollectionDoc.getCustomData
- Defined in src/api-indexer/docs/docs.ts:213

getDefaultUserBalance

getDefaultUserBalance(): UserBalanceStore<T>
Creates a blank balance object with the genesis default approvals and balances.

Returns UserBalanceStore<T>
Inherited from CollectionDoc.getDefaultUserBalance
- Defined in src/api-indexer/docs/docs.ts:234

getIsArchived

getIsArchived(time?: NumberType): undefined | boolean
Gets the is archived at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | boolean
Inherited from CollectionDoc.getIsArchived
- Defined in src/api-indexer/docs/docs.ts:227

getListingsView

getListingsView(viewId: string): UtilityListingDoc<T>[]
Gets the documents for a specific view.
Parameters
- viewId: string
Returns UtilityListingDoc<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1020

getManager

getManager(time?: NumberType): undefined | string
Gets the manager at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string
Inherited from CollectionDoc.getManager
- Defined in src/api-indexer/docs/docs.ts:181

getMaxBadgeId

getMaxBadgeId(): bigint
Gets the maximum badge ID for the collection. Checks both the circulating supplys + genesis default balances.

Precondition: The Total balance must be fetched.

Returns bigint
- Defined in src/api-indexer/BitBadgesCollection.ts:399

getMintCollectionApprovals

getMintCollectionApprovals(): CollectionApprovalWithDetails<bigint>[]
Returns all the mint collection approvals.

Wrapper for getMintApprovals.

Returns CollectionApprovalWithDetails<bigint>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1068

getNonMintCollectionApprovals

getNonMintCollectionApprovals(): CollectionApprovalWithDetails<bigint>[]
Returns all the non-mint collection approvals.

Wrapper for getNonMintApprovals.

Returns CollectionApprovalWithDetails<bigint>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1059

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Implementation of CustomType.getNumberFieldNames
Overrides CollectionDoc.getNumberFieldNames
- Defined in src/api-indexer/BitBadgesCollection.ts:203

getOffChainBalancesMetadata

getOffChainBalancesMetadata(
time?: NumberType,
): undefined | OffChainBalancesMetadata
Gets the off-chain balances metadata at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | OffChainBalancesMetadata
Inherited from CollectionDoc.getOffChainBalancesMetadata
- Defined in src/api-indexer/docs/docs.ts:206

getOwnersForBadge

getOwnersForBadge(
 api: BaseBitBadgesApi<T>,
 badgeId: T,
 body: iGetOwnersForBadgePayload,
): Promise<GetOwnersForBadgeSuccessResponse<T>>
Gets the owners for a specific badge. You have to handle the pagination yourself.
Parameters
- api: BaseBitBadgesApi<T>
- badgeId: T
- body: iGetOwnersForBadgePayload
Returns Promise<GetOwnersForBadgeSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1194

getOwnersView

getOwnersView(viewId: string): BalanceDocWithDetails<T>[]
Gets the documents for a specific view.
Parameters
- viewId: string
Returns BalanceDocWithDetails<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1002

getRefreshStatus

getRefreshStatus(
api: BaseBitBadgesApi<T>,
): Promise<RefreshStatusSuccessResponse<T>>
Check the refresh queue status for the collection via the API.
Parameters
- api: BaseBitBadgesApi<T>
Returns Promise<RefreshStatusSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1092

getStandards

getStandards(time?: NumberType): undefined | string[]
Gets the standards at a specific time (Date.now() by default).
Parameters
- Optionaltime: NumberType
Returns undefined | string[]
Inherited from CollectionDoc.getStandards
- Defined in src/api-indexer/docs/docs.ts:220

getUnhandledCollectionApprovals

getUnhandledCollectionApprovals(): CollectionApprovalWithDetails<bigint>[]
Returns all the unhandled collection approvals. Unhandled means disapproved.

Wrapper for getUnhandledCollectionApprovals.

Returns CollectionApprovalWithDetails<bigint>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:1050

getView

getView<KeyType extends CollectionViewKey>(
viewType: KeyType,
viewId: string,
): CollectionViewData<T>[KeyType]
Type agnostic get view function. Uses the viewType to determine the type of view to fetch.
Type Parameters
- KeyType extends CollectionViewKey
Parameters
- viewType: KeyType
- viewId: string
Returns CollectionViewData<T>[KeyType]
- Defined in src/api-indexer/BitBadgesCollection.ts:973

getViewBookmark

getViewBookmark(viewId: string): undefined | string
Returns the bookmark for a specific view. This is used to fetch the next page.
Parameters
- viewId: string
Returns undefined | string
- Defined in src/api-indexer/BitBadgesCollection.ts:933

getViewPagination

getViewPagination(viewId: string): undefined | PaginationInfo
Returns the pagination information for a specific view ({ hasMore, bookmark }).
Parameters
- viewId: string
Returns undefined | PaginationInfo
- Defined in src/api-indexer/BitBadgesCollection.ts:926

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Implementation of CustomType.hasNumberFields
Inherited from CollectionDoc.hasNumberFields
- Defined in src/common/base.ts:161

isRedundantRequest

isRedundantRequest(
options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload,
): boolean
Returns if a new collection API request body is redundant (meaning we already have the data cached).
Parameters
- options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
Returns boolean
- Defined in src/api-indexer/BitBadgesCollection.ts:784

mustGetBadgeBalanceInfo

mustGetBadgeBalanceInfo(address: string): BalanceDocWithDetails<T>
Wrapper for getBadgeBalanceInfo that throws an error if the balance is not found in the document.
Parameters
- address: string
Returns BalanceDocWithDetails<T>
- Defined in src/api-indexer/BitBadgesCollection.ts:361

mustGetBadgeBalances

mustGetBadgeBalances(address: string): BalanceArray<T>
Wrapper for getBadgeBalances that throws an error if the balance is not found in the document.
Parameters
- address: string
Returns BalanceArray<T>
- Defined in src/api-indexer/BitBadgesCollection.ts:390

pruneMetadataToFetch

pruneMetadataToFetch(
metadataToFetch: MetadataFetchOptions,
): { doNotFetchCollectionMetadata: boolean; uris: string[] }
For a metadata fetch request, prune the request to only request the metadata that is not already fetched.
Parameters
- metadataToFetch: MetadataFetchOptions
Returns { doNotFetchCollectionMetadata: boolean; uris: string[] }
Example
```
const collection: BitBadgesCollection<bigint> = { ... }
const metadataToFetch = collection.pruneMetadataToFetch({ badgeIds: [1n, 2n, 3n], uris: ['ipfs://...'] })
console.log(metadataToFetch)
```
- Defined in src/api-indexer/BitBadgesCollection.ts:420

prunePayload

prunePayload(
options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload,
): GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload & {
collectionId: T;
}
Prunes a new collection API request body to only request the data that is not already fetched.
Parameters
- options: GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
Returns GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload & {
collectionId: T;
}
- Defined in src/api-indexer/BitBadgesCollection.ts:832

refresh

refresh(api: BaseBitBadgesApi<T>): Promise<RefreshMetadataSuccessResponse>
Trigger a refresh for the collection via the API. Note there is a cooldown period for refreshing.
Parameters
- api: BaseBitBadgesApi<T>
Returns Promise<RefreshMetadataSuccessResponse>
- Defined in src/api-indexer/BitBadgesCollection.ts:1122

setBadgeMetadataForTimes

setBadgeMetadataForTimes(
metadata: BadgeMetadataDetails<T>[],
timelineTimesToSet?: iUintRange<T>[],
): BadgeMetadataTimelineWithDetails<T>[]
Sets the badge metadata for certain times (defaults to all times).
Parameters
- metadata: BadgeMetadataDetails<T>[]
- OptionaltimelineTimesToSet: iUintRange<T>[]
Returns BadgeMetadataTimelineWithDetails<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:264

setCollectionMetadataForTimes

setCollectionMetadataForTimes(
metadata: CollectionMetadataDetails<T>,
timelineTimesToSet?: iUintRange<T>[],
): CollectionMetadataTimelineWithDetails<T>[]
Sets the collection metadata for certain times (defaults to all times).
Parameters
- metadata: CollectionMetadataDetails<T>
- OptionaltimelineTimesToSet: iUintRange<T>[]
Returns CollectionMetadataTimelineWithDetails<T>[]
- Defined in src/api-indexer/BitBadgesCollection.ts:236

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Implementation of CustomType.toJson
Inherited from CollectionDoc.toJson
- Defined in src/common/base.ts:139

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Implementation of CustomType.toJsonString
Inherited from CollectionDoc.toJsonString
- Defined in src/common/base.ts:143

updateWithNewResponse

updateWithNewResponse(
newResponse: BitBadgesCollection<T>,
forceful?: boolean,
): void
Updates the current collection with a new response from the API. If forceful is true, we fully overwrite the current collection with the new response. Else, we will append the new response to the current collection while handling duplicates, paginations, etc.
Parameters
- newResponse: BitBadgesCollection<T>
- Optionalforceful: boolean
Returns void
- Defined in src/api-indexer/BitBadgesCollection.ts:893

validateBadgeMetadataUpdate

validateBadgeMetadataUpdate(
newBadgeMetadata: BadgeMetadataTimeline<T>[],
): null | Error
Validates if a state transition (old badge metadata -> new badge metadata) is valid, given the current state of the collection and its permissions.

Wrapper for BadgeMetadataTimeline.validateUpdate.
Parameters
- newBadgeMetadata: BadgeMetadataTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:475

validateCollectionApprovalsUpdate

validateCollectionApprovalsUpdate(
newApprovals: CollectionApprovalWithDetails<T>[],
): null | Error
Validates if a state transition (old approvals -> new approvals) is valid, given the current state of the collection and its permissions.

Wrapper for CollectionApprovalWithDetails.validateUpdate.
Parameters
- newApprovals: CollectionApprovalWithDetails<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:461

validateCustomDataUpdate

validateCustomDataUpdate(newCustomData: CustomDataTimeline<T>[]): null | Error
Validates if a state transition (old custom data -> new custom data) is valid, given the current state of the collection and its permissions.

Wrapper for CustomDataTimeline.validateUpdate.
Parameters
- newCustomData: CustomDataTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:503

validateIsArchivedUpdate

validateIsArchivedUpdate(newIsArchived: IsArchivedTimeline<T>[]): null | Error
Validates if a state transition (old isArchived -> new isArchived) is valid, given the current state of the collection and its permissions.

Wrapper for IsArchivedTimeline.validateUpdate.
Parameters
- newIsArchived: IsArchivedTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:523

validateManagerUpdate

validateManagerUpdate(newManager: ManagerTimeline<T>[]): null | Error
Validates if a state transition (old manager -> new manager) is valid, given the current state of the collection and its permissions.

Wrapper for ManagerTimeline.validateUpdate.
Parameters
- newManager: ManagerTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:533

validateOffChainBalancesMetadataUpdate

validateOffChainBalancesMetadataUpdate(
newOffChainBalancesMetadata: OffChainBalancesMetadataTimeline<T>[],
): null | Error
Validates if a state transition (old off-chain balances metadata -> new off-chain balances metadata) is valid, given the current state of the collection and its permissions.

Wrapper for OffChainBalancesMetadataTimeline.validateUpdate.
Parameters
- newOffChainBalancesMetadata: OffChainBalancesMetadataTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:489

validatePermissionsUpdate

validatePermissionsUpdate(
newPermissions: CollectionPermissionsWithDetails<T>,
): null | Error
Validates if a state transition (old permissions -> new permissions) is valid. Must not update any permanently frozen permissions.

Wrapper for CollectionPermissionsWithDetails.validateUpdate.
Parameters
- newPermissions: CollectionPermissionsWithDetails<T>
Returns null | Error
See
Permissions Docs

Remarks
This is validating the updatability of the permissions. To validate whether a permission is executable, use the checkCan* functions.
- Defined in src/api-indexer/BitBadgesCollection.ts:436

validatePermissionUpdate

validatePermissionUpdate(
permissionName: PermissionNameString,
newPermissions: any[],
): null | Error
Validates if a single permission type is updated correctly. Cannot edit anything permanently frozen.

This is validating the updatability of the permissions. To validate whether a permission is executable, use the checkCan* functions.
Parameters
- permissionName: PermissionNameString
- newPermissions: any[]
Returns null | Error
See
Permissions Docs
- Defined in src/api-indexer/BitBadgesCollection.ts:449

validateStandardsUpdate

validateStandardsUpdate(newStandards: StandardsTimeline<T>[]): null | Error
Validates if a state transition (old standards -> new standards) is valid, given the current state of the collection and its permissions.

Wrapper for StandardsTimeline.validateUpdate.
Parameters
- newStandards: StandardsTimeline<T>[]
Returns null | Error
- Defined in src/api-indexer/BitBadgesCollection.ts:513

viewHasMore

viewHasMore(viewId: string): boolean
Returns if the view has more pages to fetch.
Parameters
- viewId: string
Returns boolean
- Defined in src/api-indexer/BitBadgesCollection.ts:919

`Static`FetchAndInitialize

FetchAndInitialize<T extends NumberType>(
api: BaseBitBadgesApi<T>,
options: { collectionId: NumberType } & GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload,
): Promise<BitBadgesCollection<T>>
Fetches and initializes a new BitBadgesCollection object from an API request. Must pass in a valid API instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- options: { collectionId: NumberType } & GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
Returns Promise<BitBadgesCollection<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:696

`Static`FetchAndInitializeBatch

FetchAndInitializeBatch<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionsToFetch: (
 { collectionId: NumberType } & GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
 )[],
): Promise<(undefined | BitBadgesCollection<T>)[]>
Fetches and initializes a batch of new BitBadgesCollection objects from an API request. Must pass in a valid API instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionsToFetch: (
 { collectionId: NumberType } & GetMetadataForCollectionPayload & GetAdditionalCollectionDetailsPayload
 )[]
Returns Promise<(undefined | BitBadgesCollection<T>)[]>
- Defined in src/api-indexer/BitBadgesCollection.ts:757

`Static`FilterBadgesInCollection

FilterBadgesInCollection<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionId: T,
 body: iFilterBadgesInCollectionPayload,
): Promise<FilterBadgesInCollectionSuccessResponse<T>>
Execute a filter query for the collection. You have to handle the pagination yourself.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: T
- body: iFilterBadgesInCollectionPayload
Returns Promise<FilterBadgesInCollectionSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1201

`Static`GetBadgeActivity

GetBadgeActivity<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionId: NumberType,
 badgeId: NumberType,
 payload?: iGetBadgeActivityPayload,
): Promise<GetBadgeActivitySuccessResponse<T>>
Gets activity for a specific badge ID. You have to handle the pagination yourself.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: NumberType
- badgeId: NumberType
- Optionalpayload: iGetBadgeActivityPayload
Returns Promise<GetBadgeActivitySuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1129

`Static`GetBadgeBalanceByAddress

GetBadgeBalanceByAddress<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionId: NumberType,
 address: string,
 payload?: iGetBadgeBalanceByAddressPayload,
): Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Gets the badge balance for a specific address for a specific collection. Must pass in a valid API instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: NumberType
- address: string
- Optionalpayload: iGetBadgeBalanceByAddressPayload
Returns Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:729

`Static`GetCollections

GetCollections<T extends NumberType>(
api: BaseBitBadgesApi<T>,
body: iGetCollectionsPayload,
): Promise<GetCollectionsSuccessResponse<T>>
Gets collections from the API. Must pass in a valid API instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- body: iGetCollectionsPayload
Returns Promise<GetCollectionsSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:708

`Static`GetOwnersForBadge

GetOwnersForBadge<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionId: NumberType,
 badgeId: NumberType,
 payload?: iGetOwnersForBadgePayload,
): Promise<GetOwnersForBadgeSuccessResponse<T>>
Gets owners for a specific badge ID. You have to handle the pagination yourself.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: NumberType
- badgeId: NumberType
- Optionalpayload: iGetOwnersForBadgePayload
Returns Promise<GetOwnersForBadgeSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1165

`Static`GetRefreshStatus

GetRefreshStatus<T extends NumberType>(
api: BaseBitBadgesApi<T>,
collectionId: T,
): Promise<RefreshStatusSuccessResponse<T>>
Returns the status of this collection in the refresh queue.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: T
Returns Promise<RefreshStatusSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesCollection.ts:1075

`Static`RefreshMetadata

RefreshMetadata<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 collectionId: T,
 body?: iRefreshMetadataPayload,
): Promise<RefreshMetadataSuccessResponse>
Trigger a refresh for the collection via the API. Note there is a cooldown period for refreshing.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- collectionId: T
- Optionalbody: iRefreshMetadataPayload
Returns Promise<RefreshMetadataSuccessResponse>
- Defined in src/api-indexer/BitBadgesCollection.ts:1099

Class BitBadgesCollection<T>

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BitBadgesCollection<T>

Properties

_docId

Optional_id

activity

aliasAddress

approvalTrackers

badgeMetadataTimeline

balancesType

challengeTrackers

claims

collectionApprovals

collectionId

collectionMetadataTimeline

collectionPermissions

createdBlock

createdBy

createdTimestamp

customDataTimeline

defaultBalances

isArchivedTimeline

listings

managerTimeline

Optionalnsfw

offChainBalancesMetadataTimeline

owners

Optionalreported

standardsTimeline

updateHistory

validBadgeIds

views

Methods

checkCanArchiveCollection

Parameters

Returns null | Error

checkCanDeleteCollection

Parameters

Returns null | Error

checkCanUpdateBadgeMetadata

Parameters

Returns null | Error

checkCanUpdateCollectionApprovals

Parameters

Returns null | Error

checkCanUpdateCollectionMetadata

Parameters

Returns null | Error

checkCanUpdateCustomData

Parameters

Returns null | Error

checkCanUpdateManager

Parameters

Returns null | Error

checkCanUpdateOffChainBalancesMetadata

Parameters

Returns null | Error

checkCanUpdateStandards

Parameters

Returns null | Error

checkCanUpdateValidBadgeIds

Parameters

Returns null | Error

clone

Returns BitBadgesCollection<T>

convert

Type Parameters

Parameters

Returns BitBadgesCollection<U>

`Optional`_id

`Optional`nsfw

`Optional`reported