bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface iExchangeSIWBBAuthorizationCodeSuccessResponse<T>

    interface iExchangeSIWBBAuthorizationCodeSuccessResponse<T extends NumberType> {
        access_token: string;
        access_token_expires_at?: T;
        address: string;
        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)

    Index

    Properties

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

    Properties

    access_token: string

    The access token to use for the SIWBB request.

    access_token_expires_at?: T

    The time at which the access token expires.

    address: string

    The user's address

    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: SupportedChain

    The chain of the address

    ownershipRequirements?: AssetConditionGroup<T>

    The ownership requirements for the user

    refresh_token?: string

    The refresh token to use for the SIWBB request.

    refresh_token_expires_at?: T

    The time at which the refresh token expires.

    token_type: string

    The token type

    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