Class AddressListDoc<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

AddressList
- AddressListDoc
  - BitBadgesAddressList

Implements

Constructors

constructor

new AddressListDoc<T>(data): AddressListDoc<T>
Type Parameters
- T extends NumberType
Parameters
- data: iAddressListDoc<T>
Returns AddressListDoc<T>
Overrides AddressList.constructor
- Defined in src/api-indexer/docs/docs.ts:673

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.

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 on-chain.

lastUpdated

lastUpdated: T

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

listId

listId: string

The ID of the address list.

`Optional`nsfw

nsfw?: {
reason: string;
}

The NSFW reason if this list is NSFW

`Optional`private

private?: boolean

True if this list is private and will not show up in search results

`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.

`Optional`viewableWithLink

viewableWithLink?: boolean

True if this list is viewable if queried by the list ID directly

whitelist

whitelist: boolean

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

Methods

checkAddress

checkAddress(address): 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 AddressList.checkAddress
- Defined in src/core/addressLists.ts:46

clone

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

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

convert

convert(convertFunction): AddressListDoc
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns AddressListDoc
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Implementation of CustomType.convert
Overrides AddressList.convert
- Defined in src/api-indexer/docs/docs.ts:697

equals

equals(other, normalizeNumberTypes?): 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 AddressList.equals
- Defined in src/common/base.ts:54

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 AddressList.getNumberFieldNames
- Defined in src/api-indexer/docs/docs.ts:693

getOverlapDetails

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

getOverlaps

getOverlaps(addressList): 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 AddressList.getOverlaps
- Defined in src/core/addressLists.ts:115

invert

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

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

isEmpty

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

remove

remove(addresses): 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 AddressList.remove
- Defined in src/core/addressLists.ts:82

toInverted

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

Returns AddressList
Inherited from AddressList.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 AddressList.toJson
- Defined in src/common/base.ts:46

toJsonString

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

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

toProto

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

toRemoved

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

`Static`AllAddresses

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

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

`Static`Reserved

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

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

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

`Static`generateReservedListId

generateReservedListId(addressList): 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 AddressList.generateReservedListId
- Defined in src/core/addressLists.ts:342

`Static`getOverlapDetails

getOverlapDetails(firstList, secondList): [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 AddressList.getOverlapDetails
- Defined in src/core/addressLists.ts:222

`Static`getReservedAddressList

getReservedAddressList(addressListId): 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 AddressList.getReservedAddressList
- Defined in src/core/addressLists.ts:239

`Static`getReservedTrackerList

getReservedTrackerList(trackerListId): 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 AddressList.getReservedTrackerList
- Defined in src/core/addressLists.ts:232

Class AddressListDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AddressListDoc<T>

Properties

_docId

Optional_id

addresses

OptionalaliasAddress

createdBlock

createdBy

customData

lastUpdated

listId

Optionalnsfw

Optionalprivate

Optionalreported

updateHistory

uri

OptionalviewableWithLink

whitelist

Methods

checkAddress

Parameters

Returns boolean

Remarks

clone

Returns AddressListDoc<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns AddressListDoc<U>

Deprecated

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

getOverlapDetails

Parameters

Returns [AddressList, AddressList, AddressList]

getOverlaps

Parameters

Returns AddressList

invert

Returns this

isEmpty

Returns boolean

remove

Parameters

Returns this

toInverted

Returns AddressList

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.AddressList

toRemoved

Parameters

Returns AddressList

StaticAllAddresses

Returns AddressList

StaticReserved

Parameters

Returns AddressList

StaticfromJson

`Optional`_id

`Optional`aliasAddress

`Optional`nsfw

`Optional`private

`Optional`reported

`Optional`viewableWithLink

`Static`AllAddresses

`Static`Reserved

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`generateReservedListId

`Static`getOverlapDetails

`Static`getReservedAddressList

`Static`getReservedTrackerList