Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editing Quick Start #823

Merged
merged 3 commits into from
Nov 22, 2024
Merged

Editing Quick Start #823

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb72a42
Edit Quick Start
MichaelMacaulay Nov 22, 2024
4e0db33
tiny copy change
MichaelMacaulay Nov 22, 2024
5379c5c
Update website/pages/en/quick-start.mdx
MichaelMacaulay Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions website/pages/en/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,20 @@ You can find commands for your specific subgraph on the subgraph page in [Subgra

When you initialize your subgraph, the CLI will ask you for the following information:

- Protocol: Choose the protocol your subgraph will be indexing data from.
- Subgraph slug: Create a name for your subgraph. Your subgraph slug is an identifier for your subgraph.
- Directory to create the subgraph in: Choose your local directory.
- Ethereum network (optional): You may need to specify which EVM-compatible network your subgraph will be indexing data from.
- Contract address: Locate the smart contract address you’d like to query data from.
- ABI: If the ABI is not auto-populated, you will need to input it manually as a JSON file.
- Start Block: You should input the start block to optimize subgraph indexing of blockchain data. Locate the start block by finding the block where your contract was deployed.
- Contract Name: Input the name of your contract.
- Index contract events as entities: It is suggested that you set this to true, as it will automatically add mappings to your subgraph for every emitted event.
- Add another contract (optional): You can add another contract.
- **Protocol**: Choose the protocol your subgraph will be indexing data from.
- **Subgraph slug**: Create a name for your subgraph. Your subgraph slug is an identifier for your subgraph.
- **Directory**: Choose a directory to create your subgraph.
MichaelMacaulay marked this conversation as resolved.
Show resolved Hide resolved
- **Ethereum network** (optional): You may need to specify which EVM-compatible network your subgraph will be indexing data from.
- **Contract address**: Locate the smart contract address you’d like to query data from.
- **ABI**: If the ABI is not auto-populated, you will need to input it manually as a JSON file.
- **Start Block**: You should input the start block to optimize subgraph indexing of blockchain data. Locate the start block by finding the block where your contract was deployed.
- **Contract Name**: Input the name of your contract.
- **Index contract events as entities**: It is suggested that you set this to true, as it will automatically add mappings to your subgraph for every emitted event.
- **Add another contract** (optional): You can add another contract.

See the following screenshot for an example for what to expect when initializing your subgraph:

![Subgraph command](/img/subgraph-init-example.png)
![Subgraph command](/img/CLI-Example.png)

### 4. Write your subgraph

Expand Down
Binary file added website/public/img/CLI-Example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed website/public/img/subgraph-init-example.png
View file
Open in desktop
Binary file not shown.
Loading