Interface IndexUpdateSubscriptionUnitsMutation

Updates the units allocated to a Subscription.

interface IndexUpdateSubscriptionUnitsMutation {
    chainId: number;
    indexId: string;
    overrides?: Overrides & {
        from?: string;
    };
    signer: Signer;
    subscriberAddress: string;
    superTokenAddress: string;
    transactionExtraData?: Record<string, unknown>;
    unitsNumber: string;
    userDataBytes: undefined | string;
}

Hierarchy (view full)

Properties

chainId: number

The network's chain ID where transactions will be broadcast.

indexId: string

The id of the index.

overrides?: Overrides & {
    from?: string;
}

Type declaration

  • Optional from?: string
signer: Signer
subscriberAddress: string

The subscriber address whose units you want to update.

superTokenAddress: string

SuperToken the mutation will affect.

transactionExtraData?: Record<string, unknown>

Custom data to included in transaction tracking. Has to be serializable for redux!

unitsNumber: string

The amount of units you want to update to.

userDataBytes: undefined | string

Extra user data provided.

Generated using TypeDoc