Class: IncrementedBalances<T>

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

IncrementedBalances represents predetermined incremented balances for transfers of an approval. You can define a starting balance and increment the token IDs and owned times by a certain amount.

Extends#

• BaseNumberTypeClass<IncrementedBalances<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iIncrementedBalances<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iIncrementedBalances<T>

Returns#

IncrementedBalances<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

allowAmountScaling#

allowAmountScaling: boolean

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

When true, transfers can be any evenly divisible integer multiple of startBalances. coinTransfers scale by the same multiplier. All other fields must be zero/false/nil.

Implementation of#

iIncrementedBalances.allowAmountScaling

---

allowOverrideTimestamp#

allowOverrideTimestamp: boolean

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

Whether to allow the override timestamp to be used.

Implementation of#

iIncrementedBalances.allowOverrideTimestamp

---

allowOverrideWithAnyValidToken#

allowOverrideWithAnyValidToken: boolean

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

Whether to allow the override with any valid ID.

Implementation of#

iIncrementedBalances.allowOverrideWithAnyValidToken

---

durationFromTimestamp#

durationFromTimestamp: T

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

The number of unix milliseconds to approve starting from now. Incompatible with incrementOwnershipTimesBy.

Implementation of#

iIncrementedBalances.durationFromTimestamp

---

incrementOwnershipTimesBy#

incrementOwnershipTimesBy: T

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

The amount to increment the owned times by after each transfer. Incompatible with durationFromTimestamp.

Implementation of#

iIncrementedBalances.incrementOwnershipTimesBy

---

incrementTokenIdsBy#

incrementTokenIdsBy: T

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

The amount to increment the token IDs by after each transfer.

Implementation of#

iIncrementedBalances.incrementTokenIdsBy

---

maxScalingMultiplier#

maxScalingMultiplier: T

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

Maximum allowed scaling multiplier. Must be > 0 when allowAmountScaling is true. 0 means N/A (scaling disabled).

Implementation of#

iIncrementedBalances.maxScalingMultiplier

---

recurringOwnershipTimes#

recurringOwnershipTimes: RecurringOwnershipTimes<T>

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

The recurring ownership times for the approval.

Implementation of#

iIncrementedBalances.recurringOwnershipTimes

---

startBalances#

startBalances: BalanceArray<T>

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

The starting balances for each transfer. Order number corresponds to the number of times we increment.

Implementation of#

iIncrementedBalances.startBalances

Methods#

clone()#

clone(): IncrementedBalances

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

Deep copies the object and returns a new instance.

Returns#

IncrementedBalances

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

IncrementedBalances<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:680

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(): IncrementedBalances

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

Returns#

IncrementedBalances

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

IncrementedBalances<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

IncrementedBalances<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

IncrementedBalances

convertFunction#

(item) => U

Returns#

IncrementedBalances<U>