Class: UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:16

Extends#

• BaseNumberTypeClass<UserBalanceStore<T>>

Extended by#

• UserBalanceStoreWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iUserBalanceStore<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:25

Parameters#

data#

iUserBalanceStore<T>

Returns#

UserBalanceStore<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

autoApproveAllIncomingTransfers#

autoApproveAllIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:23

Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Implementation of#

iUserBalanceStore.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers#

autoApproveSelfInitiatedIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:22

Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Implementation of#

iUserBalanceStore.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers#

autoApproveSelfInitiatedOutgoingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:21

Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.

Implementation of#

iUserBalanceStore.autoApproveSelfInitiatedOutgoingTransfers

---

balances#

balances: BalanceArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:17

The user's balances.

Implementation of#

iUserBalanceStore.balances

---

incomingApprovals#

incomingApprovals: UserIncomingApproval<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:18

The user's incoming approvals.

Implementation of#

iUserBalanceStore.incomingApprovals

---

outgoingApprovals#

outgoingApprovals: UserOutgoingApproval<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:19

The user's outgoing approvals.

Implementation of#

iUserBalanceStore.outgoingApprovals

---

userPermissions#

userPermissions: UserPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:20

The user's permissions.

Implementation of#

iUserBalanceStore.userPermissions

Methods#

clone()#

clone(): UserBalanceStore

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

Deep copies the object and returns a new instance.

Returns#

UserBalanceStore

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:36

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

UserBalanceStore<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

---

toBech32Addresses()#

toBech32Addresses(prefix): UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:64

Parameters#

prefix#

string

Returns#

UserBalanceStore<T>

---

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

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:40

Returns#

UserBalanceStore

---

fromProto()#

static fromProto<T>(item, convertFunction): UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/core/userBalances.ts:44

Type Parameters#

T#

T extends NumberType

Parameters#

item#

UserBalanceStore

convertFunction#

(item) => T

Returns#

UserBalanceStore<T>