Interface WidgetInput

Remarks

Widget input. ClaimWidgetConfigInputType is a type of the input

All these properties are specified in kebab-case according to the Web Components standard.

interface WidgetInput {
    distributorId: string;
    enableWalletPassthrough: boolean;
    endpoint: string;
    name: string;
    tokenDecimals: number;
    tokenSymbol: string;
    allowConnectBeforeStart?: boolean;
    cluster?: "mainnet" | "devnet";
    computePrice?: number;
    confirmator?: string;
    disableBackgroundUpdates?: boolean;
    lastClaimDate?: Date;
}

Properties

distributorId enableWalletPassthrough endpoint name tokenDecimals tokenSymbol allowConnectBeforeStart? cluster? computePrice? confirmator? disableBackgroundUpdates? lastClaimDate?

Properties

distributorId

distributorId: string = ...

Distributor ID / airdrop ID from Streamflow App.

Supports multiple IDs as a string separated by a comma ,. Multiple airdrops are usually used for a chunked distribution in case of a large number of recipients.

The supported use case is: An airdrop is chunked into several parts, and each part has the same start date; A recipient presented in a single chunk. In this scenario, a claimant (recipient) is able to see their specific allocation within one widget instance.

enableWalletPassthrough

enableWalletPassthrough: boolean = ...

Enable wallet passthrough. Tightly coupled with WidgetPublicApi

endpoint

endpoint: string = ...

RPC endpoint.

Use your own RPC endpoint that fits your needs and requirements. Default RPC used on this page is for demo purposes only and is not suitable for production.

name

name: string = ...

Not used internally, but it is required and may be used for identification if several widgets are presented on the same page

tokenDecimals

tokenDecimals: number = ...

Token decimals. It affects UI representation of the token amount

tokenSymbol

tokenSymbol: string = ...

Token symbol. Presented in the UI

Optional allowConnectBeforeStart

allowConnectBeforeStart?: boolean = ...

Allow connect before start. If set, then recipients are allowed to connect wallets before start and see their allocation. Disabled by default

Optional cluster

cluster?: "mainnet" | "devnet" = ...

protocol env: mainnet | devnet

Optional computePrice

computePrice?: number = ...

Compute price, Priority fee

Optional confirmator

confirmator?: string = ...

Confirmator text. User should agree to terms that you define here. If you want to use links, use markdown format such as link

Optional disableBackgroundUpdates

disableBackgroundUpdates?: boolean = ...

Disable polling for claim statuses in background. Disabling this option may lead to irrelevant state of the widget if claim happened outside of the app (in a separate tab, for instance). Background updates enabled by default

Optional lastClaimDate

lastClaimDate?: Date = ...

Last claim date, hint about the potential clawback date. Example: 2024-12-12T00:00:00.000Z

Settings

Member Visibility

Theme

On This Page

distributorIdenableWalletPassthroughendpointnametokenDecimalstokenSymbolallowConnectBeforeStartclustercomputePriceconfirmatordisableBackgroundUpdateslastClaimDate