Class: CollectionStats<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1798

CollectionStats tracks aggregated statistics for a collection. These are computed on-chain and can be queried via GRPC or precompile.

Extends#

• BaseNumberTypeClass<CollectionStats<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionStats<T>

Constructors#

Constructor#

new CollectionStats<T>(data): CollectionStats<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1809

Parameters#

data#

iCollectionStats<T>

Returns#

CollectionStats<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

balances#

balances: Balance<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1807

Circulating supply as Balance[] for proper range handling

Implementation of#

iCollectionStats.balances

---

holderCount#

holderCount: T

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1802

Number of unique holders (addresses with non-zero balance)

Implementation of#

iCollectionStats.holderCount

Methods#

clone()#

clone(): CollectionStats

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

CollectionStats

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): CollectionStats<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1819

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionStats<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1815

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

fromProto()#

static fromProto<T>(item, convertFunction): CollectionStats<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1823

Type Parameters#

T#

T extends NumberType

Parameters#

item#

CollectionStats

convertFunction#

(val) => T

Returns#

CollectionStats<T>