Skip to content

Latest commit

 

History

History
1557 lines (937 loc) · 47.4 KB

modules.md

File metadata and controls

1557 lines (937 loc) · 47.4 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:379

NomoEvmNetwork

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

Defined in

nomo_web3.ts:9

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:13

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 ; 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 ; headers?: { [key: string]: string; } ; method?: "GET" | "POST" ; url: string }) => Promise<{ response: string ; statusCode: number }>
checkForWebOnUpdate () => Promise<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 }>
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<{ cardMode: boolean | null ; 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[] }>
getNFTs (args: { network: NomoEvmNetwork }) => Promise<{ nfts: NomoNFT[] }>
getPlatformInfo () => Promise<{ appName: string ; buildNumber: string ; clientName: string ; operatingSystem: string ; version: string }>
getTransactions (args: NomoAssetSelector) => Promise<any>
getVisibleAssets () => Promise<{ visibleAssets: NomoAsset[] }>
getWalletAddresses () => Promise<{ walletAddresses: Record<string, string> }>
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: { 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>
qrScan () => Promise<{ qrCode: string }>
registerOnWebOnVisible (callback: (args: { cardMode: boolean }) => void) => Promise<void>
replaceWebOn (args: { navigateBack: boolean ; new_deeplink: string ; old_webon_url: string }) => Promise<void>
selectAssetFromDialog () => Promise<{ selectedAsset: NomoAsset & { balance: string } }>
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>
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 }>
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:151

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:245

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:16

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:138

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:114

isFallbackModeActive

▸ isFallbackModeActive(): boolean

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

Returns

boolean

Defined in

dart_interface.ts:79

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:297

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
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:40

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 ; headers?: { [key: string]: string; } ; method?: "GET" | "POST" ; url: string }

Returns

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

Defined in

nomo_auth.ts:127

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:123

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:177

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:124

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:157

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:218

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:234

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:260

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:80

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:97

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:179

nomoGetExecutionMode

▸ nomoGetExecutionMode(): Promise<{ cardMode: boolean | null ; 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<{ cardMode: boolean | null ; executionMode: NomoExecutionMode ; hostingMode: NomoHostingMode | null ; webView: NomoWebView }>

Defined in

nomo_platform.ts:57

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.

Since Nomo App 0.3.8.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<any>

Defined in

nomo_web3.ts:285

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:153

nomoGetLanguage

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

Returns the currently selected language of the Nomo App.

Returns

Promise<{ language: string }>

Defined in

nomo_platform.ts:111

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:75

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:359

nomoGetNFTs

▸ nomoGetNFTs(args): Promise<{ nfts: NomoNFT[] }>

Returns a list of NFTs that are owned by the user. Can be slow if the NFTs are not yet in the Nomo App's cache.

@deprecated: Please use "nomoGetNFTContracts" instead.

Parameters

Name Type
args Object
args.network NomoEvmNetwork

Returns

Promise<{ nfts: NomoNFT[] }>

Defined in

nomo_web3.ts:347

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:34

nomoGetTransactions

▸ nomoGetTransactions(args): Promise<any>

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

Since Nomo App 0.3.8.

Parameters

Name Type
args NomoAssetSelector

Returns

Promise<any>

Defined in

nomo_web3.ts:273

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:133

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:187

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:110

nomoInstallWebOn

▸ nomoInstallWebOn(args): Promise<void>

Installs a WebOn with or without user interaction. If the WebOn is already installed, it will be updated to the latest version. See the README for an explanation about deeplinks.

Needs nomo.permission.INSTALL_WEBON.

Parameters

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

Returns

Promise<void>

Defined in

nomo_multi_webons.ts:96

nomoLaunchSmartchainFaucet

▸ nomoLaunchSmartchainFaucet(): Promise<void>

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

Returns

Promise<void>

Defined in

nomo_web3.ts:309

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:207

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:230

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:196

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:164

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:321

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:386

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 (args: { cardMode: boolean }) => void

Returns

Promise<void>

Defined in

nomo_platform.ts:131

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:135

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:112

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:96

nomoSetAssetVisibility

▸ nomoSetAssetVisibility(args): Promise<void>

Adds or hides an asset within the Nomo Wallet.

Since Nomo App 0.4.0.

Parameters

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

Returns

Promise<void>

Defined in

nomo_web3.ts:399

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:12

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:69

nomoSignEvmTransaction

▸ nomoSignEvmTransaction(args): Promise<{ sigHex: 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 }>

Defined in

nomo_web3.ts:42

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:124

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