The addresses of the address list. If this is a tracker list, the addresses are the tracker IDs.
OptionalcreatedThe address that created the address list. Handled internally.
Arbitrary custom data that can be stored. Leave blank for no custom data.
The ID of the address list.
The URI where to fetch the address list metadata from.
Whether or not to include ONLY the addresses or include all EXCEPT the addresses.
Deep copies the object and returns a new instance.
Optional_convertFunction: (val: NumberType) => UOptionaloptions: ConvertOptionsCompares 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").
OptionalnormalizeNumberTypes: booleanInternal helper method to convert the number fields of the object to a different NumberType equivalent.
Gets the overlap details for two address lists. Returns [inFirstListButNotSecond, inBothLists, inSecondListButNotFirst].
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.
Checks if the object has number fields.
Inverts the list in-place. Simply done by invert the whitelist property.
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.
Returns a new list with the addresses inverted.
Converts the object to a JSON object with all primitive types.
Converts the object to a JSON string.
Wrapper for remove that returns a new list instead of modifying the current one.
StaticAllReturns the reserved 'All' address list.
StaticfromOptionaloptions: Partial<JsonReadOptions>StaticfromOptionaloptions: Partial<JsonReadOptions>StaticfromStaticgenerateGenerates a list ID for a given address list.
The address list to generate the ID for
StaticgetGets the overlap details between two address lists. Returns [inFirstButNotSecond, overlaps, inSecondButNotFirst].
StaticgetReturns the address list for a list ID, if it is a reserved ID (i.e. Mint, Manager, All, None, validly formatted address, ...)
StaticgetReturns 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
StaticReserved
AddressLists represent a list of addresses, identified by a unique ID.
Some list IDs are reserved and auto generated by the blockchain. Otherwise, the list can be created on-chain via MsgCreateAddressLists.
For the BitBadges indexer / API, we also allow users to create off-chain lists hosted in a centralized manner.
On-chain lists are stored on the blockchain, are permanent, non editable, non deletable, and can be used for defining permissions and approvals. Off-chain lists are stored off-chain, are mutable, and can be edited / deleted at any time by the creator.