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 RemixJS
application.
A key component to this example is the *.server
functionality provided by remix. These files are compiled and ran on the server and not available on the client. So having the /app/services/graphql.server.ts
file build our graph client instance, then our API Key only exists on the server layer and is not exposed via the network tab or client shipped JavaScript.
# 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 Key
API_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