nomo-webon-kit v0.1.26

Nomo WebOn Kit

This package provides an API for Nomo WebOns. A WebOn is a web-application that runs within a WebView of the Nomo App.

See the api-docs for a list of individual functions.

Why Nomo WebOns?

The Nomo WebOn API has the potential to revolutionize the web3 user experience. To understand why, see the following problems of traditional systems like "WalletConnect":

• With "WalletConnect“, communication flows over a (centralized) middleman, even if both wallet and website are running on the same phone!
• The middleman adds complexity, delays and lots of boilerplate code

With the Nomo API, there is no more middleman. WebOns and Wallet communicate locally on the same phone. The results are:

• WebOns do not need any "connect wallet“ button
• WebOns are fast and reliable
• ethers.js can be setup with only three lines of JavaScript

See our Decentralized App Vision for more details.

Quick Usage Guide

Before going into more details, we explain a few quick steps for getting a WebOn up and running together with the Nomo App.

Prerequisites: We assume a working knowledge of npm and JavaScript.

Step 1: Download the Nomo App

Goto https://nomo.app/.
Download the Nomo App and create a wallet with it.

Step 2: Launch a WebOn locally

Clone one of the Opensource WebOns or alternatively use your own frontend template. Install npm dependencies and launch your WebOn on localhost.

npm i
npm run dev

Then your WebOn should run at http://localhost:3000/ or similar. If your frontend is not yet a WebOn, then you will need to add a nomo_manifest.json.

Step 3: Enable the Nomo Dev Mode

Within the Nomo App, navigate to Settings -> About this App.
Click ten times on the NOMO-icon to enable the Nomo Dev Mode.
From now on, the About-screen will change into a "developer-area". The Nomo App will ask you for a WebOn-deeplink.

Step 4: Construct a WebOn-deeplink

A deeplink tells the Nomo App where your WebOn is running. For development, we recommend two different types of deeplinks:

• Local-Wifi-deeplinks
• Ngrok-deeplinks

See the options below for instructions on how to construct a deeplink. To enter your deeplink into the Nomo App, we recommend using a QRCode-generator like https://goqr.me/. After scanning your deeplink, the Nomo App is ready to launch your WebOn! 🚀🚀

You are then free to make changes or experiment with the features.

Option 1: Local-Wifi-deeplinks

If you are using a Desktop-version of the Nomo App, then you may use a simplified deeplink like http://nomo.app/webon/localhost:3000.

For this type of deeplink, your phone needs to be in the same local network as your dev-machine. For example, let’s assume your dev-machine has the IP address 172.16.251.205 and your WebOn is running at http://localhost:3000. Then you can construct the following deeplink by inserting the prefix nomo.app/webon/:

http://nomo.app/webon/172.16.251.205:3000

Option 2: ngrok-deeplinks

If you are unable to use local-Wifi-deeplinks, then you can use ngrok-deeplinks as an alternative option. ngrok is a useful tool for exposing your localhost to the Internet. By using ngrok, the Nomo App can access your dev-machine regardless of which network your phone is connected to. First, download ngrok from https://ngrok.com/ and create an ngrok-account.

Further, we assume that your WebOn is running locally on port 3000. Run the following command to expose your WebOn to the Internet:

ngrok http 3000

This command should give you a URL that looks something like this:

https://56b1.ngrok-free.app

With this, you can construct the following deeplink by inserting the prefix nomo.app/webon/:

https://nomo.app/webon/56b1.ngrok-free.app

Installation

You can add this package to your project with: npm install nomo-webon-kit.

Take a look at the Demo WebOn to see how the package can be used. In order to use this package, we expect that WebOns are written in JavaScript or TypeScript.

Interacting with EVM blockchains

See the EVM docs if you want to port a decentralized application as a WebOn.

Debugging WebOns

There are multiple ways of debugging WebOns, but our preferred way is to connect Chrome DevTools to a WebOn. See the debugging docs for more details.

Authenticating WebOns

For fullstack-WebOns, the Nomo App offers the following protocols:

• Nomo-Auth: Direct authentication from a WebOn to a backend
• Nomo-ID: Linking a WebOn to already existing (web2) backends

Deploying WebOns

We recommend the nomo-webon-cli for deploying WebOns. The nomo-webon-cli can be used both for production deployments as well as for internal test deployments or CI/CD pipelines.

Sharing WebOns

You can share WebOns by long-pressing on the WebOn-icon within the Nomo App's home screen. After long-pressing, you will see a dialog. Within this dialog, the "Share button" will give you a deeplink that can be shared with users or other developers.

If needed, this deeplink can be easily converted into a QRCode with any QRCode-generator.