Class: UserApprovalSettings<T>

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

UserApprovalSettings defines issuer-imposed constraints on user-level approvals. Set on collection-level ApprovalCriteria and propagated to user-level approvals.

Extends#

• BaseNumberTypeClass<UserApprovalSettings<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iUserApprovalSettings<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iUserApprovalSettings<T>

Returns#

UserApprovalSettings<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

allowedDenoms?#

optional allowedDenoms?: string[]

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

Restricts which denoms user-level coinTransfers can reference. If empty, all params-allowed denoms are permitted.

Implementation of#

iUserApprovalSettings.allowedDenoms

---

disableUserCoinTransfers?#

optional disableUserCoinTransfers?: boolean

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

If true, user-level approvals cannot trigger coinTransfers at all for transfers matched by this collection approval.

Implementation of#

iUserApprovalSettings.disableUserCoinTransfers

---

userRoyalties?#

optional userRoyalties?: UserRoyalties<T>

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

User-level royalties to enforce for transfers matched by this collection approval.

Implementation of#

iUserApprovalSettings.userRoyalties

Methods#

clone()#

clone(): UserApprovalSettings

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

Deep copies the object and returns a new instance.

Returns#

UserApprovalSettings

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserApprovalSettings<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/common/base.ts:157

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

Returns#

string[]

Inherited from#

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

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

Returns#

UserApprovalSettings

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserApprovalSettings<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

UserApprovalSettings<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

UserApprovalSettings

convertFunction#

(item) => U

Returns#

UserApprovalSettings<U>