Interface: PluginVersionConfigPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2361

Properties#

customDetailsDisplay?#

optional customDetailsDisplay?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2404

Custom details display for the plugin. Use {{publicParamKey}} to dynamically display the values of public parameters.

---

duplicatesAllowed#

duplicatesAllowed: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2369

Whether it makes sense for multiple of this plugin to be allowed

---

finalized#

finalized: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2363

Finalized

---

ignoreSimulations?#

optional ignoreSimulations?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2378

Ignore simulations?

---

privateParamsSchema?#

optional privateParamsSchema?: JsonBodyInputSchema[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2391

---

publicParamsSchema?#

optional publicParamsSchema?: JsonBodyInputSchema[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2390

---

receiveStatusWebhook#

receiveStatusWebhook: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2372

Whether the plugin should receive status webhooks

---

requireSignIn?#

optional requireSignIn?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2401

Require BitBadges sign-in to use the plugin?

---

requiresSessions#

requiresSessions: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2387

This means that the plugin can be used w/o any session cookies or authentication.

---

requiresUserInputs#

requiresUserInputs: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2384

This is a flag for being compatible with auto-triggered claims, meaning no user interaction is needed.

---

reuseForNonIndexed#

reuseForNonIndexed: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2381

Reuse for non-indexed?

---

skipProcessingWebhook?#

optional skipProcessingWebhook?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2375

Whether the plugin should skip processing webhooks. We will just auto-treat it as successful.

---

stateFunctionPreset#

stateFunctionPreset: PluginPresetType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2366

Preset type for how the plugin state is to be maintained.

---

userInputsSchema?#

optional userInputsSchema?: JsonBodyInputSchema[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2389

---

verificationCall?#

optional verificationCall?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:2394

The verification URL

hardcodedInputs#

hardcodedInputs: JsonBodyInputWithValue[]

passAddress?#

optional passAddress?: boolean

uri#

uri: string