Deploying Views

Watch Portal

Follow these steps to get started with deploying your Views:

Step 1: Check to ensure the relevant Smart Contract(s) and functions are published

First, ensure the smart contract(s) you intend to use are listed. Check out Listing Smart Contracts to learn more.

Step 2: Create a View Definition

After checking that the relevant smart contract(s) are listed, you’ll need to create a View Definition (i.e., a list of smart contracts and their relevant function(s) from which to collect and index the View data). Follow these steps to create a View Definition:

1. Launch the Watch Portal( https://watch.testnet.analog.one/ ) and connect your wallet.
2. Now, locate the "View Builder" link at the top center of the screen and click on it. This should open a UI with three panels, as shown below:

The left panel ("Smart Contracts") displays a list of deployed Smart Contracts. The middle panel (“Your Query”) shows the list of the functions and parameters you want the View to index from the selected smart contract. The right panel ("Console") has two tabs: Definition, which autogenerates the SQL statements required to fetch and present the contract data, and Test Run, which you can use to test drive the View.

2. From the left panel (i.e., “Smart Contracts”), select the smart contract(s) you want to index and their relevant functions.

Step 3: Test and deploy the query

Follow these steps to deploy your View:

1. Verify that the autogenerated SQL statements in the Definition tab of the Console match the particular requirements for your use case, then click the “Test Query” button.
2. Now, click on the “Test Query” to proceed. If the query runs successfully, it should take you to the “Test Run” tab. However, if it fails, you must fix the errors in the “Your Query” section. You could even write your own SQL and execute it directly in the Console by clicking the “Test Run” tab.
3. If satisfied with the query results, click “Deploy View” to proceed. Otherwise, modify the query in the "Your Query" section.
4. In the next screen, enter the View's name (you can use the identifier), type tags, and a description. Then, click the 'Next' Button.
5. Now, select the use cases where your View will be utilized. For use cases that are not listed, click the “Add new use cases” link and type in the name of the use case. Next, click the "Save" button to add the use case to the Analog Watch.
6. Click the "Complete" button to deploy your View.

Congratulations! You’ve successfully published your View on the Portal!

With just a few simple lines of code, you managed to deploy a View. Now, it’s time to explore the full potential of the Analog Watch! Here are some quick links to get you started:

• Head over to the Funding Views page to learn more on how to fund your View. Then, users can start querying it, and you'll earn rewards in the form of query fees.
• Visit the Querying Data page to learn more about how to query the View data if the View is funded.

Watch SDK

Prerequisites

Ensure you have the following components ready:

1. Installed the Watch SDK. Check out Quickstart to learn more.
2. Generated the session key. See Quickstart for more details.

How to Deploy the View

Recall that we're still working on our Aggregated Data Feeds use case, which requires indexing data from two contracts: Uniswap and Curve.Fi. Follow these two basic steps to deploy your View with the Watch SDK:

Step 1: Define the JSON specification

To deploy the View, you must first define their JSON specifications describing the data you want to index (i.e., smart contracts and relevant functions). The important entities to define in the JSON specification include the following:

1. Name of the network/blockchain.
2. Smart contract address.
3. Contract ABI.
4. A list of function(s) that the collection.
5. The inputs that are fed to the function(s) and the output the function generates. Check out Supported Data Types to learn more.

Take a look at the sample JSON specification for the functions:

[
  {
    "name": "uniSwapV3WethUsdtSlot0",
    "inputs": [],
    "outputs": [
      {
        "output": "value"
      },
      {
        "output": "value"
      },
      {
        "output": "value"
      },
      {
        "output": "value"
      },
      {
        "output": "value"
      },
      {
        "output": "value"
      },
      {
        "output": "skip"
      }
    ],
    "network": "Ethereum",
    "contract": {
      "address": "0xC5aF84701f98Fa483eCe78aF83F11b6C38ACA71D",
      "abi": {
        "name": "slot0",
        "stateMutability": "view",
        "type": "function",
        "inputs": [],
        "outputs": [
          {
            "internalType": "uint160",
            "name": "sqrtPriceX96",
            "type": "uint160"
          },
          {
            "internalType": "int24",
            "name": "tick",
            "type": "int24"
          },
          {
            "internalType": "uint16",
            "name": "observationIndex",
            "type": "uint16"
          },
          {
            "internalType": "uint16",
            "name": "observationCardinality",
            "type": "uint16"
          },
          {
            "internalType": "uint16",
            "name": "observationCardinalityNext",
            "type": "uint16"
          },
          {
            "internalType": "uint8",
            "name": "feeProtocol",
            "type": "uint8"
          },
          {
            "internalType": "bool",
            "name": "unlocked",
            "type": "bool"
          }
        ]
      }
    }
  },
  {
    "name": "uniSwapV3WethUsdtLiquidity",
    "inputs": [],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "network": "Ethereum",
    "contract": {
      "address": "0xC5aF84701f98Fa483eCe78aF83F11b6C38ACA71D",
      "abi": {
        "name": "liquidity",
        "stateMutability": "view",
        "type": "function",
        "inputs": [],
        "outputs": [
          {
            "internalType": "uint128",
            "name": "",
            "type": "uint128"
          }
        ]
      }
    }
  },
  {
    "name": "curveFiDaiUsdcUsdtGetVirtualPrice",
    "network": "ethereum",
    "inputs": [],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "contract": {
      "address": "0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7",
      "abi": {
        "name": "get_virtual_price",
        "outputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": ""
          }
        ],
        "inputs": [],
        "stateMutability": "view",
        "type": "function"
      }
    }
  },
  {
    "name": "curveFiDaiUsdcUsdtBalances",
    "network": "ethereum",
    "inputs": [
      {
        "input": "value"
      }
    ],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "contract": {
      "address": "0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7",
      "abi": {
        "name": "balances",
        "outputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": ""
          }
        ],
        "inputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": "arg0"
          }
        ],
        "stateMutability": "view",
        "type": "function"
      }
    }
  },
  {
    "name": "curveFiUsdtWbtcWethGetVirtualPrice",
    "network": "ethereum",
    "inputs": [],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "contract": {
      "address": "0xd51a44d3fae010294c616388b506acda1bfaae46",
      "abi": {
        "name": "get_virtual_price",
        "outputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": ""
          }
        ],
        "inputs": [],
        "stateMutability": "view",
        "type": "function"
      }
    }
  },
  {
    "name": "curveFiUsdtWBtcWethBalances",
    "network": "ethereum",
    "inputs": [
      {
        "input": "value"
      }
    ],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "contract": {
      "address": "0xd51a44d3fae010294c616388b506acda1bfaae46",
      "abi": {
        "name": "balances",
        "outputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": ""
          }
        ],
        "inputs": [
          {
            "internalType": "uint256",
            "type": "uint256",
            "name": "arg0"
          }
        ],
        "stateMutability": "view",
        "type": "function"
      }
    }
  },
  {
    "name": "uniSwapV3WethUsdtProtocolFees",
    "inputs": [],
    "outputs": [
      {
        "output": "value"
      },
      {
        "output": "value"
      }
    ],
    "network": "Ethereum",
    "contract": {
      "address": "0xC5aF84701f98Fa483eCe78aF83F11b6C38ACA71D",
      "abi": {
        "name": "protocolFees",
        "stateMutability": "view",
        "type": "function",
        "inputs": [],
        "outputs": [
          {
            "internalType": "uint128",
            "name": "token0",
            "type": "uint128"
          },
          {
            "internalType": "uint128",
            "name": "token1",
            "type": "uint128"
          }
        ]
      }
    }
  },
  {
    "name": "curveFiUsdtWbtcWethGetDy",
    "network": "ethereum",
    "inputs": [
      {
        "input": "uint256"
      },
      {
        "input": "uint256"
      },
      {
        "input": "uint256"
      }
    ],
    "outputs": [
      {
        "output": "value"
      }
    ],
    "contract": {
      "address": "0xd51a44d3fae010294c616388b506acda1bfaae46",
      "abi": {
        "name": "get_dy",
        "outputs": [{ "internalType": "uint256", "type": "uint256", "name": "" }],
        "inputs": [
          { "internalType": "uint256", "type": "int128", "name": "i" },
          { "internalType": "uint256", "type": "int128", "name": "j" },
          { "internalType": "uint256", "type": "uint256", "name": "dx" }
        ],
        "stateMutability": "view",
        "type": "function"
      }
    }
  }
]

Step 2: Publish the View

Next, we will proceed to deploy the WETH/USDT View by running the code below:

import { TimegraphClient } from "@analog-labs/timegraph-js";
const timeGraphClient = new TimegraphClient({
url: "<URL>", // A url to Watch GraphQL instance.  
sessionKey: "<SSK>", // Session key created by user wallet using WASM SDK
});
const response = timeGraphClient.view.create({ view: "< view-specification>" }); 

Response

"response":{
   "merge":{
      "status":"complete",
      ...all other created view fields
   }
}

Congratulations! You’ve successfully published your View with the Watch SDK!

With just a few simple lines of code, you managed to deploy a View. Now, it’s time to explore the full potential of the Analog Watch! Here are some quick links to get you started:

• Head over to the Funding Views page to learn more on how to fund your View. Then, users can start querying it, and you'll earn rewards in the form of query fees.
• Visit the Querying Data page to learn more about how to query the View data if the View is funded.

GraphQL IDE

Setup

The simplest way to deploy a View is to install the GraphiQL extension  for the Chrome browser. Besides the GraphiQL extension. you can also use any of the available GraphQL IDEs . Once installed, launch the extension and point its URL to the appropriate environment.

You’ll first need to create the session key and type it in as an authorization variable in the “Headers” section at the bottom of the middle bar as follows:

{
  "Authorization": "<session_key>"
}

Check out Session Key Generator (SKG) to learn more about creating session keys. Provided the Analog Watch Server is open, and you’ve specified the session_key, you should see the following interface:

The GraphiQL interface has three parts:

• The left sidebar contains buttons for opening plugin panes and changing settings.
• The middle bar is where you define mutations and queries.
• The right sidebar displays the results of your mutations and queries.

The left sidebar contains two other sections: the top, which provides buttons for the documentation explorer and history, and the bottom section, which includes buttons for re-fetching the GraphQL schema and short keys dialog.

In the middle panel, specify the authorization interface by typing:

query{
  userInfo {
    wallet
    userId
    userRole
    subgraph
  }
}

Next, click on “Headers” at the bottom of the middle panel and type in the session key you generated earlier as follows:

{
  “Authorization”: “<session_key>”
}

For example, if the session key generated is: 0;2DjuERvt46Ng38XajMCTjGv9N9BLCYP1WEmTK1G9u9gy;0;*;;y79jcXb4hY3PxbKhSJY2jDo2q9HTXQ3ptKqNpZ3xMGX9NeVxZ7vrKAYMhwXmoWJHHgGQLigTEnrz1tCENPASYUT, type this in the “Headers” section:

{
  "Authorization": "0;2DjuERvt46Ng38XajMCTjGv9N9BLCYP1WEmTK1G9u9gy;0;*;;y79jcXb4hY3PxbKhSJY2jDo2q9HTXQ3ptKqNpZ3xMGX9NeVxZ7vrKAYMhwXmoWJHHgGQLigTEnrz1tCENPASYUT "
}

If you’re unsure about a particular action, click on the “Documentation Explorer” in the upper left-hand section of the IDE, which opens the IDE’s docs.

Now click the “Execute” button or press Ctrl+ Enter, or Cmd + Enter to run the query. Here’s what you should see on the right sidebar:

Now that you understand how to use the GraphQL IDE, let's deploy the View.

How to Create Views with the GraphQL IDE

You’ll first need to define the function interface to create a View. Navigate to the middle panel and run this:

mutation($functions:[FunctionSpec!]){
  merge(functions:$functions){
    status
    functions{
      name
      function{
        hashId
        contract{
          address
        }
      }
    }
  }
}

The above functions interface defines:

• Merging schema, which consolidates all the type definitions from different functions into a single executable schema.
• The name of the function(s) within the smart contract you’d like to use.
• The contract name and address.

Using the above function interface, type the code below in the “Variables” section to define the functions:

{
“functions”: [
    {
      “name”: “UniSwap:USDC_getAmountsOut”,
      “inputs”: [
        {“input”: “number_as_uint256”},
        {
          “array”: [
            {
              “constant”: {
                “value”: “A0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48”,
                “input”: “hex_address”
              }
            },
            {“input”: “hex_address”}
          ]
        }
      ],
      "outputs": [{ "output": "skip" }, { "output": "uint256_as_number" }],
      “network”: “Ethereum”,
      “contract”: {
        “address”: “7a250d5630B4cF539739dF2C5dAcb4c659F2488D”,
        “abi”: {
          “name”: “getAmountsOut”,
          “stateMutability”: “view”,
          “type”: “function”,
          “inputs”: [
            {
              "internalType": "uint256",
              “name”: “amountIn”,
              “type”: “uint256”
            },
            {
              “internalType”: “address[]”,
              “name”: “path”,
              “type”: “address[]”
            }
          ],
          “outputs”: [
            {
              "internalType": "uint256[]",
              “name”: “amounts”,
              “type”: “uint256[]”
            }
          ]
        }
      }
    }
  ]
}
 

This function configuration defines the following:

• Name of the function (i.e., UniSwap:USDC_getAmountsOut).
• Inputs to the function (i.e., amountIn, of type uint256, and path, of type “address”).
• Function output (i.e., amounts of type uint256).
• Contract address and ABI.

When you run this code, you should see a unique hash ID for the function created, as shown below:

Let’s now create some Views from the created function. First, run a mutation operation to create the collection interface as follows:

mutation($views:[ViewSpec!]){
  merge(views:$views){
    status
    views{
      name
      view{
        hashId
        sql
      }
    }
  }
}
 

You can now create a single View (one that connects to a single smart contract) or a complex View (one that queries data from multiple smart contracts) by running the code below:

{
"views": [
    {
      "name": "by_name",
      "sql": "select Price, 'USDC/WETH' as Pair from USDC_WETH"
    },
    {
      "name": "simple",
      "sql": "select Price, 'USDC/WETH' as Pair, _cycle, _block from USDC_WETH"
    },
    {
      "name": "complex",
      "sql": "select u.Price as UNI, w.Price as WETH, w._cycle, w._block from USDC_WETH as w join USDC_UNI as u on u._block = w._block"
    }
  ]
}

Creating a View generates a hash ID and other details, such as the view name and SQL statement on the Analog Watch. Depending on your use case, you can modify the SQL statement to fetch data from a single collection or multiple Views in the case of a complex view.

In the above case:

• The first view is a single view. It retrieves price and USDC/WETH as a pair from the USDC_WETH smart contract and stores it as “by_name” on the Timegraph protocol.
• Similarly, the second view is a single view. It fetches the price, USDC_WETH as pair, _cycle, and a block number from the USDC_WETH smart contract.
• The third view is a complex view that retrieves data from two smart contracts.

Congratulations! You’ve successfully published your View with the GraphQL IDE!

With just a few simple lines of code, you managed to deploy a View. Now, it’s time to explore the full potential of the Analog Watch! Here are some quick links to get you started:

• Head over to the "Funding Views" page to learn more on how to fund your View. Then, users can start querying it, and you'll earn rewards in the form of query fees.
• Visit the "Querying Data" page to learn more about how to query the View data if the View is funded.