README.md

PancakeSwap Subgraph

TheGraph exposes a GraphQL endpoint to query the events and entities within the Binance Smart Chain and PancakeSwap ecosystem.

Currently, there are multiple subgraphs, but additional subgraphs can be added to this repository, following the current architecture.

Subgraphs

1. Blocks: Tracks all blocks on Binance Smart Chain.

2. Exchange V2: Tracks all PancakeSwap V2 Exchange data with price, volume, liquidity, ...

3. Farm Auctions: Tracks all PancakeSwap Farm Auctions with auctions and bids.

4. Lottery: Tracks all PancakeSwap Lottery with rounds, draws and tickets.

5. NFT Market (v1): Tracks all PancakeSwap NFT Market for ERC-721.

6. Pairs: Tracks all PancakeSwap Pairs and Tokens.

7. Pancake Squad: Tracks all Pancake Squad metrics with Owners, Tokens (including metadata), and Transactions.

8. Prediction (v1): Tracks all PancakeSwap Prediction (v1) with market, rounds, and bets.

9. Prediction (v2): Tracks all PancakeSwap Prediction (v2) with market, rounds, and bets.

10. Profile: Tracks all PancakeSwap Profile with teams, users, points and campaigns.

11. SmartChef: Tracks all PancakeSwap SmartChef (a.k.a. Syrup Pools) with tokens and rewards.

12. Timelock: Tracks all PancakeSwap Timelock queued, executed, and cancelled transactions.

13. Trading Competition (v1): Tracks all metrics for the Easter Battle (April 07—14, 2021).

14. MasterChef (v2): Tracks data for MasterChefV2.

15. MasterChef (v3): Tracks data for MasterChefV3.

    • BSC https://thegraph.com/hosted-service/subgraph/pancakeswap/masterchef-v3-bsc
    • BSC testnet https://thegraph.com/hosted-service/subgraph/pancakeswap/masterchef-v3-chapel
    • ETH https://thegraph.com/hosted-service/subgraph/pancakeswap/masterchef-v3-eth
    • ETH https://thegraph.com/hosted-service/subgraph/pancakeswap/masterchef-v3-goerli

16. Exchange (v3): Tracks all PancakeSwap V3 Exchange data with price, volume, liquidity

    • BSC https://thegraph.com/hosted-service/subgraph/pancakeswap/exchange-v3-bsc
    • BSC testnet https://thegraph.com/hosted-service/subgraph/pancakeswap/exchange-v3-chapel
    • ETH https://thegraph.com/hosted-service/subgraph/pancakeswap/exchange-v3-eth
    • ETH https://thegraph.com/hosted-service/subgraph/pancakeswap/exchange-v3-goerli

Dependencies

• Graph CLI
  • Required to generate and build local GraphQL dependencies.

yarn global add @graphprotocol/graph-cli

Deployment

For any of the subgraph: blocks as [subgraph]

1. Run the cd subgraphs/[subgraph] command to move to the subgraph directory.

2. Run the yarn codegen command to prepare the TypeScript sources for the GraphQL (generated/*).

3. Run the yarn build command to build the subgraph, and check compilation errors before deploying.

4. Run graph auth --product hosted-service '<ACCESS_TOKEN>'

5. Deploy via yarn deploy.

v1

To access subgraphs related to PancakeSwap v1 ecosystem (article), use v1 branch.