Class: CollectionInvariantsWithDetails<T>

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

Collection invariants with EVM query challenges as WithDetails (metadata populated). Used on BitBadgesCollection API responses.

Extends#

• CollectionInvariants<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionInvariantsWithDetails<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iCollectionInvariantsWithDetails<T>

Returns#

CollectionInvariantsWithDetails<T>

Overrides#

CollectionInvariants.constructor

Properties#

cosmosCoinBackedPath?#

optional cosmosCoinBackedPath?: CosmosCoinBackedPath<T>

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

The IBC backed (sdk.coin) path for the collection. Only one path is allowed.

Implementation of#

iCollectionInvariantsWithDetails.cosmosCoinBackedPath

Inherited from#

CollectionInvariants.cosmosCoinBackedPath

---

disablePoolCreation#

disablePoolCreation: boolean

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

If true, disallows pool creation with this collection's assets. When true, any attempt to create a pool with assets from this collection will fail.

Implementation of#

iCollectionInvariantsWithDetails.disablePoolCreation

Inherited from#

CollectionInvariants.disablePoolCreation

---

evmQueryChallenges?#

optional evmQueryChallenges?: EVMQueryChallengeWithDetails<T>[]

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

EVM query invariants that must pass after all transfers complete. These are checked once per message after all balance updates, with access to ALL recipient addresses.

Implementation of#

iCollectionInvariantsWithDetails.evmQueryChallenges

Overrides#

CollectionInvariants.evmQueryChallenges

---

maxSupplyPerId#

maxSupplyPerId: T

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

Maximum supply per token ID. If set, no balance can exceed this amount. This prevents any single token ID from having more than the specified supply.

Implementation of#

iCollectionInvariantsWithDetails.maxSupplyPerId

Inherited from#

CollectionInvariants.maxSupplyPerId

---

noCustomOwnershipTimes#

noCustomOwnershipTimes: boolean

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

If true, all ownership times must be full ranges [{ start: 1, end: GoMaxUInt64 }]. This prevents time-based restrictions on token ownership.

Implementation of#

iCollectionInvariantsWithDetails.noCustomOwnershipTimes

Inherited from#

CollectionInvariants.noCustomOwnershipTimes

---

noForcefulPostMintTransfers#

noForcefulPostMintTransfers: boolean

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

If true, disallows any collection approvals that have overridesFromOutgoingApprovals or overridesToIncomingApprovals set to true. This prevents forceful post-mint transfers that bypass user-level approvals.

Implementation of#

iCollectionInvariantsWithDetails.noForcefulPostMintTransfers

Inherited from#

CollectionInvariants.noForcefulPostMintTransfers

Methods#

clone()#

clone(): CollectionInvariants

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

Deep copies the object and returns a new instance.

Returns#

CollectionInvariants

Inherited from#

CollectionInvariants.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionInvariantsWithDetails<U>

Overrides#

CollectionInvariants.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#

CollectionInvariants.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CollectionInvariants.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#

CollectionInvariants.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#

CollectionInvariants.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#

CollectionInvariants.toJsonString

---

toProto()#

toProto(): CollectionInvariants

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

Returns#

CollectionInvariants

Overrides#

CollectionInvariants.toProto

---

fromJson()#

static fromJson<T>(jsonValue, options?): CollectionInvariants<T>

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

Type Parameters#

T#

T extends NumberType

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

CollectionInvariants<T>

Inherited from#

CollectionInvariants.fromJson

---

fromJsonString()#

static fromJsonString<T>(jsonString, options?): CollectionInvariants<T>

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

Type Parameters#

T#

T extends NumberType

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

CollectionInvariants<T>

Inherited from#

CollectionInvariants.fromJsonString

---

fromProto()#

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

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

Type Parameters#

T#

T extends NumberType

Parameters#

item#

CollectionInvariants

convertFunction#

(val) => T

Returns#

CollectionInvariants<T>

Inherited from#

CollectionInvariants.fromProto