Interface Provider

Interface representing a provider for interacting with accounts and signing messages.

interface Provider {
    requestAccounts(): Promise<string[]>;
    getNetwork(): Promise<"livenet" | "testnet">;
    switchNetwork(chain: "livenet" | "testnet"): Promise<void>;
    getChain?(): Promise<{
        enum: string;
        name: string;
        network: string;
    }>;
    switchChain?(chain: string): Promise<{
        enum: string;
        name: string;
        network: string;
    }>;
    getAccounts(): Promise<string[]>;
    getPublicKey(): Promise<string>;
    signMessage(msg: string, type: "ecdsa" | "bip322-simple"): Promise<string>;
    on: UniSatA.OnMethod;
    removeListener(eventName: string, listener: ((...args: unknown[]) => unknown)): UniSatA.Provider;
}

Properties

on

Methods

requestAccounts getNetwork switchNetwork getChain? switchChain? getAccounts getPublicKey signMessage removeListener

Properties

on

on: UniSatA.OnMethod

Adds an event listener to the provider.

Methods

requestAccounts

  • requestAccounts(): Promise<string[]>

  • Requests user accounts.

    Returns Promise<string[]>

    A promise that resolves to an array of account addresses.

getNetwork

  • getNetwork(): Promise<"livenet" | "testnet">

  • Gets the current network.

    Returns Promise<"livenet" | "testnet">

    current network.

switchNetwork

  • switchNetwork(chain): Promise<void>

  • Switch the current network.

    Parameters

    • chain: "livenet" | "testnet"

    Returns Promise<void>

OptionalgetChain

  • getChain(): Promise<{
        enum: string;
        name: string;
        network: string;
    }>

  • Gets the current chain.

    Returns Promise<{
        enum: string;
        name: string;
        network: string;
    }>

    current chain.

OptionalswitchChain

  • switchChain(chain): Promise<{
        enum: string;
        name: string;
        network: string;
    }>

  • Switch the current chain.

    Parameters

    • chain: string

    Returns Promise<{
        enum: string;
        name: string;
        network: string;
    }>

getAccounts

  • getAccounts(): Promise<string[]>

  • Gets the current accounts.

    Returns Promise<string[]>

    A promise that resolves to an array of account addresses.

getPublicKey

  • getPublicKey(): Promise<string>

  • Gets the public key of the account.

    Returns Promise<string>

    A promise that resolves to the public key.

signMessage

  • signMessage(msg, type): Promise<string>

  • Signs a message with the specified type.

    Parameters

    • msg: string

      The message to sign.

    • type: "ecdsa" | "bip322-simple"

      The type of signature.

    Returns Promise<string>

    A promise that resolves to the signed message.

removeListener

  • removeListener(eventName, listener): UniSatA.Provider

  • Removes an event listener from the provider.

    Parameters

    • eventName: string

      The name of the event to remove the listener from.

    • listener: ((...args: unknown[]) => unknown)

      The listener function to remove.

        • (...args): unknown

        • Parameters

          • Rest...args: unknown[]

          Returns unknown

    Returns UniSatA.Provider

    The provider instance.

Settings

Member Visibility

On This Page

Properties
Methods