Interface iBitBadgesUserInfo<T>

interface iBitBadgesUserInfo<T extends NumberType> {
    _docId: string;
    _id?: string;
    accountNumber: T;
    activity: iTransferActivityDoc<T>[];
    address: string;
    addressLists: iBitBadgesAddressList<T>[];
    airdropped?: boolean;
    alias?: { collectionId?: T; listId?: string };
    approvalTrackers: iApprovalTrackerDoc<T>[];
    approvedSignInMethods?: {
        addresses?: { address: string; scopes: OAuthScopeDetails[] }[];
        discord?: {
            discriminator?: string;
            id: string;
            scopes: OAuthScopeDetails[];
            username: string;
        };
        facebook?: { id: string; scopes: OAuthScopeDetails[]; username: string };
        github?: { id: string; scopes: OAuthScopeDetails[]; username: string };
        google?: { id: string; scopes: OAuthScopeDetails[]; username: string };
        passwords?: {
            passwordHash: string;
            salt: string;
            scopes: OAuthScopeDetails[];
        }[];
        twitter?: { id: string; scopes: OAuthScopeDetails[]; username: string };
    };
    attestations: iAttestationDoc<T>[];
    avatar?: string;
    balance?: iCosmosCoin<T>;
    bannerImage?: string;
    bitbadgesAddress: string;
    bluesky?: string;
    btcAddress: string;
    chain: SupportedChain;
    challengeTrackers: iMerkleChallengeTrackerDoc<T>[];
    claimActivity?: iClaimActivityDoc<T>[];
    claimAlerts: iClaimAlertDoc<T>[];
    collected: iBalanceDocWithDetails<T>[];
    createdAt?: T;
    customLinks?: iCustomLink[];
    customPages?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<T>[];
        lists: iCustomListPage[];
    };
    discord?: string;
    embeddedWalletAddress?: string;
    ethAddress: string;
    fetchedProfile?: "full"
    | "partial";
    github?: string;
    hiddenBadges?: iBatchBadgeDetails<T>[];
    hiddenLists?: string[];
    latestSignedInChain?: SupportedChain;
    listActivity: iListActivityDoc<T>[];
    notifications?: iNotificationPreferences<T>;
    nsfw?: { reason: string };
    pointsActivity?: iPointsActivityDoc<T>[];
    profilePicUrl?: string;
    pubKeyType: string;
    publicKey: string;
    publicSocialConnections?: iSocialConnections<T>;
    readme?: string;
    reported?: { reason: string };
    resolvedName?: string;
    seenActivity?: T;
    sequence?: T;
    siwbbRequests: iSIWBBRequestDoc<T>[];
    socialConnections?: iSocialConnections<T>;
    solAddress: string;
    telegram?: string;
    twitter?: string;
    username?: string;
    views: {
        [viewId: string]:
            | undefined
            | { ids: string[]; pagination: PaginationInfo; type: string };
    };
    watchlists?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<T>[];
        lists: iCustomListPage[];
    };
}

Type Parameters

Hierarchy (View Summary, Expand)

Implemented by

Properties

_docId _id? accountNumber activity address addressLists airdropped? alias? approvalTrackers approvedSignInMethods? attestations avatar? balance? bannerImage? bitbadgesAddress bluesky? btcAddress chain challengeTrackers claimActivity? claimAlerts collected createdAt? customLinks? customPages? discord? embeddedWalletAddress? ethAddress fetchedProfile? github? hiddenBadges? hiddenLists? latestSignedInChain? listActivity notifications? nsfw? pointsActivity? profilePicUrl? pubKeyType publicKey publicSocialConnections? readme? reported? resolvedName? seenActivity? sequence? siwbbRequests socialConnections? solAddress telegram? twitter? username? views watchlists?

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

accountNumber

accountNumber: T

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

activity

activity: iTransferActivityDoc<T>[]

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

address

address: string

The native address of the account

addressLists

addressLists: iBitBadgesAddressList<T>[]

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

Optionalairdropped

airdropped?: boolean

Indicates whether the account has claimed their airdrop.

Optionalalias

alias?: { collectionId?: T; listId?: string }

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.

approvalTrackers

approvalTrackers: iApprovalTrackerDoc<T>[]

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

OptionalapprovedSignInMethods

approvedSignInMethods?: {
    addresses?: { address: string; scopes: OAuthScopeDetails[] }[];
    discord?: {
        discriminator?: string;
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    facebook?: { id: string; scopes: OAuthScopeDetails[]; username: string };
    github?: { id: string; scopes: OAuthScopeDetails[]; username: string };
    google?: { id: string; scopes: OAuthScopeDetails[]; username: string };
    passwords?: {
        passwordHash: string;
        salt: string;
        scopes: OAuthScopeDetails[];
    }[];
    twitter?: { id: string; scopes: OAuthScopeDetails[]; username: string };
}

Approved ways to sign in

attestations

attestations: iAttestationDoc<T>[]

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

Optionalavatar

avatar?: string

The avatar of the account.

Optionalbalance

balance?: iCosmosCoin<T>

The $BADGE balance of the account

OptionalbannerImage

bannerImage?: string

The banner image URL of the account

bitbadgesAddress

bitbadgesAddress: string

The BitBadges address of the account

Optionalbluesky

bluesky?: string

The Bluesky username of the account

btcAddress

btcAddress: string

The Bitcoin address of the account

chain

chain: SupportedChain

The chain of the account.

challengeTrackers

challengeTrackers: iMerkleChallengeTrackerDoc<T>[]

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

OptionalclaimActivity

claimActivity?: iClaimActivityDoc<T>[]

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

claimAlerts

claimAlerts: iClaimAlertDoc<T>[]

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

collected

collected: iBalanceDocWithDetails<T>[]

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

OptionalcreatedAt

createdAt?: T

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

OptionalcustomLinks

customLinks?: iCustomLink[]

The custom links of the account

OptionalcustomPages

customPages?: {
    attestations: iCustomListPage[];
    badges: iCustomPage<T>[];
    lists: iCustomListPage[];
}

The custom pages of the account

Optionaldiscord

discord?: string

The Discord username of the account

OptionalembeddedWalletAddress

embeddedWalletAddress?: string

Embedded wallet address

ethAddress

ethAddress: string

The Eth address of the account

OptionalfetchedProfile

fetchedProfile?: "full" | "partial"

Whether we have already fetched the profile or not

Optionalgithub

github?: string

The GitHub username of the account

OptionalhiddenBadges

hiddenBadges?: iBatchBadgeDetails<T>[]

The hidden badges of the account

OptionalhiddenLists

hiddenLists?: string[]

The hidden lists of the account

OptionallatestSignedInChain

latestSignedInChain?: SupportedChain

The latest chain the user signed in with

listActivity

listActivity: iListActivityDoc<T>[]

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

Optionalnotifications

notifications?: iNotificationPreferences<T>

The notifications of the account

Optionalnsfw

nsfw?: { reason: string }

Indicates whether the account is NSFW.

OptionalpointsActivity

pointsActivity?: iPointsActivityDoc<T>[]

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

OptionalprofilePicUrl

profilePicUrl?: string

The profile picture URL of the account

pubKeyType

pubKeyType: string

The public key type of the account

publicKey

publicKey: string

The public key of the account

OptionalpublicSocialConnections

publicSocialConnections?: iSocialConnections<T>

Public social connections stored for the account

Optionalreadme

readme?: string

The readme of the account

Optionalreported

reported?: { reason: string }

Indicates whether the account has been reported.

OptionalresolvedName

resolvedName?: string

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

OptionalseenActivity

seenActivity?: T

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

Optionalsequence

sequence?: T

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

siwbbRequests

siwbbRequests: iSIWBBRequestDoc<T>[]

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

OptionalsocialConnections

socialConnections?: iSocialConnections<T>

Social connections stored for the account

solAddress

solAddress: string

The Solana address of the account. Note: This may be empty if we do not have it yet. Solana -> BitBadges address conversions are one-way, and we cannot convert a BitBadges address to a Solana address without prior knowledge.

Optionaltelegram

telegram?: string

The Telegram username of the account

Optionaltwitter

twitter?: string

The Twitter username of the account

Optionalusername

username?: string

The username of the account

views

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

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.

Optionalwatchlists

watchlists?: {
    attestations: iCustomListPage[];
    badges: iCustomPage<T>[];
    lists: iCustomListPage[];
}

The watched lists of the account's portfolio

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR