Interface CreateSIWBBRequestPayload

interface CreateSIWBBRequestPayload {
    allowReuseOfBitBadgesSignIn: boolean;
    clientId: string;
    description: string;
    image: string;
    message: string;
    name: string;
    otherSignIns?: ("discord" | "github" | "google" | "twitter")[];
    publicKey?: string;
    redirectUri?: string;
    secretsPresentations?: iSecretsProof<NumberType>[];
    signature: string;
    state?: string;
}

Properties

allowReuseOfBitBadgesSignIn: boolean

Whether or not we should allow reuse of BitBadges sign-in in replacement of the signature

clientId: string

Client ID for the SIWBB request.

description: string

The description of the SIWBB request for display purposes.

image: string

The image of the SIWBB request for display purposes.

message: string

The original message that was signed.

name: string

The name of the SIWBB request for display purposes.

otherSignIns?: ("discord" | "github" | "google" | "twitter")[]

If defined, we will store the current sign-in details for these web2 connections along with the code

publicKey?: string

The public key of the signer (if needed). Only certain chains require this.

redirectUri?: string

Redirect URI if redirected after successful sign-in.

secretsPresentations?: iSecretsProof<NumberType>[]

If required, you can additionally add proof of secrets to the authentication flow. This proves sensitive information (e.g. GPAs, SAT scores, etc.) without revealing the information itself.

signature: string

The signature of the message

state?: string

State to be passed back to the redirect URI.