Interface UPClientProvider

Public interface for UPClientProvider.

interface UPClientProvider {
    get accounts(): `0x${string}`[];
    get chainId(): number;
    get contextAccounts(): `0x${string}`[];
    get isConnected(): boolean;
    get isMiniApp(): Promise<boolean>;
    get isUPClientProvider(): boolean;
    addListener<T extends keyof UPClientProviderEvents>(
        event: T,
        fn: (
            ...args: ArgumentMap<UPClientProviderEvents>[Extract<
                T,
                keyof UPClientProviderEvents,
            >],
        ) => void,
        context?: any,
    ): this;
    emit<T extends keyof UPClientProviderEvents>(
        event: T,
        ...args: ArgumentMap<UPClientProviderEvents>[Extract<
            T,
            keyof UPClientProviderEvents,
        >],
    ): boolean;
    eventNames(): (keyof UPClientProviderEvents)[];
    listenerCount(event: keyof UPClientProviderEvents): number;
    listeners<T extends keyof UPClientProviderEvents>(
        event: T,
    ): (
        ...args: ArgumentMap<UPClientProviderEvents>[Extract<
            T,
            keyof UPClientProviderEvents,
        >],
    ) => void[];
    off<T extends keyof UPClientProviderEvents>(
        event: T,
        fn?: (
            ...args: ArgumentMap<UPClientProviderEvents>[Extract<
                T,
                keyof UPClientProviderEvents,
            >],
        ) => void,
        context?: any,
        once?: boolean,
    ): this;
    on<T extends keyof UPClientProviderEvents>(
        event: T,
        fn: (
            ...args: ArgumentMap<UPClientProviderEvents>[Extract<
                T,
                keyof UPClientProviderEvents,
            >],
        ) => void,
        context?: any,
    ): this;
    once<T extends keyof UPClientProviderEvents>(
        event: T,
        fn: (
            ...args: ArgumentMap<UPClientProviderEvents>[Extract<
                T,
                keyof UPClientProviderEvents,
            >],
        ) => void,
        context?: any,
    ): this;
    removeAllListeners(event?: keyof UPClientProviderEvents): this;
    removeListener<T extends keyof UPClientProviderEvents>(
        event: T,
        fn?: (
            ...args: ArgumentMap<UPClientProviderEvents>[Extract<
                T,
                keyof UPClientProviderEvents,
            >],
        ) => void,
        context?: any,
        once?: boolean,
    ): this;
    request(method: string, params?: any, clientParams?: any): Promise<any>;
    request(
        method: { method: string; params?: any },
        clientParams?: any,
    ): Promise<any>;
}

Accessors

  • get contextAccounts(): `0x${string}`[]
  • Additional context accounts provided by the parent connector. Inside of the universaleverything grid this will contain the account of the owner of the displayed grid (i.e. the owner of the profile being displayed.)

    Returns `0x${string}`[]

Methods

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: keyof UPClientProviderEvents

    Returns this

  • Parameters

    • method: string
    • Optionalparams: any
    • OptionalclientParams: any

    Returns Promise<any>

  • Parameters

    • method: { method: string; params?: any }
    • OptionalclientParams: any

    Returns Promise<any>