Interface iSiwbbChallenge<T>

interface iSiwbbChallenge<T> {
    address: string;
    attestationsPresentations?: iAttestationsProof<T>[];
    bitbadgesAddress: string;
    chain: SupportedChain;
    otherSignIns?: {
        discord?: {
            discriminator?: string;
            id: string;
            username: string;
        };
        github?: {
            id: string;
            username: string;
        };
        google?: {
            id: string;
            username: string;
        };
        twitter?: {
            id: string;
            username: string;
        };
    };
    ownershipRequirements?: AssetConditionGroup<T>;
    verificationResponse?: {
        errorMessage?: string;
        success: boolean;
    };
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

address attestationsPresentations? bitbadgesAddress chain otherSignIns? ownershipRequirements? verificationResponse?

Properties

address

address: string

The user's address

OptionalattestationsPresentations

attestationsPresentations?: 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

OptionalotherSignIns

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

Other sign-ins that were requested

OptionalownershipRequirements

ownershipRequirements?: AssetConditionGroup<T>

The ownership requirements for the user

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