Class: AccountDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:425

Extends#

• BaseNumberTypeClass<AccountDoc<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iAccountDoc<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:436

Parameters#

data#

iAccountDoc<T>

Returns#

AccountDoc<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:426

A unique stringified document ID

Implementation of#

iAccountDoc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:427

A unique document ID (Mongo DB ObjectID)

Implementation of#

iAccountDoc._id

---

accountNumber#

accountNumber: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:429

The account number of the account. This is the account number registered on the BitBadges blockchain.

WARNING (BB-34): post-v34 accounts get hash-derived account numbers larger than 2^53, which a JS number cannot hold. Use BigIntify or Stringify when converting docs that carry this field — Numberify silently corrupts it and the corrupted value is rejected by the signing pipeline.

Implementation of#

iAccountDoc.accountNumber

---

balances?#

optional balances?: CosmosCoin<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:434

The BADGE balance of the account and other sdk.coin balances

Implementation of#

iAccountDoc.balances

---

bitbadgesAddress#

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:431

The BitBadges address of the account

Implementation of#

iAccountDoc.bitbadgesAddress

---

ethAddress#

ethAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:432

The Eth address of the account

Implementation of#

iAccountDoc.ethAddress

---

pubKeyType#

pubKeyType: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:430

The public key type of the account

Implementation of#

iAccountDoc.pubKeyType

---

publicKey#

publicKey: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:428

The public key of the account

Implementation of#

iAccountDoc.publicKey

---

sequence?#

optional sequence?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:433

The sequence of the account. This is the nonce for the blockchain for this account.

WARNING (BB-34): post-v34 unordered-tx nonces can be nanosecond timestamps larger than 2^53 — same rule as accountNumber: convert with BigIntify/Stringify, never Numberify.

Implementation of#

iAccountDoc.sequence

Methods#

clone()#

clone(): AccountDoc

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

Deep copies the object and returns a new instance.

Returns#

AccountDoc

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:453

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

AccountDoc<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/api-indexer/docs-types/docs.ts:449

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