Skip to content

Latest commit

 

History

History
156 lines (107 loc) · 5.53 KB

README.md

File metadata and controls

156 lines (107 loc) · 5.53 KB
Raw

OMGX Subgraph Example

OMGX Graph Node

Mainnet endpoint: https://graph.mainnet.boba.network

Port Purpose Routes URL Permission
8000 GraphQL HTTP server /subgraphs/name/.../... https://graph.mainnet.boba.network
https://graph.mainnet.boba.network:8000		 Public
8020 JSON-RPC
(for managing deployments)		 / https://graph.mainnet.boba.network:8020 Private
8030 Subgraph indexing status API /graphql https://graph.mainnet.boba.network:8030 Public
8040 Prometheus metrics /metrics https://graph.mainnet.boba.network:8040 Public

Rinkeby endpoint: https://graph.rinkeby.boba.network

Port Purpose Routes URL Permission
8000 GraphQL HTTP server /subgraphs/name/.../... https://graph.rinkeby.boba.network
https://graph.rinkeby.boba.network:8000		 Public
8020 JSON-RPC
(for managing deployments)		 / https://graph.rinkeby.boba.network:8020 Private
8030 Subgraph indexing status API /graphql https://graph.rinkeby.boba.network:8030 Public
8040 Prometheus metrics /metrics https://graph.rinkeby.boba.network:8040 Public

Deploy Subgraph to OMGX Graph Node

Dependencies

You'll need the following:

Setup

Clone the the example repository, open it, and install nodejs packages with yarn:

git clone [email protected]:omgnetwork/omgx_subgraph-example.git
cd omgx_subgraph-example
cd omgx-contract
yarn install

Copy the contract abi file into omgx-contract/abis.

Update subgraph.yml

The standard subgraph.yml is

specVersion: 0.0.2
description: TokenPool for OMGX
repository: https://github.com/omgnetwork/omgx_subgraph-example
schema:
  file: ./schema.graphql
dataSources:
  - kind: ethereum/contract
    name: TokenPool # Contract name
    network: omgx  # Don't change if you want to deploy to OMGX
    source:
      address: '0x82B178EE692572e21D73d5F1ebC1c7c438Fc52DD' # Contract address
      abi: TokenPool # Contract name
    mapping:
      kind: ethereum/events
      apiVersion: 0.0.4
      language: wasm/assemblyscript
      entities:
        - TokenPool # Contract name
      abis:
        - name: TokenPool # Contract name
          file: ./abis/TokenPool.json # Contract ABI location
      eventHandlers:
        - event: RequestToken(address,uint256,uint256) # event fucntion in the contract
          handler: handleRequestToken
      file: ./src/mapping.ts

Update schema.graphql

Update the database structure for the contract event data. A simple example is

type TokenPool @entity {
  id: ID!
  sender: Bytes
  amount: String
  timestamp: String
}

Generate the schema and contract code

yarn codegen

or you can run the following command if you have installed the global graph-cli

graph build

The automcatically generated code is in generated folder.

Update src/mapping.ts

src/mappin.ts is used to store the contract event data into graphql.

Deploy to OMGX Graph Node

Update the project name in package.json . The subgraph name needs to have the format PREFIX/NAME.

{  
  "create:subgraph": "graph create --node https://graph.rinkeby.boba.network:8020 PREFIX/NAME",
  "deploy:subgraph": "graph deploy --ipfs https://graph.rinkeby.boba.network:5001 --node https://graph.rinkeby.boba.network:8020 PREFIX/NAME"
}
yarn create:subgraph
yarn deploy:subgraph

or you can directly run the following command if you have installed the global graph-cli

graph create --node https://graph.rinkeby.boba.network:8020 PREFIX/NAME
graph deploy --ipfs https://graph.rinkeby.boba.network:5001 --node https://graph.rinkeby.omgx.network:8020 PREFIX/NAME

NOTE: The https://graph.rinkeby.omgx.network:8020 endpoint is private. Please contact us if you want to deploy subgraphs.

L2 Liquidity Pool Example

The deployment code is in omg-L2LP folder. You can access deployed subgraphs through L2LiquidityPoolSubgraph.

L2 Token Pool Example

The deployment code in omg-TokenPool folder. You can access deployed subgraphs through L2TokenPoolSubgraph.

Known BUG

  • It can't fetch the events in the functions that send the messages from L2 to L1.