revisions

Author: idalithb

website/pages/en/developing/creating-a-subgraph.mdx

@@ -2,14 +2,14 @@
 title: Creating a Subgraph
 ---
 
-This comprehensive guide provides detailed instructions to create a subgraph successfully.
+This detailed guide provides instructions to successfully create a subgraph.
 
 A subgraph extracts data from a blockchain, processes it, and stores it for efficient querying via GraphQL.
 
-Before you begin, ensure you [create an API Key](deploying/subgraph-studio-faqs/#2-how-do-i-create-an-api-key) to enable your subgraph on The Graph.
-
 ![Defining a Subgraph](/img/defining-a-subgraph.png)
 
+> In order to use your subgraph on The Graph's decentralized network, you will need to [create an API key](/deploying/subgraph-studio-faqs/#2-how-do-i-create-an-api-key) in [Subgraph Studio](https://thegraph.com/studio/apikeys/). It is recommended that you add signal to your subgraph with at least 3,000 GRT.
+
 ## Getting Started
 
 ### Install the Graph CLI
@@ -53,27 +53,29 @@ graph init \
   <SUBGRAPH_SLUG> [<DIRECTORY>]
 ```
 
-- The graph-cli relies on a public RPC endpoint, which is rate-limited. While occasional failures are expected, retries typically resolve the issue. If failures persist, consider using a local ABI.
+- The command tries to retrieve the contract ABI from Etherscan.
+
+  - The `graph-cli` relies on a public RPC endpoint. While occasional failures are expected, retries typically resolve this issue. If failures persist, consider using a local ABI.
 
 - If any of the optional arguments are missing, it guides you through an interactive form.
 
-- The `<SUBGRAPH_SLUG>` is the ID of your subgraph in Subgraph Studio. It can be found on your subgraph details page.
+- The `<SUBGRAPH_SLUG>` is the ID of your subgraph in [Subgraph Studio](https://thegraph.com/studio/). It can be found on your subgraph details page.
 
-### From a demo subgraph
+### From an example subgraph
 
 The following command creates a new project from an example subgraph:
 
 ```sh
 graph init --studio <SUBGRAPH_SLUG>
 ```
 
-- The example subgraph is based on the Gravity contract by Dani Grant, which manages user avatars and emits `NewGravatar` or `UpdateGravatar` events whenever avatars are created or updated.
+- The [example subgraph](https://github.com/graphprotocol/example-subgraph) is based on the Gravity contract by Dani Grant, which manages user avatars and emits `NewGravatar` or `UpdateGravatar` events whenever avatars are created or updated.
 
 - The subgraph handles these events by writing `Gravatar` entities to the Graph Node store and ensuring these are updated according to the events
 
 ### Add new dataSources to an existing subgraph
 
-Since v0.31.0, the `graph-cli` supports adding new dataSources to an existing subgraph through the `graph add` command:
+Since `v0.31.0`, the `graph-cli` supports adding new dataSources to an existing subgraph through the `graph add` command:
 
 ```sh
 graph add <address> [<subgraph-manifest default: "./subgraph.yaml">]
@@ -86,11 +88,9 @@ Options:
       --network-file <path>     Networks config file path (default: "./networks.json")
 ```
 
-**Specifics**
+#### Specifics
 
-The `add` command will fetch the ABI from Etherscan unless an ABI path is specified with the `--abi` option. Subsequently, it will create a new `dataSource` like `graph init` command creates a dataSource `--from-contract` and will update the schema and mappings accordingly.
-
-> Note: This allows you to index implementation contracts from their proxy contracts.
+The `add` command will fetch the ABI from Etherscan unless an ABI path is specified with the `--abi` option. Subsequently, it will create a new `dataSource` like `graph init` command creates a dataSource `--from-contract` and will update the schema and mappings accordingly. This allows you to index implementation contracts from their proxy contracts.
 
 - The `--merge-entities` option identifies how the developer would like to handle `entity` and `event` name conflicts:
 
@@ -106,39 +106,25 @@ The `add` command will fetch the ABI from Etherscan unless an ABI path is specif
 
 ### The Subgraph Manifest
 
-The subgraph manifest, `subgraph.yaml`, specifies the following:
-
-- The smart contracts to index
-
-- The events from these contracts
+The subgraph manifest, `subgraph.yaml`, defines the smart contracts your subgraph will index, the events from these contracts to pay attention to, and how to map event data to entities that Graph Node stores and allows to query.
 
-- The mapping of event data that Graph Node stores and queries
-
-The subgraph definition consists of the following files:
+The **subgraph definition** consists of the following files:
 
 - `subgraph.yaml`: Contains the subgraph manifest
 
 - `schema.graphql`: a GraphQL schema defining the data stored for your subgraph and how to query it via GraphQL.
 
-- `AssemblyScript` Mappings: [Assembly Script](https://github.com/AssemblyScript/assemblyscript) code that translates event data into entities defined in your schema (e.g. mapping.ts in this guide)
+- `mapping.ts`: [AssemblyScript Mappings](https://github.com/AssemblyScript/assemblyscript) code that translates event data into entities defined in your schema (e.g. `mapping.ts` in this guide)
 
 A single subgraph can:
 
-- Index data from multiple smart contracts
+- Index data from multiple smart contracts (but not multiple networks)
 
 - Add an entry for each contract that requires indexing to the `dataSources array`.
 
-The subgraph definition consists of a few files:
-
-- `subgraph.yaml`: a YAML file containing the subgraph manifest
-
-- `schema.graphql`: a GraphQL schema that defines what data is stored for your subgraph, and how to query it via GraphQL
-
-- `AssemblyScript Mappings`: [AssemblyScript](https://github.com/AssemblyScript/assemblyscript) code that translates from the event data to the entities defined in your schema (e.g. `mapping.ts` in this tutorial)
-
 The full specification for subgraph manifests can be found [here](https://github.com/graphprotocol/graph-node/blob/master/docs/subgraph-manifest.md).
 
-For the demo subgraph listed above, `subgraph.yaml` is:
+For the example subgraph listed above, `subgraph.yaml` is:
 
 ```yaml
 specVersion: 0.0.4
@@ -392,7 +378,7 @@ calls:
 Details for the example above:
 
 - ` global0X128` is the declared `eth_call`.
-- The text before colon(`global0X128`) is the label for this `eth_call` which is used when logging errors.
+- The text (`global0X128`) is the label for this `eth_call` which is used when logging errors.
 - The text (`Pool[event.address].feeGrowthGlobal0X128()`) is the actual `eth_call` that will be executed, which is in the form of `Contract[address].function(arguments)`
 - The `address` and `arguments` can be replaced with variables that will be available when the handler is executed.