@lukso/up-provider - v0.3.7
    Preparing search index...

    Interface UPProviderConnector

    API for provider connector

    interface UPProviderConnector {
        get allowedAccounts(): `0x${string}`[];
        set allowedAccounts(accounts: `0x${string}`[]): void;
        get chainId(): number;
        set chainId(chainId: number): void;
        get channels(): Map<string, UPClientChannel>;
        get contextAccounts(): `0x${string}`[];
        set contextAccounts(accounts: `0x${string}`[]): void;
        get provider(): UPProviderEndpoint;
        addListener<T extends "channelCreated">(
            event: T,
            fn: (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void,
            context?: any,
        ): this;
        close(): void;
        emit<T extends "channelCreated">(
            event: T,
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ): boolean;
        eventNames(): "channelCreated"[];
        getChannel(
            id: string | Window | HTMLIFrameElement | UPClientChannel | null,
        ): UPClientChannel | null;
        listenerCount(event: "channelCreated"): number;
        listeners<T extends "channelCreated">(
            event: T,
        ): (
            (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void
        )[];
        off<T extends "channelCreated">(
            event: T,
            fn?: (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void,
            context?: any,
            once?: boolean,
        ): this;
        on<T extends "channelCreated">(
            event: T,
            fn: (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void,
            context?: any,
        ): this;
        once<T extends "channelCreated">(
            event: T,
            fn: (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void,
            context?: any,
        ): this;
        removeAllListeners(event?: "channelCreated"): this;
        removeListener<T extends "channelCreated">(
            event: T,
            fn?: (
                ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                    T,
                    "channelCreated",
                >],
            ) => void,
            context?: any,
            once?: boolean,
        ): this;
        setAllowedAccounts(accounts: `0x${string}`[]): Promise<void>;
        setChainId(chainId: number): Promise<void>;
        setContextAccounts(accounts: `0x${string}`[]): Promise<void>;
        setupProvider(
            provider: UPProviderEndpoint,
            rpcUrls: string | string[],
        ): Promise<void>;
    }
    Index

    Accessors

    allowedAccounts chainId channels contextAccounts provider

    Methods

    addListener close emit eventNames getChannel listenerCount listeners off on once removeAllListeners removeListener setAllowedAccounts setChainId setContextAccounts setupProvider

    Accessors

    Methods

    • Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T
      • fn: (
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ) => void
      • Optionalcontext: any

      Returns this

    • Return an array listing the events for which the emitter has registered listeners.

      Returns "channelCreated"[]

    • Return the number of listeners listening to a given event.

      Parameters

      • event: "channelCreated"

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T

      Returns (
          (
              ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                  T,
                  "channelCreated",
              >],
          ) => void
      )[]

    • Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T
      • Optionalfn: (
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Add a listener for a given event.

      Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T
      • fn: (
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ) => void
      • Optionalcontext: any

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T
      • fn: (
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ) => void
      • Optionalcontext: any

      Returns this

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

      Parameters

      • Optionalevent: "channelCreated"

      Returns this

    • Remove the listeners of a given event.

      Type Parameters

      • T extends "channelCreated"

      Parameters

      • event: T
      • Optionalfn: (
            ...args: ArgumentMap<UPProviderConnectorEvents>[Extract<
                T,
                "channelCreated",
            >],
        ) => void
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Inject additional addresses into the client's accountsChanged event. Account[0] will be linked to the signed when making transactions. Starting at Account[1] is where additional addresses are injected. This routine injects on all connections. You can also inject using the channel's allowedAccounts method.

      Parameters

      • accounts: `0x${string}`[]

      Returns Promise<void>

    • Connect this provider externally. This will be called during initial construction but can be called at a later time if desired to re-initialize or tear down the connection.

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods