Interface: CodeGenQueryParams

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:105

Extends#

• AdditionalQueryParams

Properties#

claimId?#

optional claimId?: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:91

We will display this claim on the authorize screen. Just for display purpses. This is still to be checked by you post-authentication.

Inherited from#

AdditionalQueryParams.claimId

---

client_id#

client_id: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:113

The client ID to use for the SIWBB request. Must match the one in developer portal.

---

expectVerifySuccess?#

optional expectVerifySuccess?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:99

We will expect the claim verification to succeed. If false, we will not let user attempt to sign in.

Note: This is not a replacement for checking the claim on your side because users can manipulate the client-side URL parameters.

Inherited from#

AdditionalQueryParams.expectVerifySuccess

---

hideIfAlreadyClaimed?#

optional hideIfAlreadyClaimed?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:93

For the claimId, we will hide the claim if the user has already completed it (successCount >= 1).

Inherited from#

AdditionalQueryParams.hideIfAlreadyClaimed

---

redirect_uri?#

optional redirect_uri?: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:109

The redirect URI to redirect to after the user signs in. Must match the one in developer portal.

---

scope?#

optional scope?: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:121

The scopes to request (e.g. completeClaims,approveSignInWithBitBadges).

---

state?#

optional state?: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:117

The state to use for the SIWBB request.