search

Phala-Network / lensapi-oracle-consumer-contract

A Phat Contract starter kit for the LensAPI Oracle
GNU General Public License v3.0
1 stars 9 forks source link
lens-protocol off-chain-compute phala phala-network phat-contract smart-contract

readme

:hammer_and_pick: The Phat Contract Starter Kit

:warning: Important ⚠️

This guide references the mumbai testnet chain.

The mumbai testnet is deprecated since 2024/04/08, meaning the steps to deploy to a testnet will no longer work out of the box.

You can opt to use the amoy testnet or any other EVM testnet instead.

Note on Terminology

Phat Contract will also be referred to as the Phala Oracle in this README.

:mag_right: Overview

The LensAPI Oracle Phat Contract is your one-stop solution to connect any API to your smart contract. It offers wide-ranging support for all EVM-compatible blockchains, including but not limited to Ethereum, Polygon, Arbitrum, Avalanche, Binance Smart Chain, Optimism, and zkSync.

This starter kit empowers you to initiate the data request from the smart contract side. The request is then seamlessly sent to your script for processing. You have the liberty to call any APIs to fulfill the request and define the response data structure that will be replied to your smart contract.

:runner: Quick Start

To kickstart your journey with the Phat Contract Starter Kit, you will use the @phala/fn CLI tool.

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.

# Skip this step if chose option 1 or cloned this repo
npx @phala/fn@latest init example
:rotating_light: Note :rotating_light:

When selecting your template, elect lensapi-oracle-consumer-contract.

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.

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

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 a Phala Oracle template, cd into the new project and install the package dependencies. You can do this with the following command:

npm install

Now, build the default Phala Oracle function with this command:

npx @phala/fn build

To simulate the expected result locally, run the Phat Contract script now with the npx @phala/fn run command 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 0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000043078303100000000000000000000000000000000000000000000000000000000 represents types uint id, and string reqData Here is what you will enter in the playground:

  • utils.defaultAbiCoder.decode(['uint id', 'string reqData'], '0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000043078303100000000000000000000000000000000000000000000000000000000')
  • [ BigNumber { value: "1" }, "0x01", id: BigNumber { value: "1" }, reqData: "0x01" ] You can easily validate this by encoding the types and data with the utils.defaultAbiCoder.encode() function like below.
  • utils.defaultAbiCoder.encode(['uint id', 'string reqData'], [1, "0x01"])
  • "0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000043078303100000000000000000000000000000000000000000000000000000000"
npx @phala/fn run dist/index.js -a 0x0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000043078303100000000000000000000000000000000000000000000000000000000 https://api-v2-mumbai-live.lens.dev/

What are the ingredients for the npm run run-function command?

Our Phat Contract script, now fully constructed, is ready for a trial run. This simulation mirrors the live script's operation when deployed on the Phala Network.

The command's first parameter is a HexString, representing a tuple of types [uintCoder, bytesCoder]. This serves as the entry function. The second parameter is a string, embodying the configurable secrets fed into the main function.

The Coders.decode function deciphers these parameters, yielding the decoded requestId and encodedReqStr. These decoded elements then become the raw material for the rest of the custom logic within the script.


export default function main(request: HexString, settings: string): HexString {
  console.log(`handle req: ${request}`);
  let requestId, encodedReqStr;
  try {
    [requestId, encodedReqStr] = Coders.decode([uintCoder, bytesCoder], request);
  } catch (error) {
    console.info("Malformed request received");
  }
// ...
}
How the query looks under the hood - HTTP Endpoint: https://api-v2-mumbai-live.lens.dev/ - Profile ID: `0x01` - Expected Graphql Query: ```graphql query Profile { profile(request: { forProfileId: "0x01" }) { stats { followers following comments countOpenActions posts quotes mirrors publications reacted reactions } } } ``` - Expected Output: ```json { "data": { "profile": { "stats": { "followers": 2, "following": 0, "comments": 0, "countOpenActions": 1, "posts": 14, "quotes": 0, "mirrors": 0, "publications": 14, "reacted": 0, "reactions": 0 } } } } ```

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

:partying_face: Congratulations!

You have successfully completed the quick start. For the next steps, you will learn how to deploy your Phala Oracle and connect to the consumer contract for the EVM testnet chain to start testing the request-response model live.

For a deeper dive into the details, click here, or continue reading to learn about the valuable features the Phala Oracle can offer to your on-chain consumer contract.

:magic_wand: Features and Benefits

:building_construction: Use cases & Examples

You could use the Oracle to:

:books: Resources