Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 7.3 KB

quick-start.md

File metadata and controls

116 lines (84 loc) · 7.3 KB
Raw
description
Connect your subgraphs from The Graph to your on-chain dApps via Phat Contract.

🦋 Quick Start

Overview

The Graph template enables you to connect to subgraph endpoints for data and utilize the data to calculate a trust score and send to a Web3 dApp on an EVM chain.

Prerequisites

  • Active Phala Profile with version >= 1.0.1 via Phat Contract 2.0 UI
  • Hardhat
  • API Key from The Graph
  • For EVM Mainnet deployments:
    • Ex: Polygonscan API Key that can be generated on polygonscan
  • RPC Endpoint for EVM Chain Mainnet & EVM Chain Testnet
  • Polkadot Account for Phala PoC6 Testnet and Mainnet deployment
  • Node >= 18.x

How it Works

The diagram above displays the user journey of (1) Alice requesting a trust score for Eve from the EVM Consumer Contract. When (2) a new action request is added to the queue, (3) the Phala Network Phat Contract will pop the action off the queue and perform the off-chain work to compute a trust score.

First (4) the Phat Contract will create a batchHttpRequest to query 3 separate subgraph endpoints to determine if Eve has any ERC-721 NFTs, a NounsDAO NFT, an ENS Domain, and if any accounts delegate votes to Eve on Snapshot. Once this data is returned then (5) the Phat Contract will compute a score based on some scoring criteria. You can view the code here. Lastly, (6) the trust score for Eve has been returned to the EVM Consumer Contract and Eve's score is set in the Consumer Contract's storage for anyone to query.

Quick Start

Make sure you have created a Phat Dashboard Profile and claimed some PoC6 Testnet Tokens. Instructions on creating a profile can be found here. Also, make sure to get an API Key from The Graph to avoid being rate limited by the default API Key provided by the Phala team.

To kickstart your journey with The Graph Starter Kit, you install the @phala/fn CLI tool.

You can do this using your node package manager (npm) or use node package execute (npx). For the purpose of this tutorial, we will be using npx.

Once you have the CLI tool installed, you can create your first Phala Oracle template with the following command.

npx @phala/fn@latest init example

🚨 Note 🚨

When selecting your template, elect the-graph-starter-kit.

npx @phala/fn@latest init example
? Please select one of the templates for your "example" project: 
  phat-contract-starter-kit: Send data from any API to your smart contract with Javascript. 
  lensapi-oracle-consumer-contract: Send data from Lens API to your smart contract to empower your Web3 Social dApp. 
  vrf-oracle: TEE-guarded Verifiable Random Function template to bring randomness to your smart contract. 
  airstack-phat-contract: Request an account’s data from Airstack’s API to compute trust score and send to your Web3 dApp on-chain. 
❯ thegraph-phat-contract: Connect your subgraphs from The Graph to your on-chain dApps via Phat Contract.

🛑 Not so fast! What is it exactly that we are building? 🛑

What are we building?

The artifact we are compiling is a JavaScript file, serving as the Phat Contract Oracle's tailored logic. This script is designed to respond to requests initiated from the Consumer Contract. The diagram provided above offers a visual representation of this request-response interaction.

Why is it important?

In the context of the off-chain environment, on-chain Smart Contracts are inherently limited. Their functionality is confined to the information available to them within the on-chain ecosystem. This limitation underscores the critical need for a secure off-chain oracle, such as the Phat Contract. This oracle is capable of fetching and transforming data, thereby enhancing the intelligence and awareness of Smart Contracts about on-chain activities. This is a pivotal step towards bridging the gap between the on-chain and off-chain worlds, making Smart Contracts not just smart, but also informed.

After creating The Graph template repo, cd into the new project and install the package dependencies. You can do this with the following command:

npm install

Now, build the default Phat Contract script with this command:

npx @phala/fn build

To simulate the expected result locally, run the Phat Contract script now with the npx @phala/fn runcommand to test the expected output when passing an encoded hexstring and the secrets into the main function of the Phat Contract. This is helpful to test locally quick to understand the functionality of your compiled Phat Contract.

Go to https://playground.ethers.org to decode and encode the hexstring you want to pass into your Phat Contract main function.

In this example, the hexstring 0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000de1683287529b9b4c3132af8aad210644b259cfd represents types uint id and address target

Here is what you will enter in the playground:

  • utils.defaultAbiCoder.decode(['uint id', 'address target'], '0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000de1683287529b9b4c3132af8aad210644b259cfd')
  • [ BigNumber { value: "1" }, "0xdE1683287529B9B4C3132af8AaD210644B259CfD", id: BigNumber { value: "1" }, target: "0xdE1683287529B9B4C3132af8AaD210644B259CfD" ]

You can easily validate this by encoding the types and data with the utils.defaultAbiCoder.encode() function like below.

  • utils.defaultAbiCoder.encode(['uint id', 'address target'], [1, "0xdE1683287529B9B4C3132af8AaD210644B259CfD"])
  • "0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000de1683287529b9b4c3132af8aad210644b259cfd"
npx @phala/fn run dist/index.js -a 0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000de1683287529b9b4c3132af8aad210644b259cfd '{"apiUrl": "https://gateway.thegraph.com/api/", "apiKey": "cd22a01e5b7f9828cddcb52caf03ee79"}'

Finally, run the local end-to-end tests with this command. Here we will simulate locally the interaction between the Phat Contract and the Consumer Contract with hardhat.

npm run localhost-test

🥳 Congratulations!

You have successfully completed the quick start. For the next steps, you will learn how to deploy The Graph Phat Contract to PoC6 Testnet & Phala Mainnet, and also deploy the EVM Consumer Contract on the target EVM chain. Then you will connect to the Phat Contract to the Consumer Contract for the EVM testnet chain to start testing the request-response model live.