Interface: iSIWBBRequestDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1891

Extends#

• Doc

Type Parameters#

T#

T extends NumberType

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from#

Doc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from#

Doc._id

---

address#

address: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1898

The native address of the signer

---

bitbadgesAddress#

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1896

The BitBadges address of the signer

---

chain#

chain: SupportedChain

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1900

The native chain for the user

---

clientId#

clientId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1915

The client ID of the app that requested the signature

---

code#

code: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1893

The actual code itself

---

codeChallenge?#

optional codeChallenge?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1921

The code challenge for the SIWBB request (if used with PKCE).

---

codeChallengeMethod?#

optional codeChallengeMethod?: "S256" | "plain"

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1924

The code challenge method for the SIWBB request (if used with PKCE).

---

createdAt#

createdAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1910

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

---

deletedAt?#

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1912

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

---

description?#

optional description?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1903

---

expiresAt#

expiresAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1907

---

image?#

optional image?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1904

---

name?#

optional name?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1902

---

redirectUri?#

optional redirectUri?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1918

The redirect URI of the app

---

scopes#

scopes: OAuthScopeDetails[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1906