Class BitBadgesUserInfo<T>

BitBadgesUserInfo is the type for accounts returned by the BitBadges API. It includes all Docrmation about an account.

Remarks

Note that returned user Docs will only fetch what is requested. It is your responsibility to join the data together (paginations, etc). See documentation for helper functions, examples, and tutorials on handling this data and paginations.

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

accountNumber: T

The account number of the account

activity: TransferActivityDoc<T>[]

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

address: string

The native address of the account

addressLists: BitBadgesAddressList<T>[]

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

airdropped?: boolean

Indicates whether the account has claimed their airdrop.

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

The alias for the account.

Type declaration

  • Optional collectionId?: T
  • Optional listId?: string
approvalTrackers: ApprovalTrackerDoc<T>[]

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

approvedSignInMethods?: {
    discord?: {
        discriminator?: string;
        id: string;
        scopes: string[];
        username: string;
    };
    github?: {
        id: string;
        scopes: string[];
        username: string;
    };
    google?: {
        id: string;
        scopes: string[];
        username: string;
    };
    twitter?: {
        id: string;
        scopes: string[];
        username: string;
    };
}

Approved ways to sign in

Type declaration

  • Optional discord?: {
        discriminator?: string;
        id: string;
        scopes: string[];
        username: string;
    }
    • Optional discriminator?: string
    • id: string
    • scopes: string[]
    • username: string
  • Optional github?: {
        id: string;
        scopes: string[];
        username: string;
    }
    • id: string
    • scopes: string[]
    • username: string
  • Optional google?: {
        id: string;
        scopes: string[];
        username: string;
    }
    • id: string
    • scopes: string[]
    • username: string
  • Optional twitter?: {
        id: string;
        scopes: string[];
        username: string;
    }
    • id: string
    • scopes: string[]
    • username: string
avatar?: string

The avatar of the account.

balance?: CosmosCoin<T>

The balance of the account

btcAddress: string

The Bitcoin address of the account

The chain of the account.

claimAlerts: ClaimAlertDoc<T>[]

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

collected: BalanceDocWithDetails<T>[]

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

cosmosAddress: string

The Cosmos address of the account

createdAt?: T

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

customLinks?: iCustomLink[]

The custom links of the account

customPages?: {
    badges: CustomPage<T>[];
    lists: CustomListPage[];
}

The custom pages of the account

Type declaration

discord?: string

The Discord username of the account

ethAddress: string

The Eth address of the account

fetchedProfile?: boolean

Whether we have already fetched the profile or not

github?: string

The GitHub username of the account

hiddenBadges?: BatchBadgeDetailsArray<T>

The hidden badges of the account

hiddenLists?: string[]

The hidden lists of the account

latestSignedInChain?: SupportedChain

The latest chain the user signed in with

listsActivity: ListActivityDoc<T>[]

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

merkleChallenges: MerkleChallengeDoc<T>[]

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

notifications?: NotificationPreferences<T>

The notifications of the account

nsfw?: {
    [badgeId: string]: string;
}

Indicates whether the account is NSFW.

Type declaration

  • [badgeId: string]: string
profilePicUrl?: string

The profile picture URL of the account

pubKeyType: string

The public key type of the account

publicKey: string

The public key of the account

readme?: string

The readme of the account

reported?: {
    [badgeId: string]: string;
}

Indicates whether the account has been reported.

Type declaration

  • [badgeId: string]: string
reservedMap?: MapDoc<T>

The reserved map for the account. This is created and managed on-chain through the x/maps module.

resolvedName?: string

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

reviews: ReviewDoc<T>[]

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

secrets: iSecretDoc<T>[]

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

seenActivity?: T

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

sequence?: T

The sequence of the account

siwbbRequests: SIWBBRequestDoc<T>[]

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

socialConnections?: SocialConnections<T>

Social connections stored for the account

solAddress: string

The Solana address of the account.

telegram?: string

The Telegram username of the account

twitter?: string

The Twitter username of the account

username?: string

The username of the account

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

The views for this collection and their pagination Doc. Views will only include the doc _ids. Use the pagination to fetch more. To be used in conjunction with activity, announcements, reviews, owners, merkleChallenges, and approvalTrackers. 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.

Type declaration

  • [viewId: string]: {
        ids: string[];
        pagination: PaginationInfo;
        type: string;
    } | undefined
watchlists?: {
    badges: CustomPage<T>[];
    lists: CustomListPage[];
}

The watched lists of the account's portfolio

Type declaration

Methods

  • 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

    Parameters

    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

  • Fetch the user's information via an API request and updates the current BitBadgesUserInfo object. This will handle all paginations, etc. behind the scenes.

    Parameters

    Returns Promise<void>

  • Fetch badge balances for a collection and updates the user's collected array. Must pass in a valid API instance.

    Parameters

    • collectionId: T

    Returns undefined | BalanceArray<T>

    Example

    const res = await user.fetchBadgeBalances(api, 123n);
    console.log(res.balances);
  • Gets the badge balances for a user by address. Throws if not fetched yet. To fetch, use fetchBadgeBalances.

    Wrapper for getBadgeBalances that throws if not fetched yet.

    Parameters

    • collectionId: T

    Returns BalanceArray<T>

    Example

    const res = user.mustGetBadgeBalances(123n);
    console.log(res); // [{ ... }] Balances
  • Logic for updating the current BitBadgesUserInfo object with a new API response. If forceful is true, it will overwrite everything.

    Parameters

    Returns void