Class KeyringClient

Hierarchy (view full)

Implements

Constructors

constructor

Methods

approveRequest createAccount deleteAccount exportAccount filterAccountChains getAccount getAccountBalances getRequest listAccounts listRequests rejectRequest submitRequest updateAccount

Constructors

constructor

Methods

approveRequest

  • approveRequest(id, data?): Promise<void>

  • Parameters

    • id: string
    • data: Record<string, Json> = {}

    Returns Promise<void>

createAccount

  • createAccount(options?): Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }>

  • Parameters

    • options: Record<string, Json> = {}

    Returns Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }>

deleteAccount

  • deleteAccount(id): Promise<void>

  • Parameters

    • id: string

    Returns Promise<void>

exportAccount

  • exportAccount(id): Promise<Record<string, Json>>

  • Parameters

    • id: string

    Returns Promise<Record<string, Json>>

filterAccountChains

  • filterAccountChains(id, chains): Promise<string[]>

  • Parameters

    • id: string
    • chains: string[]

    Returns Promise<string[]>

getAccount

  • getAccount(id): Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }>

  • Parameters

    • id: string

    Returns Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }>

getAccountBalances

  • getAccountBalances(id, assets): Promise<Record<string, {
        amount: string;
        unit: string;
    }>>

  • Parameters

    • id: string
    • assets: string[]

    Returns Promise<Record<string, {
        amount: string;
        unit: string;
    }>>

getRequest

  • getRequest(id): Promise<{
        account: string;
        id: string;
        request: {
            method: string;
            params?: Json[] | Record<string, Json>;
        };
        scope: string;
    }>

  • Parameters

    • id: string

    Returns Promise<{
        account: string;
        id: string;
        request: {
            method: string;
            params?: Json[] | Record<string, Json>;
        };
        scope: string;
    }>

listAccounts

  • listAccounts(): Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }[]>

  • Returns Promise<{
        address: string;
        id: string;
        methods: string[];
        options: Record<string, Json>;
        type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
    }[]>

listRequests

  • listRequests(): Promise<{
        account: string;
        id: string;
        request: {
            method: string;
            params?: Json[] | Record<string, Json>;
        };
        scope: string;
    }[]>

  • Returns Promise<{
        account: string;
        id: string;
        request: {
            method: string;
            params?: Json[] | Record<string, Json>;
        };
        scope: string;
    }[]>

rejectRequest

  • rejectRequest(id): Promise<void>

  • Parameters

    • id: string

    Returns Promise<void>

submitRequest

  • submitRequest(request): Promise<{
        pending: true;
        redirect?: {
            message?: string;
            url?: string;
        };
    } | {
        pending: false;
        result: Json;
    }>

  • Parameters

    • request: {
          account: string;
          id: string;
          request: {
              method: string;
              params?: Json[] | Record<string, Json>;
          };
          scope: string;
      }
      • account: string

        Account ID (UUIDv4).

      • id: string

        Keyring request ID (UUIDv4).

      • request: {
            method: string;
            params?: Json[] | Record<string, Json>;
        }

        Inner request sent by the client application.

        • method: string
        • Optional params?: Json[] | Record<string, Json>
      • scope: string

        Request's scope (CAIP-2 chain ID).

    Returns Promise<{
        pending: true;
        redirect?: {
            message?: string;
            url?: string;
        };
    } | {
        pending: false;
        result: Json;
    }>

updateAccount

  • updateAccount(account): Promise<void>

  • Parameters

    • account: {
          address: string;
          id: string;
          methods: string[];
          options: Record<string, Json>;
          type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
      }
      • address: string

        Account main address.

      • id: string

        Account ID (UUIDv4).

      • methods: string[]

        Account supported methods.

      • options: Record<string, Json>

        Account options.

      • type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh"

        Account type.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorapproveRequestcreateAccountdeleteAccountexportAccountfilterAccountChainsgetAccountgetAccountBalancesgetRequestlistAccountslistRequestsrejectRequestsubmitRequestupdateAccount