Skip to content

Latest commit

 

History

History
1875 lines (1126 loc) · 55.7 KB

modules.md

File metadata and controls

1875 lines (1126 loc) · 55.7 KB
Raw

nomo-webon-kit / Exports

nomo-webon-kit

Table of contents

Interfaces

Type Aliases

Variables

Functions

Type Aliases

NomoCoinType

Ƭ NomoCoinType: "btc" | "ltc" | "ec8" | "bch" | "zeniq"

Defined in

nomo_web3.ts:450

NomoEvmNetwork

Ƭ NomoEvmNetwork: "zeniq-smart-chain" | "ethereum" | "binance-smart-chain"

Defined in

nomo_web3.ts:10

NomoExecutionMode

Ƭ NomoExecutionMode: "PRODUCTION" | "DEV" | "DEV_DEV" | "FALLBACK"

Defined in

nomo_platform.ts:8

NomoHostingMode

Ƭ NomoHostingMode: "NOMO_INTEGRATED_HOSTING" | "EXTERNAL_HOSTING"

Defined in

nomo_platform.ts:9

NomoNetwork

Ƭ NomoNetwork: NomoEvmNetwork | "bitcoin" | "zeniq" | "litecoin" | "bitcoincash"

Defined in

nomo_web3.ts:14

NomoTheme

Ƭ NomoTheme: "LIGHT" | "DARK" | "AVINOC" | "XERA"

The themes that are supported by the Nomo App.

Defined in

nomo_theming.ts:6

NomoWebView

Ƭ NomoWebView: "webview_flutter" | "webview_cef" | "not_in_nomo_app"

Defined in

nomo_platform.ts:10

Variables

nomo

• Const nomo: Object

The nomo-object exposes WebOn-functions in an easy-to-use way. The nomo-object can be used with only one import and supports the auto-completion of IDEs.

Type declaration

Name Type
addCustomToken (args: NomoAssetSelector & { contractAddress: string ; network: NomoEvmNetwork }) => Promise<void>
authFetch (args: { body?: string | { [key: string]: any; } ; headers?: { [key: string]: string; } ; method?: "GET" | "POST" ; signer?: (args: { message: string ; url: string }) => Promise<{ authAddress: string ; authSig: string ; ethAddress: string ; ethSig: string }> ; url: string }) => Promise<{ response: string ; statusCode: number }>
authHttp (args: string | { body?: string | { [key: string]: any; } ; headers?: { [key: string]: string; } ; method?: "GET" | "POST" ; url: string }) => Promise<{ response: string ; statusCode: number }>
checkForWebOnUpdate () => Promise<void>
disableFallbackWallet () => void
enableMobileConsoleDebugging () => Promise<void>
fallbackQRCode () => void
getAllAssets () => Promise<{ assets: NomoAsset[] }>
getAssetIcon (args: NomoAssetSelector) => Promise<{ isPending: boolean ; large: string ; name: string ; small: string ; symbol: string ; thumb: string }>
getAssetPrice (args: NomoAssetSelector) => Promise<{ currencyDisplayName: string ; currencySymbol: string ; price: number }>
getBalance (args: NomoAssetSelector) => Promise<NomoAsset & { balance: string }>
getBalanceWaitUntilSynced (args: NomoAssetSelector) => Promise<NomoAsset & { balance: string }>
getCurrentNomoTheme () => Promise<{ colors: { background: string ; disabledColor: string ; error: string ; foreground1: string ; foreground2: string ; foreground3: string ; onPrimary: string ; onSecondary: string ; primary: string ; primaryContainer: string ; secondary: string ; secondaryContainer: string ; settingsColumnColor: string ; settingsTileColor: string ; snackBarColor: string ; surface: string } ; displayName: string ; name: string }>
getDeviceHashes () => Promise<{ deviceHashes: string }>
getDeviceName () => Promise<{ deviceName: string }>
getEvmAddress () => Promise<string>
getExecutionMode () => Promise<{ executionMode: NomoExecutionMode ; hostingMode: NomoHostingMode | null ; webView: NomoWebView }>
getExtendedPublicKey (args: NomoAssetSelector) => Promise<any>
getInstalledWebOns () => Promise<{ manifests: NomoManifest[] }>
getLanguage () => Promise<{ language: string }>
getManifest () => Promise<NomoManifest>
getMessengerAddress () => Promise<{ inviteLink: string ; messengerAddress: string }>
getNFTContracts () => Promise<{ nftContracts: string[] }>
getPlatformInfo () => Promise<{ appName: string ; buildNumber: string ; clientName: string ; operatingSystem: string ; version: string }>
getTransactions (args: NomoAssetSelector) => Promise<{ contractAddress?: string ; decimals: number ; name: string ; network: string ; symbol: string ; txs: any[] }>
getVisibleAssets () => Promise<{ visibleAssets: NomoAsset[] }>
getWalletAddresses () => Promise<{ walletAddresses: Record<string, string> }>
getWebOnParameters () => Promise<{ [key: string]: any; }>
hasMinimumNomoVersion (args: { minVersion: string }) => Promise<{ minVersionFulfilled: boolean ; nomoVersion: string }>
injectNomoCSSVariables () => Promise<void>
injectQRCode (args: { navigateBack: boolean ; qrCode: string }) => Promise<void>
installUrlAsWebOn (args: { manifest: NomoManifest ; navigateBack: boolean ; skipPermissionDialog: boolean }) => Promise<void>
installWebOn (args: { backgroundInstall?: boolean ; deeplink: string ; navigateBack?: boolean ; skipPermissionDialog?: boolean }) => Promise<void>
launchSmartchainFaucet () => Promise<void>
launchUrl (args: { launchMode: "platformDefault" | "inAppWebView" | "externalApplication" | "externalNonBrowserApplication" ; url: string }) => Promise<any>
launchUrlAsWebOn (args: { manifest: NomoManifest }) => Promise<any>
launchWebOn (args: { manifest: NomoManifest ; payload: string }) => Promise<void>
localStorage { getItem: (key: string, options?: { webon_id: string }) => Promise<null | String> ; removeItem: (key: string) => Promise<void> ; setItem: (key: string, value: string) => Promise<void> }
localStorage.getItem (key: string, options?: { webon_id: string }) => Promise<null | String>
localStorage.removeItem (key: string) => Promise<void>
localStorage.setItem (key: string, value: string) => Promise<void>
migrateAndSelfDestroy (args: { new_deeplink: string }) => Promise<void>
mnemonicBackupExisted () => Promise<{ mnemonicBackupExisted: boolean }>
openFAQPage (args: { faqContent: Record<string, Record<string, string>> ; initiallyExpanded: boolean ; supportButtonTitle?: string ; supportButtonUrl?: string }) => Promise<void>
pickFromGallery (args?: { imageQuality?: number ; maxHeight?: number ; maxWidth?: number }) => Promise<{ imageBase64: string ; path: string }>
proofOfPayment (args: { coin: NomoCoinType ; hash: string ; nonce?: string }) => Promise<NomoProofOfPayment>
proofOfWork (args: { challenge: string ; shaInputPrefix: string }) => Promise<{ shaInput: string }>
qrScan () => Promise<{ qrCode: string }>
registerOnWebOnVisible (callback: () => void) => Promise<void>
replaceWebOn (args: { navigateBack: boolean ; new_deeplink: string ; old_webon_url: string }) => Promise<void>
runsAsWebOn () => boolean
selectAssetFromDialog () => Promise<{ selectedAsset: NomoAsset & { balance: string } }>
selectAssets (args: NomoAssetSelector) => Promise<{ selectedAssets: NomoAsset[] }>
sendAssets (args: { amount?: string ; asset?: NomoAssetSelector ; targetAddress?: string }) => Promise<{ hash: string ; intent: { amount: string ; recipient: string ; token: string } }>
setAssetVisiblity (args: { asset: NomoAssetSelector ; visible: boolean }) => Promise<void>
setWebOnParameters (args: { urlParams: { [key: string]: any; } }) => Promise<void>
share (args: { subject?: string ; text?: string }) => Promise<void>
signAuthMessage (args: { message: string ; url: string }) => Promise<{ authAddress: string ; authSig: string ; ethAddress: string ; ethSig: string }>
signEvmMessage (args: { message: string }) => Promise<{ sigHex: string }>
signEvmTransaction (args: { messageHex: string }) => Promise<{ sigHex: string ; txHex: string }>
subscribeNotification (args: { topic: string }) => Promise<void>
switchNomoTheme (args: { theme: NomoTheme }) => Promise<void>
takePicture (args?: { imageQuality?: number ; maxHeight?: number ; maxWidth?: number }) => Promise<{ imageBase64: string ; path: string }>
uninstallWebOn (args: { webon_url: string }) => Promise<void>

Defined in

nomo_api.ts:12

nomoConsole

• Const nomoConsole: Object

A set of logging-functions to enable debugging with the Nomo dev mode. You should not need to call this directly, since it will be called automatically when calling console.log/console.error/console.warn/console.info.

Type declaration

Name Type
error (...args: any[]) => void
info (...args: any[]) => void
log (...args: any[]) => void
warn (...args: any[]) => void

Defined in

nomo_platform.ts:156

nomoLocalStorage

• Const nomoLocalStorage: Object

nomoLocalStorage provides a mechanism for sharing data between WebOns. If a webon_id is passed to nomoLocalStorage.getItem, then it tries to read data from another WebOn with the given webon_id. nomoLocalStorage can also be used as an alternative to the regular localStorage.

Type declaration

Name Type
getItem (key: string, options?: { webon_id: string }) => Promise<null | String>
removeItem (key: string) => Promise<void>
setItem (key: string, value: string) => Promise<void>

Defined in

nomo_multi_webons.ts:261

Functions

compareSemanticVersions

▸ compareSemanticVersions(versionA, versionB): 0 | 1 | -1

A low-level function. We recommend calling "hasMinimumNomoVersion" instead.

Parameters

Name Type
versionA string
versionB string

Returns

0 | 1 | -1

Defined in

util.ts:11

getCurrentNomoTheme

▸ getCurrentNomoTheme(): Promise<{ colors: { background: string ; disabledColor: string ; error: string ; foreground1: string ; foreground2: string ; foreground3: string ; onPrimary: string ; onSecondary: string ; primary: string ; primaryContainer: string ; secondary: string ; secondaryContainer: string ; settingsColumnColor: string ; settingsTileColor: string ; snackBarColor: string ; surface: string } ; displayName: string ; name: string }>

A low-level function. We recommend using "injectNomoCSSVariables" instead.

Returns

Promise<{ colors: { background: string ; disabledColor: string ; error: string ; foreground1: string ; foreground2: string ; foreground3: string ; onPrimary: string ; onSecondary: string ; primary: string ; primaryContainer: string ; secondary: string ; secondaryContainer: string ; settingsColumnColor: string ; settingsTileColor: string ; snackBarColor: string ; surface: string } ; displayName: string ; name: string }>

Defined in

nomo_theming.ts:53

hasMinimumNomoVersion

▸ hasMinimumNomoVersion(args): Promise<{ minVersionFulfilled: boolean ; nomoVersion: string }>

This function checks at runtime if the Nomo App has a minimum version. It is also possible to require a minimum Nomo App version in the manifest.

Parameters

Name Type
args Object
args.minVersion string

Returns

Promise<{ minVersionFulfilled: boolean ; nomoVersion: string }>

Defined in

nomo_platform.ts:23

injectNomoCSSVariables

▸ injectNomoCSSVariables(): Promise<void>

Injects CSS variables that automatically adjust according to the currently selected Nomo theme.

Returns

Promise<void>

Defined in

nomo_theming.ts:199

invokeNomoFunction

▸ invokeNomoFunction(functionName, args): Promise<any>

A low-level function used by other Nomo APIs. This is the main entry point into the native layer.

Parameters

Name Type
functionName string
args null | object

Returns

Promise<any>

Defined in

dart_interface.ts:174

invokeNomoFunctionCached

▸ invokeNomoFunctionCached(functionName, args): Promise<any>

A cached wrapper on top of "invokeNomoFunction". For idempotent functions, this cache prevents unnecessary calls to the native layer.

Parameters

Name Type
functionName string
args null | object

Returns

Promise<any>

Defined in

dart_interface.ts:150

isFallbackModeActive

▸ isFallbackModeActive(): boolean

Returns true if the code is not running within a Nomo App WebView.

Returns

boolean

Defined in

dart_interface.ts:105

isHexString

▸ isHexString(str): boolean

Parameters

Name Type
str string

Returns

boolean

Defined in

util.ts:125

isRunningInHub

▸ isRunningInHub(): boolean

Returns true if the code is running within an iframe.

Returns

boolean

Defined in

dart_interface.ts:112

nomoAddCustomToken

▸ nomoAddCustomToken(args): Promise<void>

Adds a custom token to the list of visible assets in the Nomo Wallet. Before that, it opens a dialog for the user to confirm.

Needs nomo.permission.ADD_CUSTOM_TOKEN.

Parameters

Name Type
args NomoAssetSelector & { contractAddress: string ; network: NomoEvmNetwork }

Returns

Promise<void>

Defined in

nomo_web3.ts:391

nomoAuthFetch

▸ nomoAuthFetch(args): Promise<{ response: string ; statusCode: number }>

A browser-implementation of the Nomo-Auth-Protocol. It is similar to nomoAuthHttp, but it is implemented in JavaScript instead of the native layer. Therefore, is much easier to debug or modify, although it cannot bypass CORS.

Parameters

Name Type
args Object
args.body? string | { [key: string]: any; }
args.headers? Object
args.method? "GET" | "POST"
args.signer? (args: { message: string ; url: string }) => Promise<{ authAddress: string ; authSig: string ; ethAddress: string ; ethSig: string }>
args.url string

Returns

Promise<{ response: string ; statusCode: number }>

Defined in

nomo_auth.ts:41

nomoAuthHttp

▸ nomoAuthHttp(args): Promise<{ response: string ; statusCode: number }>

A native implementation of the Nomo-Auth-Protocol. Moreover, even if you do not use Nomo-Auth, you can still use this function for bypassing CORS. At a lower level, Nomo-Auth works by injecting a few HTTP-headers into the request.

Parameters

Name Type
args string | { body?: string | { [key: string]: any; } ; headers?: { [key: string]: string; } ; method?: "GET" | "POST" ; url: string }

Returns

Promise<{ response: string ; statusCode: number }>

Defined in

nomo_auth.ts:129

nomoCheckForWebOnUpdate

▸ nomoCheckForWebOnUpdate(): Promise<void>

This will show a dialog to the user if an update is available. If you need to customize this dialog, then you could re-implement the same functionality in JavaScript. Nevertheless, the Nomo App will automatically check for updates even if you never invoke "nomoCheckForWebOnUpdate".

Returns

Promise<void>

Defined in

nomo_platform.ts:128

nomoDisableFallbackWallet

▸ nomoDisableFallbackWallet(): void

Prevents functions like "nomoGetEvmAddress" from falling back to browser extensions like MetaMask.

Returns

void

Defined in

nomo_web3.ts:45

nomoEnableMobileConsoleDebugging

▸ nomoEnableMobileConsoleDebugging(): Promise<void>

After calling this function, console logs are visible in the mobile DevDev-mode of the Nomo App. For the Desktop DevDev-mode, this function is not necessary.

Returns

Promise<void>

Defined in

nomo_platform.ts:182

nomoFallbackQRCode

▸ nomoFallbackQRCode(): void

Detects if a WebOn is running outside of Nomo and shows a fallback-dialog if needed.

Returns

void

Defined in

nomo_media.ts:134

nomoGetAllAssets

▸ nomoGetAllAssets(): Promise<{ assets: NomoAsset[] }>

Returns a list of supported assets that can be made visible via "nomoSetAssetVisibility". This might also include custom tokens that the user has added.

Since Nomo App 0.4.1.

Returns

Promise<{ assets: NomoAsset[] }>

Defined in

nomo_web3.ts:216

nomoGetAssetIcon

▸ nomoGetAssetIcon(args): Promise<{ isPending: boolean ; large: string ; name: string ; small: string ; symbol: string ; thumb: string }>

Returns a set of URLs that contain icons of the asset. May throw an error if no icons can be found.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<{ isPending: boolean ; large: string ; name: string ; small: string ; symbol: string ; thumb: string }>

Defined in

nomo_web3.ts:295

nomoGetAssetPrice

▸ nomoGetAssetPrice(args): Promise<{ currencyDisplayName: string ; currencySymbol: string ; price: number }>

Returns an asset price. Might be slow if a price is not yet in the Nomo App's cache.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<{ currencyDisplayName: string ; currencySymbol: string ; price: number }>

Defined in

nomo_web3.ts:311

nomoGetBalance

▸ nomoGetBalance(args): Promise<NomoAsset & { balance: string }>

Returns not only the balance of an asset, but also additional information like the network, a contract-address and a receive-address. Typically, the decimals are needed to convert a raw balance into a user-readable balance.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<NomoAsset & { balance: string }>

Defined in

nomo_web3.ts:354

nomoGetBalanceWaitUntilSynced

▸ nomoGetBalanceWaitUntilSynced(args): Promise<NomoAsset & { balance: string }>

Internally called by "nomoGetBalance". For EVM-based assets, it is also possible to use ethers.js or similar to fetch a balance.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<NomoAsset & { balance: string }>

Defined in

nomo_web3.ts:337

nomoGetDeviceHashes

▸ nomoGetDeviceHashes(): Promise<{ deviceHashes: string }>

Returns a comma-separated list of device hashes. Can be used for fingerprinting devices.

Needs nomo.permission.DEVICE_FINGERPRINTING.

Returns

Promise<{ deviceHashes: string }>

Defined in

nomo_platform.ts:85

nomoGetDeviceName

▸ nomoGetDeviceName(): Promise<{ deviceName: string }>

Returns a human-readable name of the device.

Needs nomo.permission.DEVICE_FINGERPRINTING.

Returns

Promise<{ deviceName: string }>

Defined in

nomo_platform.ts:102

nomoGetEvmAddress

▸ nomoGetEvmAddress(): Promise<string>

A convenience function to get the Smartchain address of the Nomo Wallet. Internally, it calls "nomoGetWalletAddresses" and caches the result.

Returns

Promise<string>

Defined in

nomo_web3.ts:238

nomoGetExecutionMode

▸ nomoGetExecutionMode(): Promise<{ executionMode: NomoExecutionMode ; hostingMode: NomoHostingMode | null ; webView: NomoWebView }>

Gets details about the execution environment of the WebOn. See the advanced docs for more details about execution modes: https://github.com/nomo-app/nomo-webon-kit/tree/main/advanced-docs

Returns

Promise<{ executionMode: NomoExecutionMode ; hostingMode: NomoHostingMode | null ; webView: NomoWebView }>

Defined in

nomo_platform.ts:64

nomoGetExtendedPublicKey

▸ nomoGetExtendedPublicKey(args): Promise<any>

An extended public key is a public key that allows to derive all the addresses of a Nomo Wallet. This is only intended for UTXO-based assets.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<any>

Defined in

nomo_web3.ts:379

nomoGetInstalledWebOns

▸ nomoGetInstalledWebOns(): Promise<{ manifests: NomoManifest[] }>

Gets all manifests of the installed WebOns, including information like name/id/version.

Needs nomo.permission.GET_INSTALLED_WEBONS.

Returns

Promise<{ manifests: NomoManifest[] }>

Defined in

nomo_multi_webons.ts:170

nomoGetLanguage

▸ nomoGetLanguage(): Promise<{ language: string }>

Returns the currently selected language of the Nomo App.

Returns

Promise<{ language: string }>

Defined in

nomo_platform.ts:116

nomoGetManifest

▸ nomoGetManifest(): Promise<NomoManifest>

Returns the nomo_manifest.json that was used during the installation of the WebOn. For example, this can be used by a WebOn for checking its own version.

Returns

Promise<NomoManifest>

Defined in

nomo_multi_webons.ts:60

nomoGetMessengerAddress

▸ nomoGetMessengerAddress(): Promise<{ inviteLink: string ; messengerAddress: string }>

Can be used for chatting with other NOMO-users, but also for push-notifications or chat-bots.

Needs nomo.permission.SEND_MESSAGE.

Returns

Promise<{ inviteLink: string ; messengerAddress: string }>

Defined in

nomo_media.ts:109

nomoGetNFTContracts

▸ nomoGetNFTContracts(): Promise<{ nftContracts: string[] }>

Returns a list of NFT-contracts that are declared by the currently installed WebOns. Typically, those NFT-contracts provide some kind of utility for a WebOn.

Needs nomo.permission.GET_INSTALLED_WEBONS.

Returns

Promise<{ nftContracts: string[] }>

Defined in

nomo_web3.ts:430

nomoGetPlatformInfo

▸ nomoGetPlatformInfo(): Promise<{ appName: string ; buildNumber: string ; clientName: string ; operatingSystem: string ; version: string }>

Returns both the NOMO-version and the operating system where the WebOn runs. Can be used for implementing platform-specific functionality. See https://nomo.app/ for an overview of supported platforms.

Returns

Promise<{ appName: string ; buildNumber: string ; clientName: string ; operatingSystem: string ; version: string }>

Defined in

nomo_platform.ts:41

nomoGetTransactions

▸ nomoGetTransactions(args): Promise<{ contractAddress?: string ; decimals: number ; name: string ; network: string ; symbol: string ; txs: any[] }>

Returns a list of transactions from the Nomo Wallet's transaction-cache. Might fail if the transaction-cache is not yet synchronized.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<{ contractAddress?: string ; decimals: number ; name: string ; network: string ; symbol: string ; txs: any[] }>

Defined in

nomo_web3.ts:364

nomoGetVisibleAssets

▸ nomoGetVisibleAssets(): Promise<{ visibleAssets: NomoAsset[] }>

Returns a list of assets that are currently visible in the Nomo Wallet.

Returns

Promise<{ visibleAssets: NomoAsset[] }>

Defined in

nomo_web3.ts:192

nomoGetWalletAddresses

▸ nomoGetWalletAddresses(): Promise<{ walletAddresses: Record<string, string> }>

Returns blockchain-addresses of the NOMO-user.

Returns

Promise<{ walletAddresses: Record<string, string> }>

Defined in

nomo_web3.ts:259

nomoGetWebOnParameters

▸ nomoGetWebOnParameters(): Promise<{ [key: string]: any; }>

Returns the URL-parameters of the WebOn-manifest. This might be a nested object that was previously passed to "nomoSetWebOnParameters".

Returns

Promise<{ [key: string]: any; }>

Defined in

nomo_multi_webons.ts:93

nomoInjectQRCode

▸ nomoInjectQRCode(args): Promise<void>

Injecting QRCodes is useful for multiple purposes. For example, new chats can be opened by injecting a chat-invitation-link. Also the Nomo-ID protocol works by injecting QRCodes.

Needs nomo.permission.INSTALL_WEBON.

Parameters

Name Type
args Object
args.navigateBack boolean
args.qrCode string

Returns

Promise<void>

Defined in

nomo_media.ts:14

nomoInstallUrlAsWebOn

▸ nomoInstallUrlAsWebOn(args): Promise<void>

Installs a URL as a WebOn and grants the permissions that are specified in the manifest.

Needs nomo.permission.INSTALL_WEBON. Since Nomo App 0.3.5.

Parameters

Name Type
args Object
args.manifest NomoManifest
args.navigateBack boolean
args.skipPermissionDialog boolean

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:127

nomoInstallWebOn

▸ nomoInstallWebOn(args): Promise<void>

Installs and/or launches a WebOn with or without user interaction. If the WebOn is already installed, then the behavior depends on whether "backgroundInstall" is set to true. If "backgroundInstall" is not set, then the already installed WebOn will be launched. If "backgroundInstall" is set, then the already installed manifest will be replaced (including URL-args). See the README for an explanation about deeplinks.

Needs nomo.permission.INSTALL_WEBON.

Parameters

Name Type
args Object
args.backgroundInstall? boolean
args.deeplink string
args.navigateBack? boolean
args.skipPermissionDialog? boolean

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:112

nomoLaunchSmartchainFaucet

▸ nomoLaunchSmartchainFaucet(): Promise<void>

Launches a free faucet that can be used for paying transaction fees.

Returns

Promise<void>

Defined in

nomo_web3.ts:403

nomoLaunchUrl

▸ nomoLaunchUrl(args): Promise<any>

Passes a URL to the underlying platform for handling. Typically, it will launch a system-browser or an in-app-webview.

Parameters

Name Type
args Object
args.launchMode "platformDefault" | "inAppWebView" | "externalApplication" | "externalNonBrowserApplication"
args.url string

Returns

Promise<any>

Defined in

nomo_multi_webons.ts:223

nomoLaunchUrlAsWebOn

▸ nomoLaunchUrlAsWebOn(args): Promise<any>

Launches a URL as a WebOn without installing it. Grants the permissions that are specified in the manifest. If possible, please prefer "nomoLaunchUrl" or "nomoLaunchWebOn" over this function.

Needs nomo.permission.INSTALL_WEBON. Since Nomo App 0.3.5.

Parameters

Name Type
args Object
args.manifest NomoManifest

Returns

Promise<any>

Defined in

nomo_multi_webons.ts:246

nomoLaunchWebOn

▸ nomoLaunchWebOn(args): Promise<void>

Opens another WebOn on top of the current WebOn. If the WebOn is not yet running, the WebOn will be launched. If the WebOn is not yet installed, an error is thrown. A payload can be passed to the WebOn. Afterwards, the user may navigate back to the current WebOn by pressing the back button.

Parameters

Name Type
args Object
args.manifest NomoManifest
args.payload string

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:212

nomoMigrateAndSelfDestroy

▸ nomoMigrateAndSelfDestroy(args): Promise<void>

Replaces the currently running WebOn with another WebOn on a different deeplink.

Needs nomo.permission.INSTALL_WEBON.

Parameters

Name Type
args Object
args.new_deeplink string

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:181

nomoMnemonicBackupExisted

▸ nomoMnemonicBackupExisted(): Promise<{ mnemonicBackupExisted: boolean }>

If true, then the user has made a backup of their 12 words (at some point in the past). If false, then there exists no backup and the 12 words will get lost with a high probability.

Returns

Promise<{ mnemonicBackupExisted: boolean }>

Defined in

nomo_web3.ts:415

nomoOpenFAQPage

▸ nomoOpenFAQPage(args): Promise<void>

Opens a standardized FAQ page in Nomo design. "faqContent" should be a nested object of questions and answers (with depth=2). Optionally, a button for contacting support is shown below of the FAQs.

Parameters

Name Type
args Object
args.faqContent Record<string, Record<string, string>>
args.initiallyExpanded boolean
args.supportButtonTitle? string
args.supportButtonUrl? string

Returns

Promise<void>

Defined in

nomo_media.ts:36

nomoPickFromGallery

▸ nomoPickFromGallery(args?): Promise<{ imageBase64: string ; path: string }>

Opens an image-picker and returns an image in base64-encoding. The promise rejects if the user chooses to cancel.

Needs nomo.permission.READ_MEDIA.

Parameters

Name Type
args? Object
args.imageQuality? number
args.maxHeight? number
args.maxWidth? number

Returns

Promise<{ imageBase64: string ; path: string }>

Defined in

nomo_media.ts:83

nomoProofOfPayment

▸ nomoProofOfPayment(args): Promise<NomoProofOfPayment>

Returns a proof-of-payment for a transaction

Needs nomo.permission.SIGN_EVM_MESSAGE.

Parameters

Name Type
args Object
args.coin NomoCoinType
args.hash string
args.nonce? string

Returns

Promise<NomoProofOfPayment>

Defined in

nomo_web3.ts:457

nomoProofOfWork

▸ nomoProofOfWork(args): Promise<{ shaInput: string }>

Some API-endpoints require this proof-of-work in order to make denial-of-service attacks more expensive.

Parameters

Name Type
args Object
args.challenge string
args.shaInputPrefix string

Returns

Promise<{ shaInput: string }>

Defined in

nomo_auth.ts:169

nomoQrScan

▸ nomoQrScan(): Promise<{ qrCode: string }>

Opens the camera to scan a qrCode. Returns a raw qrCode or a list of comma-separated qrCodes.

Needs nomo.permission.CAMERA.

Returns

Promise<{ qrCode: string }>

Defined in

nomo_media.ts:27

nomoRegisterOnWebOnVisible

▸ nomoRegisterOnWebOnVisible(callback): Promise<void>

Registers a callback that will be called every time when the WebOn gets visible within the Nomo App. For example, this can be used to refresh themes or languages when re-opening a WebOn after a pause.

Parameters

Name Type
callback () => void

Returns

Promise<void>

Defined in

nomo_platform.ts:136

nomoReplaceWebOn

▸ nomoReplaceWebOn(args): Promise<void>

Tries to add a WebOn and then uninstalls another WebOn if it was successfully added.

Needs nomo.permission.INSTALL_WEBON.

Parameters

Name Type
args Object
args.navigateBack boolean
args.new_deeplink string
args.old_webon_url string

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:152

nomoSelectAssetFromDialog

▸ nomoSelectAssetFromDialog(): Promise<{ selectedAsset: NomoAsset & { balance: string } }>

Opens a dialog for the user to select an asset. If the dialog does not look "correct", WebOns are free to call "nomoGetVisibleAssets" and implement their own dialog.

Returns

Promise<{ selectedAsset: NomoAsset & { balance: string } }>

Defined in

nomo_web3.ts:171

nomoSelectAssets

▸ nomoSelectAssets(args): Promise<{ selectedAssets: NomoAsset[] }>

Checks whether an asset is available in the Nomo Wallet, and whether the asset is visible. If it is not available, "nomoAddCustomToken" can be used to add the asset. If it is not visible, "nomoSetAssetVisibility" can be used to make the asset visible. May return multiple assets if the NomoAssetSelector is ambiguous.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<{ selectedAssets: NomoAsset[] }>

Defined in

nomo_web3.ts:140

nomoSendAssets

▸ nomoSendAssets(args): Promise<{ hash: string ; intent: { amount: string ; recipient: string ; token: string } }>

Opens a confirmation-dialog to send assets away from the Nomo App. Assets are only sent if the user confirms the dialog. "amount" should be a string that can be parsed by "BigInt.parse": https://api.flutter.dev/flutter/dart-core/BigInt/parse.html

Needs nomo.permission.SEND_ASSETS.

Parameters

Name Type
args Object
args.amount? string
args.asset? NomoAssetSelector
args.targetAddress? string

Returns

Promise<{ hash: string ; intent: { amount: string ; recipient: string ; token: string } }>

Defined in

nomo_web3.ts:122

nomoSetAssetVisibility

▸ nomoSetAssetVisibility(args): Promise<void>

Adds or hides an asset within the Nomo Wallet.

Parameters

Name Type
args Object
args.asset NomoAssetSelector
args.visible boolean

Returns

Promise<void>

Defined in

nomo_web3.ts:468

nomoSetWebOnParameters

▸ nomoSetWebOnParameters(args): Promise<void>

Changes the URL-parameters in the manifest of the currently running WebOn. This function does not affect the currently running page. Please use regular JavaScript for navigation.

Parameters

Name Type Description
args Object -
args.urlParams Object A JSON-serializable object that will be converted to a URL query string. Since Nomo App 0.5.1.

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:83

nomoShare

▸ nomoShare(args): Promise<void>

Summons the platform's share sheet to share a text. If no text is provided, then it will share the deeplink of the WebOn.

Wraps the platform's native share dialog. Can share a text and/or a URL. It uses the ACTION_SEND Intent on Android and UIActivityViewController on iOS.

The optional [subject] parameter can be used to populate a subject if the user chooses to send an email.

Parameters

Name Type
args Object
args.subject? string
args.text? string

Returns

Promise<void>

Defined in

nomo_platform.ts:221

nomoSignAuthMessage

▸ nomoSignAuthMessage(args): Promise<{ authAddress: string ; authSig: string ; ethAddress: string ; ethSig: string }>

Returns address/signature-pairs for the Nomo-Auth-Protocol. This is a primitive that can be used for customized authentication. For example, the address/signature-pairs can be put into HTTP-headers.

Needs nomo.permission.SIGN_EVM_MESSAGE. Since Nomo App 0.3.5.

Parameters

Name Type
args Object
args.message string
args.url string

Returns

Promise<{ authAddress: string ; authSig: string ; ethAddress: string ; ethSig: string }>

Defined in

nomo_auth.ts:13

nomoSignEvmMessage

▸ nomoSignEvmMessage(args): Promise<{ sigHex: string }>

Creates an Ethereum-styled message signature. The resulting signature is not usable for submitting transactions, but it can be used as a proof that the user controls a wallet.

Needs nomo.permission.SIGN_EVM_MESSAGE.

Parameters

Name Type
args Object
args.message string

Returns

Promise<{ sigHex: string }>

Defined in

nomo_web3.ts:90

nomoSignEvmTransaction

▸ nomoSignEvmTransaction(args): Promise<{ sigHex: string ; txHex: string }>

Creates a signature for an EVM-based transaction. See EthersjsNomoSigner for an example on how to use this function.

Needs nomo.permission.SIGN_EVM_TRANSACTION.

Parameters

Name Type
args Object
args.messageHex string

Returns

Promise<{ sigHex: string ; txHex: string }>

Defined in

nomo_web3.ts:58

nomoSubscribeNotification

▸ nomoSubscribeNotification(args): Promise<void>

Subscribes Nomo to a notification-topic. Server-side notifications can then be sent to all subscribers of a topic.

Parameters

Name Type
args Object
args.topic string

Returns

Promise<void>

Defined in

nomo_media.ts:127

nomoTakePicture

▸ nomoTakePicture(args?): Promise<{ imageBase64: string ; path: string }>

Opens the camera and returns a picture in base64-encoding. The promise rejects if the user chooses to cancel. The promise may also reject if the user denied a camera-permission.

Needs nomo.permission.CAMERA.

Parameters

Name Type
args? Object
args.imageQuality? number
args.maxHeight? number
args.maxWidth? number

Returns

Promise<{ imageBase64: string ; path: string }>

Defined in

nomo_media.ts:56

nomoUninstallWebOn

▸ nomoUninstallWebOn(args): Promise<void>

The reverse operation of nomoInstallWebOn. Throws an error if the WebOn cannot be found.

Needs nomo.permission.INSTALL_WEBON.

Parameters

Name Type
args Object
args.webon_url string

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:141

profile

▸ profile(fn, options): Promise<void>

Parameters

Name Type
fn () => Promise<void>
options Object
options.name string

Returns

Promise<void>

Defined in

util.ts:115

runsAsWebOn

▸ runsAsWebOn(): boolean

Returns true if the code is running within a Nomo App WebView.

Returns

boolean

Defined in

nomo_platform.ts:15

sha256

▸ sha256(message): Promise<string>

A SHA-256 function based on the Web Crypto API.

Parameters

Name Type
message string

Returns

Promise<string>

Defined in

util.ts:105

sleep

▸ sleep(ms): Promise<void>

An asynchronous sleep function.

Parameters

Name Type Description
ms number The number of milliseconds to sleep.

Returns

Promise<void>

A promise that resolves after the specified sleep duration.

Defined in

util.ts:98

stringifyWithBigInts

▸ stringifyWithBigInts(obj): string

An alternative to JSON.stringify

Parameters

Name Type
obj any

Returns

string

Defined in

util.ts:41

switchNomoTheme

▸ switchNomoTheme(args): Promise<void>

Switches the Nomo App to a different theme. It is recommended to call "injectNomoCSSVariables" after a theme has changed.

Parameters

Name Type
args Object
args.theme NomoTheme

Returns

Promise<void>

Defined in

nomo_theming.ts:12

urlSearchParamsToJson

▸ urlSearchParamsToJson(params): Record<string, any>

Converts URLSearchParams to a (nested) JS-object.

Parameters

Name Type
params URLSearchParams

Returns

Record<string, any>

Defined in

util.ts:63