Skip to content

Interface: iBitBadgesUserInfo<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:40

Extends

Type Parameters

T

T extends NumberType

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from

iProfileDoc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from

iProfileDoc._id

accountNumber

accountNumber: T

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

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.

Inherited from

iAccountDoc.accountNumber

activity

activity: iTransferActivityDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:52

A list of transfer activity items for the account. Paginated and fetched as needed. To be used in conjunction with views.

address

address: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:65

The native address of the account

airdropped?

optional airdropped?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:48

Indicates whether the account has claimed their airdrop.

alias?

optional alias?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:88

For advanced cases where you want a custom address or account for a collection or list. We map it to an account.

Experimental - For example, if you want to send a badge to a collection, you can transfer it to the alias account.

collectionId?

optional collectionId?: string

approvalTrackers

approvalTrackers: iApprovalTrackerDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:60

A list of approvals tracker activity items for the account. Paginated and fetched as needed. To be used in conjunction with views.

avatar?

optional avatar?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:44

The avatar of the account.

balances?

optional balances?: iCosmosCoin<T>[]

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

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

Inherited from

iAccountDoc.balances

bannerImage?

optional bannerImage?: string

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

The banner image URL of the account

Inherited from

iProfileDoc.bannerImage

bitbadgesAddress

bitbadgesAddress: string

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

The BitBadges address of the account

Inherited from

iAccountDoc.bitbadgesAddress

chain

chain: SupportedChain

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:46

The chain of the account.

challengeTrackers

challengeTrackers: iMerkleChallengeTrackerDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:58

A list of merkle challenge activity items for the account. Paginated and fetched as needed. To be used in conjunction with views.

claimActivity?

optional claimActivity?: iClaimActivityDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:54

A list of claim activity items for the account. Paginated and fetched as needed. To be used in conjunction with views.

collected

collected: iBalanceDocWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:50

A list of tokens that the account has collected. Paginated and fetched as needed. To be used in conjunction with views.

createdAt?

optional createdAt?: T

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

The timestamp of when this account was created (milliseconds since epoch)

Inherited from

iProfileDoc.createdAt

creatorCredits?

optional creatorCredits?: iCreatorCreditsDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:93

The credits for the account.

discord?

optional discord?: string

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

The Discord username of the account

Inherited from

iProfileDoc.discord

ethAddress

ethAddress: string

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

The Eth address of the account

Inherited from

iAccountDoc.ethAddress

fetchedProfile?

optional fetchedProfile?: "full" | "partial"

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

Whether we have already fetched the profile or not

Inherited from

iProfileDoc.fetchedProfile

github?

optional github?: string

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

The GitHub username of the account

Inherited from

iProfileDoc.github

hiddenTokens?

optional hiddenTokens?: iBatchTokenDetails<T>[]

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

The hidden tokens of the account

Inherited from

iProfileDoc.hiddenTokens

latestSignedInChain?

optional latestSignedInChain?: SupportedChain

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

The latest chain the user signed in with

Inherited from

iProfileDoc.latestSignedInChain

notifications?

optional notifications?: iNotificationPreferences<T>

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

The notifications of the account

Inherited from

iProfileDoc.notifications

nsfw?

optional nsfw?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:68

Indicates whether the account is NSFW.

reason

reason: string

pointsActivity?

optional pointsActivity?: iPointsActivityDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:56

A list of points activity items for the account. Paginated and fetched as needed. To be used in conjunction with views.

profilePicUrl?

optional profilePicUrl?: string

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

The profile picture URL of the account

Inherited from

iProfileDoc.profilePicUrl

pubKeyType

pubKeyType: string

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

The public key type of the account

Inherited from

iAccountDoc.pubKeyType

publicKey

publicKey: string

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

The public key of the account

Inherited from

iAccountDoc.publicKey

readme?

optional readme?: string

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

The readme of the account

Inherited from

iProfileDoc.readme

reported?

optional reported?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:70

Indicates whether the account has been reported.

reason

reason: string

resolvedName?

optional resolvedName?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:42

The resolved name of the account (e.g. ENS name).

seenActivity?

optional seenActivity?: T

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

The timestamp of the last activity seen for this account (milliseconds since epoch)

Inherited from

iProfileDoc.seenActivity

sequence?

optional sequence?: T

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

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.

Inherited from

iAccountDoc.sequence

siwbbRequests

siwbbRequests: iSIWBBRequestDoc<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:62

A list of SIWBB requests for the account. Paginated and fetched as needed. To be used in conjunction with views.

tags?

optional tags?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:96

The tags for the account. Extra descriptors for what this address is used for (e.g. "Pool", "Governance", etc).

telegram?

optional telegram?: string

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

The Telegram username of the account

Inherited from

iProfileDoc.telegram

twitter?

optional twitter?: string

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

The Twitter username of the account

Inherited from

iProfileDoc.twitter

username?

optional username?: string

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

The username of the account

Inherited from

iProfileDoc.username

views

views: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/BitBadgesUserInfo.ts:73

The views for this collection and their pagination Doc. Views will only include the doc _ids. Use the pagination to fetch more. For example, if you want to fetch the activity for a view, you would use the view's pagination to fetch the doc _ids, then use the corresponding activity array to find the matching docs.

Index Signature

[viewId: string]: { ids: string[]; pagination: PaginationInfo; type: string; } | undefined

Edit this page on GitHub