Reference
Public API exports
Named exports for every public package and subpath.
Use this page when you need to verify whether an import is public API. Every entry below comes from the package exports map and the corresponding source entry point.
Do not import files that are not listed here. Deep internal paths can change without a docs migration.
Mini app kit
Package: @onmax/nimiq-mini-app-kit
| Subpath | Public exports |
|---|---|
@onmax/nimiq-mini-app-kit | announceEip6963Provider, createMiniAppProviderRequestCoordinator, detectNuxtMiniAppProvider, discoverEip6963Providers, getMiniAppEthereumAccounts, getMiniAppEthereumProvider, getMiniAppProvider, getNimiqPayLanguage, hasBlockNumberCapability, hasConsensusCapability, hasMiniAppEthereumProvider, hasMiniAppProvider, initMiniAppEthereumProvider, initMiniAppProvider, isMiniAppEthereumProvider, isMiniAppProvider, isMiniAppProviderError, registerEip6963Provider, requestMiniAppEthereumAccount, resolveNimiqPayPreferredLanguage, resolveNuxtMiniAppProviderState, waitForMiniAppEthereumProvider, waitForMiniAppProvider |
@onmax/nimiq-mini-app-kit/dev | bootstrapMiniAppProvider, consumeSimulatedHostLaunchPayload, createBridgeEthereumProvider, createBridgeNimiqProvider, createSimulatedBlockingEthereumProvider, createSimulatedBlockingNimiqProvider, createSimulatedEthereumProvider, createSimulatedEthereumProviderController, createSimulatedHostBridgeEthereumProvider, createSimulatedHostBridgeNimiqProvider, createSimulatedHostRuntime, createSimulatedNimiqProvider, createSimulatedNimiqProviderController, createStubNimiqProvider, getSimulatedHostEthereumProviderConfig, getSimulatedHostLaunchPayload, getSimulatedHostProviderConfig, installSimulatedEthereumProvider, installSimulatedNimiqProvider, notifySimulatedClaimPaid, notifySimulatedMiniAppReady, parseSimulatedHostLaunchPayload, resolveSimulatedHostConfigFromEnv, serializeSimulatedHostLaunchPayload, waitForInjectedEthereumProvider, waitForInjectedNimiqProvider |
@onmax/nimiq-mini-app-kit/host-runtime | consumeSimulatedHostLaunchPayload, createSimulatedEthereumProviderErrorResponseMessage, createSimulatedEthereumProviderRequestMessage, createSimulatedEthereumProviderResponseMessage, createSimulatedHostRuntime, createSimulatedMiniAppClaimPaidMessage, createSimulatedMiniAppReadyMessage, createSimulatedProviderErrorResponseMessage, createSimulatedProviderRequestMessage, createSimulatedProviderResponseMessage, isSimulatedHostToMiniAppMessage, isSimulatedMiniAppToHostMessage, parseSimulatedHostLaunchPayload, serializeSimulatedHostLaunchPayload |
@onmax/nimiq-mini-app-kit/provider-request-coordinator | createMiniAppProviderRequestCoordinator |
@onmax/nimiq-mini-app-kit/nuxt | default Nuxt module export, applyNuxtMiniAppI18nBeforeLocaleSwitch, detectNuxtMiniAppProvider, resolveNuxtMiniAppI18nLocale, resolveNuxtMiniAppProviderState |
@onmax/nimiq-mini-app-kit/nuxt/runtime | applyNuxtMiniAppI18nBeforeLocaleSwitch, detectNuxtMiniAppProvider, resolveNuxtMiniAppBootstrapProvide, resolveNuxtMiniAppI18nLocale, resolveNuxtMiniAppProviderState |
Primary public types include MiniAppProvider, MiniAppProviderConfig, MiniAppProviderError, MiniAppSignResult, MiniAppTransactionInfo, MiniAppEthereumProvider, EIP6963ProviderDetail, EIP6963ProviderInfo, NuxtMiniAppProviderState, simulator input/result types, and Nuxt module option types.
app/imports.ts
import { waitForMiniAppProvider } from '@onmax/nimiq-mini-app-kit'
import { installSimulatedNimiqProvider } from '@onmax/nimiq-mini-app-kit/dev'
import { createSimulatedHostRuntime } from '@onmax/nimiq-mini-app-kit/host-runtime'
Better Auth Nimiq
Package: @onmax/better-auth-nimiq
| Subpath | Public exports |
|---|---|
@onmax/better-auth-nimiq | NIMIQ_AUTH_ACTIONS, NIMIQ_SIGN_PREFIX, buildNimiqApprovalChallengeEnvelope, buildNimiqApprovalChallengeMessage, buildNimiqChallengeMessage, buildNimiqLoginChallengeMessage, buildSignInMessage, bytesToBase64Url, bytesToHex, createDefaultNimiqSignatureVerifier, createInMemoryNonceStore, createNimiqAuthService, getNimiqAuthIdentity, getNimiqAuthIdentityExtension, getNimiqProvider, hasNimiqProvider, hashNimiqSignedMessage, hexToBytes, isNimiqProviderError, isValidNimiqAddress, issueNimiqApprovalChallenge, issueNimiqChallenge, issueNimiqLoginChallenge, nimiqAuth, normalizeEndpointPrefix, normalizeHexInput, normalizeNimiqAddress, normalizeNimiqSignatureProof, publicKeyToAddress, resolveNimiqApprovalChallengeAction, resolveNimiqAuthUser, verifyNimiqChallengeSignature, verifyNimiqSignedMessage |
@onmax/better-auth-nimiq/client | clearStoredNimiqAuthToken, createNimiqAuthClientHelpers, getStoredNimiqAuthToken, nimiqAuthClient, signInWithNimiq |
@onmax/better-auth-nimiq/kv | createKeyValueNimiqNonceStore |
@onmax/better-auth-nimiq/nuxt | ensureNimiqAuthSignedIn, useNimiqAuthIdentity, useNimiqAuthSession |
@onmax/better-auth-nimiq/nuxt-module | default Nuxt module export |
@onmax/better-auth-nimiq/provider | getNimiqProvider, getSingleFlightNimiqProvider, hasNimiqProvider, isNimiqProviderError |
@onmax/better-auth-nimiq/server | buildNimiqSignedMessageBytes, bytesToBase64Url, bytesToHex, createDefaultNimiqSignatureVerifier, hashNimiqSignedMessage, hexToBytes, isValidNimiqAddress, normalizeHexInput, normalizeNimiqAddress, publicKeyToAddress, verifyNimiqSignedMessage |
@onmax/better-auth-nimiq/server-core | buildSignedBasicTransactionHex, buildSignedBasicTransactionWithDataHex, deriveAddressFromPrivateKeyHex, derivePublicKeyFromPrivateKeyHex, loadNimiqCore |
@onmax/better-auth-nimiq/wallet | buildDeterministicCredentialMessage, deriveDeterministicCredentials, deriveDeterministicHandle, deriveDeterministicPassword, resolveWalletIdentity |
Primary public types include plugin options, nonce and verify payload types, client helper types, KV storage types, Nuxt composable options, wallet identity types, and verifier input types.
server/imports.ts
import { nimiqAuth } from '@onmax/better-auth-nimiq'
import { createKeyValueNimiqNonceStore } from '@onmax/better-auth-nimiq/kv'
import { signInWithNimiq } from '@onmax/better-auth-nimiq/client'
Cross-device approval
Packages: @onmax/better-auth-cross-device and @onmax/cross-device-nimiq
| Subpath | Public exports |
|---|---|
@onmax/better-auth-cross-device | CrossDeviceProofError, crossDevice |
@onmax/better-auth-cross-device/client | approveCrossDeviceIntent, approveCrossDeviceOrder, cancelCrossDeviceIntent, cancelCrossDeviceOrder, claimCrossDeviceIntent, claimCrossDeviceOrder, crossDeviceClient, finalizeCrossDeviceIntent, finalizeCrossDeviceOrder, getCrossDeviceChallenge, getCrossDeviceIntentChallenge, rejectCrossDeviceIntent, rejectCrossDeviceOrder, startCrossDeviceIntent, startCrossDeviceOrder, subscribeToCrossDeviceIntent, subscribeToCrossDeviceOrder |
@onmax/cross-device-nimiq | buildNimiqCrossDeviceChallengeMessage, buildNimiqCrossDeviceLoginMessage, buildNimiqCrossDeviceSignMessage, buildNimiqCrossDeviceTransactionMessage, createNimiqBrowserHandoff, createNimiqCrossDeviceAdapter, createNimiqMiniAppApprover, getNimiqApprovalEnvironment, normalizeNimiqCrossDeviceProof, normalizeNimiqCrossDeviceTransactionProof, parseCrossDeviceClaimUrl, resolveNimiqCrossDeviceAction |
@onmax/cross-device-nimiq/server | buildNimiqCrossDeviceChallengeMessage, buildNimiqCrossDeviceLoginMessage, buildNimiqCrossDeviceSignMessage, buildNimiqCrossDeviceTransactionMessage, createNimiqCrossDeviceAdapter, normalizeNimiqCrossDeviceProof, normalizeNimiqCrossDeviceTransactionProof, resolveNimiqCrossDeviceAction |
Primary public types include order lifecycle types, adapter contracts, start/claim/approve/finalize option types, Nimiq proof types, approver options, and transaction resolver types.
app/imports.ts
import { startCrossDeviceOrder } from '@onmax/better-auth-cross-device/client'
import { createNimiqMiniAppApprover } from '@onmax/cross-device-nimiq'
Utilities
Packages: @onmax/unimiq, @onmax/unerc20, and @onmax/better-auth-ledger
| Subpath | Public exports |
|---|---|
@onmax/unimiq | NIMIQ_MAINNET_NETWORK_ID, NIMIQ_SIGN_PREFIX, NIM_LUNA_PER_NIM, buildNimiqSignedMessageBytes, buildSignedBasicTransactionHex, buildSignedBasicTransactionWithDataHex, buildSignedTransactionHex, bytesToBase64Url, bytesToHex, createNimiq, deriveAddressFromPrivateKeyHex, derivePublicKeyFromPrivateKeyHex, fetchNimUsdRate, formatNimiqAddress, getRuntime, hashNimiqSignedMessage, hexToBytes, isValidNimiqAddress, loadNimiqCore, normalizeHexInput, normalizeNimiqAddress, publicKeyToAddress, signNimiqMessage, verifyNimiqSignedMessage |
@onmax/unimiq/mock | createMockNimiqDriver |
@onmax/unimiq/drivers | createMockNimiqDriver, createRpcNimiqDriver, createWebClientDriver |
@onmax/unimiq/vite | default Vite plugin export |
@onmax/unimiq/vue | NimiqAccount, NimiqAddress, NimiqAddressPill, NimiqIdenticon |
@onmax/unimiq/nuxt | default Nuxt module export |
@onmax/unimiq/experimental | createExperimentalViteEnvironmentConfig |
@onmax/unerc20 | ERC20_ABI, formatTokenAmountAtomic, parseTokenAmountToAtomic, readEvmNetwork, readErc20Balance, readErc20Decimals, readErc20Symbol, transferErc20 |
@onmax/better-auth-ledger | adjustLedger, captureLedgerReservation, creditLedger, debitLedger, getOrCreateLedgerAccount, ledger, ledgerSchema, normalizeLedgerEndpointPrefix, releaseLedgerReservation, reserveLedger |
@onmax/better-auth-ledger/client | getLedgerAccount, getLedgerBalance, ledgerClient, listLedgerEntries |
Primary public types include Nimiq facade and driver types, transaction and wallet types, token and provider types, ledger account/balance/entry/reservation types, ledger service options, and Vue component prop types.
app/imports.ts
import { createNimiq } from '@onmax/unimiq'
import { readErc20Balance } from '@onmax/unerc20'
import { ledger } from '@onmax/better-auth-ledger'
Testing helpers
Package: @onmax/better-auth-nimiq-pay-e2e
| Subpath | Public exports |
|---|---|
@onmax/better-auth-nimiq-pay-e2e | createBridgeNimiqProvider, createLocalAuthFetcher, createLocalQrAuthFetchers, createStubNimiqProvider, createVitestE2EConfig, defineE2EProfile, runQrSignInScenario, runSignInScenario |
@onmax/better-auth-nimiq-pay-e2e/providers | createBridgeNimiqProvider, createStubNimiqProvider |
@onmax/better-auth-nimiq-pay-e2e/vitest | createVitestE2EConfig |
Primary public types include E2E profiles, scenario options/results, provider wait options, local fetcher types, and Vitest config types.
test/imports.ts
import { runSignInScenario } from '@onmax/better-auth-nimiq-pay-e2e'
import { createStubNimiqProvider } from '@onmax/better-auth-nimiq-pay-e2e/providers'
import { createVitestE2EConfig } from '@onmax/better-auth-nimiq-pay-e2e/vitest'
Audit checklist
When public API changes, update this page in the same change:
- Check each package
exportsmap. - Check each exported source entry point.
- Add a minimal example to the module page when the export represents a new user-facing capability.
- Keep internal implementation files undocumented unless they are exposed through
package.json.