Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 4.97 KB

README.md

File metadata and controls

96 lines (69 loc) · 4.97 KB
Raw

Moesif For Dapp Example

Purpose of this repo is to illustrate an example how a DAPP built on web3js/ethereum can integrate Moesif for Web3 monitoring and analytics.

Background on Dapps

When you create your own Dapp, the key dependency is the web3.js official library from Ethereum org. Web3js allows your Dapp to interact with the ethereum network (and the smart contracts deployed on it) using JSON-RPC. In our example, we use Truffle framework, which is set of tools for streamline some of the process and generate boilerplate code.

Background on Moesif

Moesif is the leading API analytics and monitoring platform, for Restful APIs, GraphQL, and now JSON-RPC/Ethereum.

For Dapps (distributed Apps) that are built on top of Ethereum, it is impossible to monitor the servers, as there is no servers. To understand how the Dapp APIs are used, where the errors are, it becomes even more difficult.

Moesif is the perfect solution for giving you insight for the Dapp that you could get in traditional server based applications.

How we created this example

This repo is based on the Truffle Framework, and one of the standard starting kits: Truffle React Box. Although Moesif integration itself do not depend on React.

We followed these steps to create this example:

  • npm install -g truffle
  • truffle unbox react
  • Created a basic Dapp, something more interactive than the one out of the box.
    • We added a form and a button to set the storage value using the minimalistic "storage" smart contract included in the Truffle React Box.
    • This additional code is in src/App.js.
  • Install Moesif using standard Browser integration.
    • Leverages the moesif-browser-js library.
    • In index.html under /public, we added the following code snippet, between the head tags.
    <script src="//unpkg.com/[email protected]/moesif.min.js"></script>
    <script type="text/javascript">
    var options = {
      applicationId: 'Your application id'
      // add other option here.
    };

    // for options see below.
    moesif.init(options);

    // this starts the capturing of the data.
    moesif.start();
    </script>

To run this example

  • Fork or download this repo.
  • Get a Moesif account by sign up, and obtain an Application Id.
  • Edit the index.html file in /public, and replace Your application id with your actual application id.
  • If you haven't already, install truffle by: npm install -g truffle
  • Install dependencies for this repo: npm install
  • Start the truffle development environment: truffle develop
  • Compile the smart contracts: type in compile in the truffle develop command line prompt.
  • Deploy the smart contracts: type in migrate in the truffle develop command line prompt. (or type in migrate --reset if you want do migration before and what to refresh).
  • Start the Dapp: in another terminal, run npm run start.

Now, you can type go to: http://localhost:3000/, and interact with the Dapp. As you interact with the Dapp, all the JSON-RPC calls will be captured in your Moesif account.

Moesif Application Id

Your Moesif Application Id can be found in the Moesif Portal. After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.

You can always find your Moesif Application Id at any time by logging into the Moesif Portal, click on the top right menu, and then clicking Installation.

Note for Metamask or use another Network.

First of all, please disable Metamask if you want this example to work out of the box. If you need to use meta mask, you have to do few things.

  • Decide on which network that you want your Metamask to connect to.
  • Take a look at truffle-config.js, and copy that over to truffle.js, and add the correct settings for the the network you plan to use.
  • Make sure you compile and migrate your contracts to the correct network you are using.
  • On the UI side, if you are using Metamask or something, make sure it is also connected to the same network.
  • Metamask intercepts every transaction and requires user to explicit first. Sometimes the popup prompt is hidden, so be sure click on the Metamask popup and accept the prompt.

Summary

For any Dapp build on top of Ethereum and JSON-RPC using web3.js, it is very simple to install Moesif API analytics and monitoring. The process is the same as for any normal browser based app. Moesif automatically detects they are JSON-RPC calls and apply same level of intelligent monitoring and deep insights that we already do for other APIs such as REST or GraphQl.

More info

Please check the tutorial blog post related to this repo.