Class BitBadgesAddressList<T>

Type Parameters

T extends NumberType

Hierarchy (View Summary, Expand)

AddressListDoc<T>
- BitBadgesAddressList

Implements

Index

Constructors

constructor

Properties

_docId _id? addresses aliasAddress? claims createdBlock createdBy customData lastUpdated listActivity listId listings? managedBy metadata? nsfw? reported? updateHistory uri views whitelist

Constructors

constructor

new BitBadgesAddressList<T extends NumberType>(
data: iBitBadgesAddressList<T>,
): BitBadgesAddressList<T>
Type Parameters
- T extends NumberType
Parameters
- data: iBitBadgesAddressList<T>
Returns BitBadgesAddressList<T>
Overrides AddressListDoc.constructor
- Defined in src/api-indexer/BitBadgesAddressList.ts:58

Properties

_docId

_docId: string

A unique stringified document ID

`Optional`_id

_id?: string

A unique document ID (Mongo DB ObjectID)

addresses

addresses: string[]

The addresses of the address list. If this is a tracker list, the addresses are the tracker IDs.

`Optional`aliasAddress

aliasAddress?: string

The alias BitBadges address of the address list. Handled internally.

claims

claims: ClaimDetails<T>[]

The linked claims of the address list.

createdBlock

createdBlock: T

The block number when this list was created

createdBy

createdBy: string

The BitBadges address of the user who created this list

customData

customData: string

Arbitrary custom data that can be stored. Leave blank for no custom data.

lastUpdated

lastUpdated: T

The timestamp of when this list was last updated (milliseconds since epoch)

listActivity

listActivity: ListActivityDoc<T>[]

The activity of the address list.

listId

listId: string

The ID of the address list.

`Optional`listings

listings?: UtilityListingDoc<T>[]

The listings of the address list.

managedBy

managedBy: string

The BitBadges address of the user who is currently managing this

`Optional`metadata

metadata?: Metadata<T>

The metadata of the address list.

`Optional`nsfw

nsfw?: { reason: string }

The NSFW reason if this list is NSFW

`Optional`reported

reported?: { reason: string }

The reported reason if this list is reported

updateHistory

updateHistory: iUpdateHistory<T>[]

The update history of this list

uri

uri: string

The URI where to fetch the address list metadata from.

views

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

The views of the address list.

whitelist

whitelist: boolean

Whether or not to include ONLY the addresses or include all EXCEPT the addresses.

Methods

checkAddress

checkAddress(address: string): boolean
Checks if a specific account is in the given address list. This means added to a whitelist or NOT included in a blacklist.
Parameters
- address: string
Returns boolean
Remarks
The double negative may get confusing.
Inherited from AddressListDoc.checkAddress
- Defined in src/core/addressLists.ts:46

clone

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

Returns BitBadgesAddressList<T>
Implementation of CustomType.clone
Overrides AddressListDoc.clone
- Defined in src/api-indexer/BitBadgesAddressList.ts:75

convert

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

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 AddressListDoc.equals
- Defined in src/common/base.ts:101

fetchAllForView

fetchAllForView(
 api: BaseBitBadgesApi<T>,
 viewType: AddressListViewKey,
 viewId: string,
): Promise<void>
Fetches all the documents for a specific view. 1 second delay between each fetch to avoid rate limiting.
Parameters
- api: BaseBitBadgesApi<T>
- viewType: AddressListViewKey
- viewId: string
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesAddressList.ts:184

fetchNextForView

fetchNextForView(
 api: BaseBitBadgesApi<T>,
 viewType: AddressListViewKey,
 viewId: string,
): Promise<void>
Fetches the next batch of documents for a specific view. 25 documents are fetched at a time. This updates the view in the class instance, as well as handling the pagination.
Parameters
- api: BaseBitBadgesApi<T>
- viewType: AddressListViewKey
- viewId: string
Returns Promise<void>
- Defined in src/api-indexer/BitBadgesAddressList.ts:143

getActivityView

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

getListingsView

getListingsView(viewId: string): UtilityListingDoc<T>[]
Parameters
- viewId: string
Returns UtilityListingDoc<T>[]
- Defined in src/api-indexer/BitBadgesAddressList.ts:207

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 AddressListDoc.getNumberFieldNames
- Defined in src/api-indexer/BitBadgesAddressList.ts:67

getOverlapDetails

getOverlapDetails(
addressList: iAddressList,
): [AddressList, AddressList, AddressList]
Gets the overlap details for two address lists. Returns [inFirstListButNotSecond, inBothLists, inSecondListButNotFirst].
Parameters
- addressList: iAddressList
Returns [AddressList, AddressList, AddressList]
Inherited from AddressListDoc.getOverlapDetails
- Defined in src/core/addressLists.ts:123

getOverlaps

getOverlaps(addressList: iAddressList): AddressList
Gets the addresses that are in both lists.

Note the returned value can be a whitelist or a blacklist, depending on the input lists. For example, all addresses except Bob (blacklist) overlap or just Bob (whitelist) overlap.
Parameters
- addressList: iAddressList
Returns AddressList
Inherited from AddressListDoc.getOverlaps
- Defined in src/core/addressLists.ts:115

getView

getView(
viewType: AddressListViewKey,
viewId: string,
): ListActivityDoc<T>[] | UtilityListingDoc<T>[]
Type safe method to get the documents array for a specific view.
Parameters
- viewType: AddressListViewKey
- viewId: string
Returns ListActivityDoc<T>[] | UtilityListingDoc<T>[]
- Defined in src/api-indexer/BitBadgesAddressList.ts:194

getViewBookmark

getViewBookmark(viewId: string): string
Gets the bookmark for a specific view. This is to be passed into the fetchNextForView method.
Parameters
- viewId: string
Returns string
- Defined in src/api-indexer/BitBadgesAddressList.ts:135

getViewPagination

getViewPagination(viewId: string): PaginationInfo
Gets the pagination for a specific view ({ bookmark, hasMore }).
Parameters
- viewId: string
Returns PaginationInfo
- Defined in src/api-indexer/BitBadgesAddressList.ts:128

hasNumberFields

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

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

invert

invert(): this
Inverts the list in-place. Simply done by invert the whitelist property.

Returns this
Inherited from AddressListDoc.invert
- Defined in src/core/addressLists.ts:63

isEmpty

isEmpty(): boolean
Returns boolean
Inherited from AddressListDoc.isEmpty
- Defined in src/core/addressLists.ts:56

isStoredOffChain

isStoredOffChain(): boolean
Returns true if the address list is stored off-chain. Off-chain lists are stored in the database and are not part of the blockchain. They are updatable, deletable, and can be used for surveys. On-chain lists are immutable and are created through blockchain transactions.

Returns boolean
- Defined in src/api-indexer/BitBadgesAddressList.ts:217

remove

remove(addresses: string | iAddressList): this
Removes addresses from the list in-place.

If this is a whitelist, the address will be removed (if it is currently added). If this is a blacklist, the address will be added (if it is not currently added). Otherwise, it is a no-op since it is already removed.
Parameters
- addresses: string | iAddressList
Returns this
Inherited from AddressListDoc.remove
- Defined in src/core/addressLists.ts:82

toInverted

toInverted(): AddressList
Returns a new list with the addresses inverted.

Returns AddressList
Inherited from AddressListDoc.toInverted
- Defined in src/core/addressLists.ts:71

toJson

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

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

toJsonString

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

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

toProto

toProto(): proto.badges.AddressList
Returns proto.badges.AddressList
Inherited from AddressListDoc.toProto
- Defined in src/core/addressLists.ts:365

toRemoved

toRemoved(addresses: string | iAddressList): AddressList
Wrapper for remove that returns a new list instead of modifying the current one.
Parameters
- addresses: string | iAddressList
Returns AddressList
Inherited from AddressListDoc.toRemoved
- Defined in src/core/addressLists.ts:105

updateWithNewResponse

updateWithNewResponse(
newResponse: BitBadgesAddressList<T>,
forceful?: boolean,
): void
Updates the current list with a new response
Parameters
- newResponse: BitBadgesAddressList<T>
- Optionalforceful: boolean
Returns void
- Defined in src/api-indexer/BitBadgesAddressList.ts:224

viewHasMore

viewHasMore(viewId: string): boolean
Returns if the view has more pages to be fetched. If we have reached the end of the view, this will return false.
Parameters
- viewId: string
Returns boolean
- Defined in src/api-indexer/BitBadgesAddressList.ts:121

`Static`AllAddresses

AllAddresses(): AddressList
Returns the reserved 'All' address list.

Returns AddressList
Inherited from AddressListDoc.AllAddresses
- Defined in src/core/addressLists.ts:132

`Static`CreateAddressList

CreateAddressList<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iCreateAddressListsPayload<T>,
): Promise<CreateAddressListsSuccessResponse>
Creates a new address list off-chain. On-chain lists are created through blockchain transactions.

Behind the scenes, this is just an alias for UpdateAddressList.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iCreateAddressListsPayload<T>
Returns Promise<CreateAddressListsSuccessResponse>
- Defined in src/api-indexer/BitBadgesAddressList.ts:262

`Static`DeleteAddressList

DeleteAddressList<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iDeleteAddressListsPayload,
): Promise<DeleteAddressListsSuccessResponse>
Deletes an off-chain address list. On-chain lists are deleted through blockchain transactions.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iDeleteAddressListsPayload
Returns Promise<DeleteAddressListsSuccessResponse>
- Defined in src/api-indexer/BitBadgesAddressList.ts:348

`Static`FetchAndInitialize

FetchAndInitialize<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 options: {
 listId: string;
 viewsToFetch?: {
 bookmark: string;
 viewId: string;
 viewType: "listActivity";
 }[];
 },
): Promise<BitBadgesAddressList<T>>
Fetches and initializes a BitBadgesAddressList from the API. Must pass in a valid BitBadgesApi instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- options: {
 listId: string;
 viewsToFetch?: {
 bookmark: string;
 viewId: string;
 viewType: "listActivity";
 }[];
 }
Returns Promise<BitBadgesAddressList<T>>
- Defined in src/api-indexer/BitBadgesAddressList.ts:82

`Static`FetchAndInitializeBatch

FetchAndInitializeBatch<T extends NumberType>(
 api: BaseBitBadgesApi<T>,
 options: {
 listId: string;
 viewsToFetch?: {
 bookmark: string;
 viewId: string;
 viewType: "listActivity";
 }[];
 }[],
): Promise<(undefined | BitBadgesAddressList<T>)[]>
Fetches and initializes a batch of BitBadgesAddressList from the API. Must pass in a valid BitBadgesApi instance.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- options: {
 listId: string;
 viewsToFetch?: {
 bookmark: string;
 viewId: string;
 viewType: "listActivity";
 }[];
 }[]
Returns Promise<(undefined | BitBadgesAddressList<T>)[]>
- Defined in src/api-indexer/BitBadgesAddressList.ts:103

`Static`fromJson

fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AddressList
Parameters
- jsonValue: JsonValue
- Optionaloptions: Partial<JsonReadOptions>
Returns AddressList
Inherited from AddressListDoc.fromJson
- Defined in src/core/addressLists.ts:369

`Static`fromJsonString

fromJsonString(
jsonString: string,
options?: Partial<JsonReadOptions>,
): AddressList
Parameters
- jsonString: string
- Optionaloptions: Partial<JsonReadOptions>
Returns AddressList
Inherited from AddressListDoc.fromJsonString
- Defined in src/core/addressLists.ts:373

`Static`fromProto

fromProto(item: proto.badges.AddressList): AddressList
Parameters
- item: proto.badges.AddressList
Returns AddressList
Inherited from AddressListDoc.fromProto
- Defined in src/core/addressLists.ts:377

`Static`generateReservedListId

generateReservedListId(addressList: iAddressList): string
Generates a list ID for a given address list.
Parameters
- addressList: iAddressList
  The address list to generate the ID for
Returns string
Inherited from AddressListDoc.generateReservedListId
- Defined in src/core/addressLists.ts:342

`Static`GetAddressLists

GetAddressLists<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iGetAddressListsPayload,
): Promise<GetAddressListsSuccessResponse<T>>
Gets address lists from the API.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iGetAddressListsPayload
Returns Promise<GetAddressListsSuccessResponse<T>>
- Defined in src/api-indexer/BitBadgesAddressList.ts:239

`Static`getOverlapDetails

getOverlapDetails(
firstList: iAddressList,
secondList: iAddressList,
): [AddressList, AddressList, AddressList]
Gets the overlap details between two address lists. Returns [inFirstButNotSecond, overlaps, inSecondButNotFirst].
Parameters
- firstList: iAddressList
- secondList: iAddressList
Returns [AddressList, AddressList, AddressList]
Inherited from AddressListDoc.getOverlapDetails
- Defined in src/core/addressLists.ts:222

`Static`getReservedAddressList

getReservedAddressList(addressListId: string): AddressList
Returns the address list for a list ID, if it is a reserved ID (i.e. Mint, Manager, All, None, validly formatted address, ...)
Parameters
- addressListId: string
Returns AddressList
Inherited from AddressListDoc.getReservedAddressList
- Defined in src/core/addressLists.ts:239

`Static`getReservedTrackerList

getReservedTrackerList(trackerListId: string): AddressList
Returns the tracker list for a tracker ID list. Little different logic because tracker ID lists can only be reserved IDs (no storage) and can be nonvalid addresses
Parameters
- trackerListId: string
Returns AddressList
Inherited from AddressListDoc.getReservedTrackerList
- Defined in src/core/addressLists.ts:232

`Static`Reserved

Reserved(addressListId: string): AddressList
Returns a reserved address list by ID.
Parameters
- addressListId: string
Returns AddressList
Inherited from AddressListDoc.Reserved
- Defined in src/core/addressLists.ts:139

`Static`UpdateAddressList

UpdateAddressList<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iUpdateAddressListsPayload<T>,
): Promise<UpdateAddressListsSuccessResponse>
Updates an off-chain address list. On-chain lists are updated through blockchain transactions.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iUpdateAddressListsPayload<T>
Returns Promise<UpdateAddressListsSuccessResponse>
- Defined in src/api-indexer/BitBadgesAddressList.ts:283

`Static`UpdateAddressListAddresses

UpdateAddressListAddresses<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iUpdateAddressListAddressesPayload,
): Promise<UpdateAddressListAddressesSuccessResponse>
Updates the addresses of an off-chain address list. On-chain lists are updated through blockchain transactions.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iUpdateAddressListAddressesPayload
Returns Promise<UpdateAddressListAddressesSuccessResponse>
- Defined in src/api-indexer/BitBadgesAddressList.ts:327

`Static`UpdateAddressListCoreDetails

UpdateAddressListCoreDetails<T extends NumberType>(
api: BaseBitBadgesApi<T>,
payload: iUpdateAddressListCoreDetailsPayload<T>,
): Promise<UpdateAddressListCoreDetailsSuccessResponse>
Updates the core details of an off-chain address list.
Type Parameters
- T extends NumberType
Parameters
- api: BaseBitBadgesApi<T>
- payload: iUpdateAddressListCoreDetailsPayload<T>
Returns Promise<UpdateAddressListCoreDetailsSuccessResponse>
- Defined in src/api-indexer/BitBadgesAddressList.ts:304

Class BitBadgesAddressList<T>

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BitBadgesAddressList<T>

Properties

_docId

Optional_id

addresses

OptionalaliasAddress

claims

createdBlock

createdBy

customData

lastUpdated

listActivity

listId

Optionallistings

managedBy

Optionalmetadata

Optionalnsfw

Optionalreported

updateHistory

uri

views

whitelist

Methods

checkAddress

Parameters

Returns boolean

Remarks

clone

Returns BitBadgesAddressList<T>

convert

Type Parameters

Parameters

Returns BitBadgesAddressList<U>

equals

Type Parameters

Parameters

Returns boolean

fetchAllForView

Parameters

Returns Promise<void>

fetchNextForView

Parameters

Returns Promise<void>

getActivityView

Parameters

Returns ListActivityDoc<T>[]

getListingsView

Parameters

Returns UtilityListingDoc<T>[]

getNumberFieldNames

Returns string[]

getOverlapDetails

Parameters

Returns [AddressList, AddressList, AddressList]

getOverlaps

Parameters

Returns AddressList

getView

Parameters

Returns ListActivityDoc<T>[] | UtilityListingDoc<T>[]

getViewBookmark

Parameters

Returns string

getViewPagination

Parameters

Returns PaginationInfo

hasNumberFields

Returns boolean

`Optional`_id

`Optional`aliasAddress

`Optional`listings

`Optional`metadata

`Optional`nsfw

`Optional`reported

`Static`AllAddresses

`Static`CreateAddressList

`Static`DeleteAddressList

`Static`FetchAndInitialize

`Static`FetchAndInitializeBatch

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`generateReservedListId

`Static`GetAddressLists

`Static`getOverlapDetails

`Static`getReservedAddressList

`Static`getReservedTrackerList

`Static`Reserved