Packages

@onmax/nimiq-mini-app-runtime

Runtime helpers that wait for and normalize the published Nimiq mini-app provider.

@onmax/nimiq-mini-app-runtime

This package wraps @nimiq/mini-app-sdk so app code can wait for window.nimiq and work against one normalized provider type.

Main exports

  • initMiniAppProvider(options)
  • waitForMiniAppProvider(options)
  • getMiniAppProvider(target?)
  • hasMiniAppProvider(target?)
  • isMiniAppProvider(value)
  • hasBlockNumberCapability(provider)
  • hasConsensusCapability(provider)

Main types

  • MiniAppProvider
  • MiniAppProviderSource
  • WaitForMiniAppProviderOptions
  • MiniAppProviderError
  • MiniAppSignResult

Example

runtime.ts
import { initMiniAppProvider } from '@onmax/nimiq-mini-app-runtime'

const provider = await initMiniAppProvider({ timeout: 10_000 })
const accounts = await provider.listAccounts()

Behavior

  • In the browser, the package first tries the published SDK init path.
  • When you provide a custom source or target, it falls back to polling until the provider appears.
  • Timeout errors are phrased for mini-app users who opened the app outside Nimiq Pay.
Copyright © 2026