Interface iSIWBBRequestDoc<T>

interface iSIWBBRequestDoc<T> {
    _docId: string;
    _id?: string;
    address: string;
    attestationsPresentations: iAttestationsProof<T>[];
    chain: SupportedChain;
    clientId: string;
    code: string;
    cosmosAddress: string;
    createdAt: T;
    deletedAt?: T;
    description?: string;
    expiresAt: T;
    image?: string;
    name?: string;
    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>;
    redirectUri?: string;
    scopes: OAuthScopeDetails[];
}

Type Parameters

Hierarchy (view full)

  • Doc
    • iSIWBBRequestDoc

Implemented by

Properties

_docId _id? address attestationsPresentations chain clientId code cosmosAddress createdAt deletedAt? description? expiresAt image? name? otherSignIns? ownershipRequirements? 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

attestationsPresentations

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

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

cosmosAddress

cosmosAddress: string

The Cosmos address of the signer

createdAt

createdAt: T

The timestamp of when the signature was created (milliseconds since epoch)

Optional deletedAt

deletedAt?: T

If deleted, we still store temporarily for a period of time. We use a deletedAt timestamp to determine when to delete.

Optional description

description?: string

expiresAt

expiresAt: T

Optional image

image?: string

Optional name

name?: string

Optional otherSignIns

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

Other approved sign-ins at the time of this sign-in

Type declaration

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

Optional ownershipRequirements

ownershipRequirements?: AssetConditionGroup<T>

The badges / assets that must be owned by the user

Optional redirectUri

redirectUri?: string

The redirect URI of the app

scopes

scopes: OAuthScopeDetails[]

Settings

Member Visibility

Theme

On This Page

_docId_idaddressattestationsPresentationschainclientIdcodecosmosAddresscreatedAtdeletedAtdescriptionexpiresAtimagenameotherSignInsownershipRequirementsredirectUriscopes