Labs 1753/limit order arbitrum mainnet

[oneleo]

PR: LimitOrder Subgraph for Hosted Service on Mainnet, Arbitrum and Goerli

Major Changes

1. This version supports the Mainnet, Arbitrum, and Goerli networks.
2. This version includes the three main events of the LimitOrder: LimitOrderFilledByProtocol, LimitOrderFilledByTrader, and OrderCancelled.
3. This version also features the integrated LimitOrderFilled Entity, which combines the LimitOrderFilledByProtocol and LimitOrderFilledByTrader events.
4. Additionally, this version incorporates the updatable Order Entity, providing the ability to query the current status of orders.

Other Changes

1. Due to incompatibility between the ipfs-utils module and Node.js version 14, the Node.js parameter in GitHub CI has been updated to version 16.
2. Revised GraphQL query examples for the LimitOrder subgraph.
3. Add "prepare:arbitrum" and "deploy-staging:arbitrum" to package.json. However, if the corresponding exchange, staking, and limitorder are not supported, execute "echo ${NotUse}".
4. Update the version of Graph-CLI.
5. Add "limitorder.yaml" to .gitignore.

Deployment Process to "Subgraph Studio" Platform

% yarn cache clean
% yarn install
% graph auth --studio <YOUR DEPLOY KEY>

### Assuming the Subgraph name you have set in Subgraph Studio is "tokenlon-limitorder-mainnet"
% yarn run prepare:mainnet && yarn run codegen && yarn run build
% yarn workspace "limitorder" run graph deploy --studio tokenlon-limitorder-mainnet limitorder.yaml

### Assuming the Subgraph name you have set in Subgraph Studio is "tokenlon-limitorder-arbitrum"
% yarn run prepare:arbitrum && yarn run codegen && yarn run build
% yarn workspace "limitorder" run graph deploy --studio tokenlon-limitorder-arbitrum limitorder.yaml

### Assuming the Subgraph name you have set in Subgraph Studio is "tokenlon-limitorder-goerli"
% yarn run prepare:goerli && yarn run codegen && yarn run build
% yarn workspace "limitorder" run graph deploy --studio tokenlon-limitorder-goerli limitorder.yaml

GraphQL query examples for the LimitOrder subgraph

query MyQuery {
  orders(orderBy: lastFilledTime, first: 3, orderDirection: desc) {
    id
    maker
    makerToken
    takerToken
    firstFilledTime
    lastFilledTime
    cancelledTime
    orderStatus
  }
  limitOrderFilleds(orderBy: blockTimestamp, first: 3, orderDirection: desc) {
    id
    limitOrderFilledType
    makerTokenFilledAmount
    takerTokenFilledAmount
    recipient
    relayer
    profitRecipient
    takerTokenProfit
    takerTokenProfitFee
    takerTokenProfitBackToMaker
    blockTimestamp
  }
  limitOrderFilledByProtocols(orderBy: blockTimestamp, first: 3, orderDirection: desc) {
    id
    relayer
    profitRecipient
    fillReceiptMakerTokenFilledAmount
    fillReceiptTakerTokenFilledAmount
    fillReceiptRemainingAmount
    takerTokenProfit
    takerTokenProfitFee
    takerTokenProfitBackToMaker
    blockTimestamp
  }
  limitOrderFilledByTraders(first: 3, orderDirection: desc, orderBy: blockTimestamp) {
    id
    recipient
    fillReceiptMakerTokenFilledAmount
    fillReceiptTakerTokenFilledAmount
    fillReceiptRemainingAmount
    blockTimestamp
  }
}

[oneleo]

A bug has been identified here.
When collecting TradedToken Entity, if the assetAddr is detected as of type WETH, it will be replaced with the Mainnet WETH address ("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2") universally.
It should instead replace it with the WETH address on the respective network.
This issue will be addressed in the next commit.

[charlesjhongc]

What's the status of this PR? Still work in progress or ready to merge?

[oneleo]

What's the status of this PR? Still work in progress or ready to merge?

This PR serves two main purposes and has one reason.

1. One purpose is to distinguish the branch merging LimitOrder and Exchange. limitorder_feature branch
2. Another purpose is to request everyone's assistance in reviewing the code of the upcoming LimitOrder Subgraph that will be deployed on the Hosted Service.
3. It's not merged into master because the Exchange and Staking Subgraphs on the Hosted Service are still in production.