Class: MaxNumTransfers<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:930

MaxNumTransfers represents the maximum number of transfers for the token IDs and ownershipTimes of this approval.

Can be set to 0 to represent an unlimited number of transfers. If set to non-zero value, we track the running tally of the number of transfers for each token ID / ownership time. Once it reaches the max, no more transfers are allowed.

Note that we only track the max num transfers if a) the max num transfers here is defined and not unlimited OR b) we need it for calculating the predetermined balances order (i.e. useXYZNumTransfers is set in the PredeterminedOrderCalculationMethod). Otherwise, we do not track the respective number of transfers

Extends#

• BaseNumberTypeClass<MaxNumTransfers<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iMaxNumTransfers<T>

Constructors#

Constructor#

new MaxNumTransfers<T>(msg): MaxNumTransfers<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:938

Parameters#

msg#

iMaxNumTransfers<T>

Returns#

MaxNumTransfers<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

amountTrackerId#

amountTrackerId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:935

The ID of the approval tracker. This is the key used to track tallies.

Implementation of#

iMaxNumTransfers.amountTrackerId

---

overallMaxNumTransfers#

overallMaxNumTransfers: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:931

The overall maximum number of transfers for the tokenIDs and ownershipTimes. Running tally that includes all transfers that match this approval.

Implementation of#

iMaxNumTransfers.overallMaxNumTransfers

---

perFromAddressMaxNumTransfers#

perFromAddressMaxNumTransfers: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:933

The maximum number of transfers for the tokenIDs and ownershipTimes for each from address. Running tally that includes all transfers from each unique from address that match this approval.

Implementation of#

iMaxNumTransfers.perFromAddressMaxNumTransfers

---

perInitiatedByAddressMaxNumTransfers#

perInitiatedByAddressMaxNumTransfers: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:934

The maximum number of transfers for the tokenIDs and ownershipTimes for each initiated by address. Running tally that includes all transfers from each unique initiated by address that match this approval.

Implementation of#

iMaxNumTransfers.perInitiatedByAddressMaxNumTransfers

---

perToAddressMaxNumTransfers#

perToAddressMaxNumTransfers: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:932

The maximum number of transfers for the tokenIDs and ownershipTimes for each to address. Running tally that includes all transfers from each unique to address that match this approval.

Implementation of#

iMaxNumTransfers.perToAddressMaxNumTransfers

---

resetTimeIntervals#

resetTimeIntervals: ResetTimeIntervals<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:936

The time intervals to reset the tracker at.

Implementation of#

iMaxNumTransfers.resetTimeIntervals

Methods#

clone()#

clone(): MaxNumTransfers

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

Deep copies the object and returns a new instance.

Returns#

MaxNumTransfers

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:952

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

MaxNumTransfers<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/approvals.ts:948

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

---

toProto()#

toProto(): MaxNumTransfers

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:956

Returns#

MaxNumTransfers

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): MaxNumTransfers<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:960

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MaxNumTransfers<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): MaxNumTransfers<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:968

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MaxNumTransfers<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): MaxNumTransfers<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:976

Type Parameters#

U#

U extends NumberType

Parameters#

item#

MaxNumTransfers

convertFunction#

(item) => U

Returns#

MaxNumTransfers<U>