Class: UserRoyalties<T>

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

Extends#

• BaseNumberTypeClass<UserRoyalties<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iUserRoyalties<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iUserRoyalties<T>

Returns#

UserRoyalties<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

payoutAddress#

payoutAddress: string

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

The payout address for the royalties.

Implementation of#

iUserRoyalties.payoutAddress

---

percentage#

percentage: T

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

The percentage of the transfer amount to apply as royalties. 1 to 10000 represents basis points.

Implementation of#

iUserRoyalties.percentage

Methods#

clone()#

clone(): UserRoyalties

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

Deep copies the object and returns a new instance.

Returns#

UserRoyalties

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserRoyalties<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:1625

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

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

Returns#

UserRoyalties

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserRoyalties<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserRoyalties<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

UserRoyalties

convertFunction#

(item) => U

Returns#

UserRoyalties<U>