Demos how to query the Graph Network Arbitrum Subgraph published to The Graph Network using an API Key obtained on The Graph Studio in a Nuxt application.
A key component to this example is that queries to the Subgraph are routed through the nuxt api. This helps with a specific use-case of helping to secure your API Key; either through the client-side JavaScript shipped to the browser, or through network requests. This is a good way to build a dapp that queries a Subgraph that secures your API Key to prevent leaks. The downside to this approach is that each request makes two HTTP requests:
- from the nuxt app client/ssr to the nuxt api that queries the Subgraph on
/api/graphql - from the nuxt graphql api to the Subgraph.
This is an important consideration when building a dapp that queries the Subgraph.
See the graphql api file to see how the Subgraph is queried using your API Key set in the env. App.vue then queries the /api/graphql api to retrieve data that is then retrieved by querying the Subgraph.
# Clone Repo
git clone [email protected]:graphprotocol/query-examples.git
# CD into remix example
cd ./examples/remix
# Install bun package manager, if needed
curl -fsSL https://bun.sh/install | bash
# Install deps
bun install
# Run
bun run dev# Copy the example env file into a .env
cp ./.env.example ./.env
# replace the `{your api key here}` with your API KeyAPI_KEY- the 32-digit API Key created in The Graph Studio.- Note in this example, the env var is exposed to the client.
This repo utilizes graphql codegen. This validates our graphql and generates types to match the queries written for the app. These types can then be used to make our components type-safe to the graphql queries that will hydrate them.
# have to run the app
bun run dev
# run graphql codegen to regen types from updated queries
bun run codegen.gql