diff --git a/website/pages/en/cookbook/_meta.js b/website/pages/en/cookbook/_meta.js index 7e889981d65e..5b5b369c3563 100644 --- a/website/pages/en/cookbook/_meta.js +++ b/website/pages/en/cookbook/_meta.js @@ -1,5 +1,4 @@ export default { - 'base-testnet': '', 'upgrading-a-subgraph': '', 'subgraph-debug-forking': '', near: '', diff --git a/website/pages/en/cookbook/base-testnet.mdx b/website/pages/en/cookbook/base-testnet.mdx deleted file mode 100644 index fc2eb555e7ae..000000000000 --- a/website/pages/en/cookbook/base-testnet.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: Building Subgraphs on Base ---- - -This guide will quickly take you through how to initialize, create, and deploy your subgraph on Base testnet. - -What you'll need: - -- A Base Sepolia testnet contract address -- A crypto wallet (e.g. MetaMask or Coinbase Wallet) - -## Subgraph Studio - -### 1. Install the Graph CLI - -The Graph CLI (>=v0.41.0) is written in JavaScript and you will need to have either `npm` or `yarn` installed to use it. - -```sh -# NPM -npm install -g @graphprotocol/graph-cli - -# Yarn -yarn global add @graphprotocol/graph-cli -``` - -### 2. Create your subgraph in Subgraph Studio - -Go to [Subgraph Studio](https://thegraph.com/studio/) and connect your crypto wallet. - -Once connected, click "Create a Subgraph", enter a name for your subgraph and click Create a Subgraph. - -### 3. Initialize your Subgraph - -> You can find specific commands for your subgraph in Subgraph Studio. - -Make sure that the graph-cli is updated to latest (above 0.41.0) - -```sh -graph --version -``` - -Initialize your subgraph from an existing contract. - -```sh -graph init --studio -``` - -Your subgraph slug is an identifier for your subgraph. The CLI tool will walk you through the steps for creating a subgraph, including: - -- Protocol: ethereum -- Subgraph slug: `` -- Directory to create the subgraph in: `` -- Ethereum network: base-sepolia -- Contract address: `` -- Start block (optional) -- Contract name: `` -- Yes/no to indexing events (yes means your subgraph will be bootstrapped with entities in the schema and simple mappings for emitted events) - -### 3. Write your Subgraph - -> If emitted events are the only thing you want to index, then no additional work is required, and you can skip to the next step. - -The previous command creates a scaffold subgraph that you can use as a starting point for building your subgraph. When making changes to the subgraph, you will mainly work with three files: - -- Manifest (subgraph.yaml) - The manifest defines what datasources your subgraphs will index. Make sure to add `base-sepolia` as the network name in manifest file to deploy your subgraph on Base Sepolia. -- Schema (schema.graphql) - The GraphQL schema defines what data you wish to retrieve from the subgraph. -- AssemblyScript Mappings (mapping.ts) - This is the code that translates data from your datasources to the entities defined in the schema. - -If you want to index additional data, you will need to extend the manifest, schema and mappings. - -For more information on how to write your subgraph, see [Creating a Subgraph](/developing/creating-a-subgraph). - -### 4. Deploy to Subgraph Studio - -Before you can deploy your subgraph, you will need to authenticate with Subgraph Studio. You can do this by running the following command: - -Authenticate the subgraph on studio - -``` -graph auth --studio -``` - -Next, enter your subgraph's directory. - -``` - cd -``` - -Build your subgraph with the following command: - - ``` - graph codegen && graph build - ``` - -Finally, you can deploy your subgraph using this command: - - ``` - graph deploy --studio - ``` - -### 5. Query your subgraph - -Once your subgraph is deployed, you can query it from your dapp using the `Development Query URL` in Subgraph Studio. - -Note - Studio API is rate-limited. Hence should preferably be used for development and testing. - -To learn more about querying data from your subgraph, see the [Querying a Subgraph](/querying/querying-the-graph) page.