Type alias KeyStoreInteractor

Type declaration

• login: ((loginOptions) => Promise<SessionWithLogout>)

  Uses the underlying keystore to sign into the specified account

  Returns

  the authenticated temporary session

  • • (loginOptions): Promise<SessionWithLogout>

    • Parameters

      • loginOptions: LoginOptions

        the account to sign in to

      Returns Promise<SessionWithLogout>

• getAccounts:function

  • getAccounts(): Promise<Account[]>

  • Retrieves a list of Accounts associated with the signer. At most MAX_PAGE_SIZE. To fetch more Accounts, use getAccountsPaginated

    Returns Promise<Account[]>

• getAccountsPaginated:function

  • getAccountsPaginated(limit, cursor): Promise<PaginatedEntity<Account>>

  • Retrieves a list of Accounts associated with the signer as a paginated entity.

    Parameters

    • limit: number

      maximum page size
    • cursor: OptionalPageCursor

      where the page should start

    Returns Promise<PaginatedEntity<Account>>

• getSession:function

  • getSession(accountId): Promise<Session>

  • Creates a session object for the provided account id.

    Parameters

    • accountId: BufferId

      account id to create a session for

    Returns Promise<Session>

• hasActiveLogin:function

  • hasActiveLogin(loginOptions): Promise<boolean>

  • Allows checking whether calling login will result in an authentication request for the user or an old login key and auth descriptor will be reused.

    If an active session is found, calling login will not prompt the user to login again.

    rules field will NOT be validated against, except checking whether the auth descriptor has expired. This means that if the loginOptions ask for 5 minutes expiration, an auth descriptor expiring in 2 seconds will be deemed valid and reused by login

    Parameters

    • loginOptions: LoginOptions

    Returns Promise<boolean>

• onKeyStoreChanged:function

  • onKeyStoreChanged(callback): void

  • Register a callback that is invoked when the underlying keystore is changed. This could e.g., happen if the user switches account in MetaMask.

    Parameters

    • callback: ((newKeyStore) => void)

      the callback function to invoke when keystore changes

      • • (newKeyStore): void

        • Parameters

          • newKeyStore: null | KeyStoreInteractor

          Returns void

    Returns void