Interface iExchangeSIWBBAuthorizationCodeSuccessResponse<T>

interface iExchangeSIWBBAuthorizationCodeSuccessResponse<T extends NumberType> {
    access_token: string;
    access_token_expires_at?: T;
    address: string;
    attestations?: iAttestationsProof<T>[];
    bitbadgesAddress: string;
    chain: SupportedChain;
    ownershipRequirements?: AssetConditionGroup<T>;
    refresh_token?: string;
    refresh_token_expires_at?: T;
    token_type: string;
    verificationResponse?: { errorMessage?: string; success: boolean };
}

Type Parameters

Hierarchy (View Summary, Expand)

Properties

access_token access_token_expires_at? address attestations? bitbadgesAddress chain ownershipRequirements? refresh_token? refresh_token_expires_at? token_type verificationResponse?

Properties

access_token

access_token: string

The access token to use for the SIWBB request.

Optionalaccess_token_expires_at

access_token_expires_at?: T

The time at which the access token expires.

address

address: string

The user's address

Optionalattestations

attestations?: iAttestationsProof<T>[]

Derived data integrity proofs for any attestations requested.

bitbadgesAddress

bitbadgesAddress: string

The converted BitBadges address of params.address. This can be used as the unique identifier for the user (e.g. avoid duplicate sign ins from equivalent 0x and bb1 addresses).

chain

chain: SupportedChain

The chain of the address

OptionalownershipRequirements

ownershipRequirements?: AssetConditionGroup<T>

The ownership requirements for the user

Optionalrefresh_token

refresh_token?: string

The refresh token to use for the SIWBB request.

Optionalrefresh_token_expires_at

refresh_token_expires_at?: T

The time at which the refresh token expires.

token_type

token_type: string

The token type

OptionalverificationResponse

verificationResponse?: { errorMessage?: string; success: boolean }

Verification response

Type declaration

  • OptionalerrorMessage?: string

    Returns the response message returned from verification.

  • success: boolean

    Returns whether the current (message, signature) pair is valid and verified (i.e. signature is valid and any assets are owned).

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR