Class: PrecalculationOptions<T>

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

PrecalculationOptions defines the options for precalculating the balances.

Extends#

• BaseNumberTypeClass<PrecalculationOptions<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iPrecalculationOptions<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iPrecalculationOptions<T>

Returns#

PrecalculationOptions<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

overrideTimestamp?#

optional overrideTimestamp?: T

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

The timestamp to use for the transfer.

Implementation of#

iPrecalculationOptions.overrideTimestamp

---

scalingMultiplier?#

optional scalingMultiplier?: T

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

When > 0 and allowAmountScaling is true on the approval, all precalculated balance amounts are multiplied by this value. Must be <= maxScalingMultiplier. 0 or absent means no scaling (returns 1x base).

Implementation of#

iPrecalculationOptions.scalingMultiplier

---

tokenIdsOverride?#

optional tokenIdsOverride?: UintRangeArray<T>

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

The token IDs to use for the transfer.

Implementation of#

iPrecalculationOptions.tokenIdsOverride

Methods#

clone()#

clone(): PrecalculationOptions

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

Deep copies the object and returns a new instance.

Returns#

PrecalculationOptions

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PrecalculationOptions<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:407

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<U>(proto, convertFunction): PrecalculationOptions<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

proto#

PrecalculationOptions

convertFunction#

(item) => U

Returns#

PrecalculationOptions<U>