Interface iPluginVersionConfig<T>

interface iPluginVersionConfig<T> {
    claimCreatorRedirect?: {
        toolUri?: string;
        tutorialUri?: string;
    };
    createdAt: T;
    duplicatesAllowed: boolean;
    finalized: boolean;
    lastUpdated: T;
    privateParamsSchema: JsonBodyInputSchema[];
    publicParamsSchema: JsonBodyInputSchema[];
    receiveStatusWebhook: boolean;
    requiresSessions: boolean;
    requiresUserInputs: boolean;
    reuseForNonIndexed: boolean;
    stateFunctionPreset: PluginPresetType;
    userInputRedirect?: {
        baseUri: string;
    };
    userInputsSchema: JsonBodyInputSchema[];
    verificationCall?: {
        hardcodedInputs: JsonBodyInputWithValue[];
        method:
            | "POST"
            | "GET"
            | "PUT"
            | "DELETE";
        passAddress?: boolean;
        passDiscord?: boolean;
        passEmail?: boolean;
        passFarcaster?: boolean;
        passGithub?: boolean;
        passGoogle?: boolean;
        passReddit?: boolean;
        passSlack?: boolean;
        passStrava?: boolean;
        passTelegram?: boolean;
        passTwitch?: boolean;
        passTwitter?: boolean;
        postProcessingJs: string;
        uri: string;
    };
    version: T;
}

Type Parameters

Implemented by

Properties

claimCreatorRedirect? createdAt duplicatesAllowed finalized lastUpdated privateParamsSchema publicParamsSchema receiveStatusWebhook requiresSessions requiresUserInputs reuseForNonIndexed stateFunctionPreset userInputRedirect? userInputsSchema verificationCall? version

Properties

OptionalclaimCreatorRedirect

claimCreatorRedirect?: {
    toolUri?: string;
    tutorialUri?: string;
}

createdAt

createdAt: T

The time the version was created

duplicatesAllowed

duplicatesAllowed: boolean

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

finalized

finalized: boolean

True if the version is finalized

lastUpdated

lastUpdated: T

The time the version was last updated

privateParamsSchema

privateParamsSchema: JsonBodyInputSchema[]

publicParamsSchema

publicParamsSchema: JsonBodyInputSchema[]

receiveStatusWebhook

receiveStatusWebhook: boolean

Whether the plugin should receive status webhooks

requiresSessions

requiresSessions: boolean

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

requiresUserInputs

requiresUserInputs: boolean

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

reuseForNonIndexed

reuseForNonIndexed: boolean

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

stateFunctionPreset

stateFunctionPreset: PluginPresetType

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

OptionaluserInputRedirect

userInputRedirect?: {
    baseUri: string;
}

userInputsSchema

userInputsSchema: JsonBodyInputSchema[]

OptionalverificationCall

verificationCall?: {
    hardcodedInputs: JsonBodyInputWithValue[];
    method:
        | "POST"
        | "GET"
        | "PUT"
        | "DELETE";
    passAddress?: boolean;
    passDiscord?: boolean;
    passEmail?: boolean;
    passFarcaster?: boolean;
    passGithub?: boolean;
    passGoogle?: boolean;
    passReddit?: boolean;
    passSlack?: boolean;
    passStrava?: boolean;
    passTelegram?: boolean;
    passTwitch?: boolean;
    passTwitter?: boolean;
    postProcessingJs: string;
    uri: string;
}

The verification URL

version

version: T

Version of the plugin

Settings

Member Visibility

On This Page

Properties