Interface FlowCreateMutation

Create a flow of the token of this class.

interface FlowCreateMutation {
    chainId: number;
    flowRateWei: string;
    overrides?: Overrides & {
        from?: string;
    };
    receiverAddress: string;
    senderAddress?: string;
    signer: Signer;
    superTokenAddress: string;
    transactionExtraData?: Record<string, unknown>;
    userDataBytes: undefined | string;
}

Hierarchy (view full)

Properties

chainId flowRateWei overrides? receiverAddress senderAddress? signer superTokenAddress transactionExtraData? userDataBytes

Properties

chainId

chainId: number

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

flowRateWei

flowRateWei: string

The specified flow rate.

Optional overrides

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

Type declaration

  • Optional from?: string

receiverAddress

receiverAddress: string

The receiver of the flow.

Optional senderAddress

senderAddress?: string

The sender of the flow. Signer is used when left empty.

signer

signer: Signer

superTokenAddress

superTokenAddress: string

SuperToken the mutation will affect.

Optional transactionExtraData

transactionExtraData?: Record<string, unknown>

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

userDataBytes

userDataBytes: undefined | string

Extra user data provided.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc