Interface iSIWBBRequestDoc<T>

interface iSIWBBRequestDoc<T extends NumberType> {
    _docId: string;
    _id?: string;
    address: string;
    attestations: iAttestationsProof<T>[];
    bitbadgesAddress: string;
    chain: SupportedChain;
    clientId: string;
    code: string;
    codeChallenge?: string;
    codeChallengeMethod?: "S256" | "plain";
    createdAt: T;
    deletedAt?: T;
    description?: string;
    expiresAt: T;
    image?: string;
    name?: string;
    redirectUri?: string;
    scopes: OAuthScopeDetails[];
}

Type Parameters

Hierarchy (View Summary, Expand)

  • Doc
    • iSIWBBRequestDoc

Implemented by

Properties

_docId _id? address attestations bitbadgesAddress chain clientId code codeChallenge? codeChallengeMethod? createdAt deletedAt? description? expiresAt image? name? redirectUri? scopes

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

attestations

attestations: iAttestationsProof<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

OptionalcodeChallenge

codeChallenge?: string

The code challenge for the SIWBB request (if used with PKCE).

OptionalcodeChallengeMethod

codeChallengeMethod?: "S256" | "plain"

The code challenge method for the SIWBB request (if used with PKCE).

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

OptionalredirectUri

redirectUri?: string

The redirect URI of the app

scopes

scopes: OAuthScopeDetails[]

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR