Class: PluginVersionConfig<T>

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

Extends#

• BaseNumberTypeClass<PluginVersionConfig<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iPluginVersionConfig<T>

Constructors#

Constructor#

new PluginVersionConfig<T>(data): PluginVersionConfig<T>

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

Parameters#

data#

iPluginVersionConfig<T>

Returns#

PluginVersionConfig<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

createdAt#

createdAt: T

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

The time the version was created

Implementation of#

iPluginVersionConfig.createdAt

---

customDetailsDisplay?#

optional customDetailsDisplay?: string

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

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

Implementation of#

iPluginVersionConfig.customDetailsDisplay

---

duplicatesAllowed#

duplicatesAllowed: boolean

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

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

Implementation of#

iPluginVersionConfig.duplicatesAllowed

---

finalized#

finalized: boolean

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

True if the version is finalized

Implementation of#

iPluginVersionConfig.finalized

---

ignoreSimulations?#

optional ignoreSimulations?: boolean

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

Ignore simulations?

Implementation of#

iPluginVersionConfig.ignoreSimulations

---

lastUpdated#

lastUpdated: T

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

The time the version was last updated

Implementation of#

iPluginVersionConfig.lastUpdated

---

privateParamsSchema#

privateParamsSchema: JsonBodyInputSchema[]

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

Implementation of#

iPluginVersionConfig.privateParamsSchema

---

publicParamsSchema#

publicParamsSchema: JsonBodyInputSchema[]

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

Implementation of#

iPluginVersionConfig.publicParamsSchema

---

receiveStatusWebhook#

receiveStatusWebhook: boolean

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

Whether the plugin should receive status webhooks

Implementation of#

iPluginVersionConfig.receiveStatusWebhook

---

requireSignIn?#

optional requireSignIn?: boolean

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

Require BitBadges sign-in to use the plugin?

Implementation of#

iPluginVersionConfig.requireSignIn

---

requiresSessions#

requiresSessions: boolean

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

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

Implementation of#

iPluginVersionConfig.requiresSessions

---

requiresUserInputs#

requiresUserInputs: boolean

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

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

Implementation of#

iPluginVersionConfig.requiresUserInputs

---

reuseForNonIndexed#

reuseForNonIndexed: boolean

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

Reuse for nonindexed balances? Only applicable if is stateless, requires no user inputs, and requires no sessions.

Implementation of#

iPluginVersionConfig.reuseForNonIndexed

---

skipProcessingWebhook?#

optional skipProcessingWebhook?: boolean

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

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

Implementation of#

iPluginVersionConfig.skipProcessingWebhook

---

stateFunctionPreset#

stateFunctionPreset: PluginPresetType

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

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

Implementation of#

iPluginVersionConfig.stateFunctionPreset

---

userInputsSchema#

userInputsSchema: JsonBodyInputSchema[]

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

Implementation of#

iPluginVersionConfig.userInputsSchema

---

verificationCall?#

optional verificationCall?: object

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

The verification URL config. This lets us know what should be passed to the plugin payload.

hardcodedInputs#

hardcodedInputs: JsonBodyInputWithValue[]

passAddress?#

optional passAddress?: boolean

uri#

uri: string

Implementation of#

iPluginVersionConfig.verificationCall

---

version#

version: T

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

Version of the plugin

Implementation of#

iPluginVersionConfig.version

Methods#

clone()#

clone(): PluginVersionConfig<T>

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

Deep copies the object and returns a new instance.

Returns#

PluginVersionConfig<T>

Overrides#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): PluginVersionConfig<U>

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PluginVersionConfig<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString