Class SIWBBRequestDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_docId _id? address attestationsPresentations bitbadgesAddress chain clientId code createdAt deletedAt? description? expiresAt image? name? otherSignIns? redirectUri? scopes

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

address

address: string

The native address of the signer

attestationsPresentations

attestationsPresentations: AttestationsProof<T>[]

If required, you can additionally attach proof of attestations ot the auth flow. These can be used to prove sensitive information to verifiers.

bitbadgesAddress

bitbadgesAddress: string

The BitBadges address of the signer

chain

chain: SupportedChain

The native chain for the user

clientId

clientId: string

The client ID of the app that requested the signature

code

code: string

The actual code itself

createdAt

createdAt: T

The timestamp of when the signature was created (milliseconds since epoch)

OptionaldeletedAt

deletedAt?: T

If deleted, we still store temporarily for a period of time. We use a deletedAt timestamp to determine when to delete.

Optionaldescription

description?: string

expiresAt

expiresAt: T

Optionalimage

image?: string

Optionalname

name?: string

OptionalotherSignIns

otherSignIns?: {
    discord?: {
        discriminator?: string;
        id: string;
        username: string;
    };
    github?: {
        id: string;
        username: string;
    };
    google?: {
        id: string;
        username: string;
    };
    twitch?: {
        id: string;
        username: string;
    };
    twitter?: {
        id: string;
        username: string;
    };
}

Other approved sign-ins at the time of this sign-in

OptionalredirectUri

redirectUri?: string

The redirect URI of the app

scopes

scopes: OAuthScopeDetails[]

Methods

clone

convert

equals

  • equals<U>(other, normalizeNumberTypes?): boolean

  • 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>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

hasNumberFields

toJson

toJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods