Hızlı Başlangıç

Learn how to easily build, publish and query a subgraph on The Graph.

Prerequisites

• Bir kripto cüzdanı
• A smart contract address on a supported network
• Node.js⁠ installed
• A package manager of your choice (npm, yarn or pnpm)

How to Build a Subgraph

1. Create a subgraph in Subgraph Studio

Subgraph Studio’ya gidin ve cüzdanınızı bağlayın.

Subgraph Studio, subgraph oluşturmanıza, yönetmenize, yayına almanıza ve yayımlamanıza, ayrıca API anahtarlarını oluşturmanıza ve yönetmenize olanak tanır.

“Subgraph Oluştur” düğmesine tıklayın. Subgraph’in adını başlık formunda vermeniz önerilir: “Subgraph Adı Ağ Adı”.

2. Graph CLI’yi yükleyin

Yerel makinenizde aşağıdaki komutlardan birini çalıştırın:

npm⁠ kullanarak:

1npm install -g @graphprotocol/graph-cli@latest

yarn⁠ kullanarak:

1yarn global add @graphprotocol/graph-cli

3. Subgraph’inizi başlatın

The graph init command will automatically create a scaffold of a subgraph based on your contract’s events.

Aşağıdaki komut, subgraph’inizi mevcut bir akıllı sözleşmeden başlatır:

1graph init

If your contract is verified on the respective blockscanner where it is deployed (such as Etherscan⁠), then the ABI will automatically be created in the CLI.

Subgraph’inizi başlattığınızda, CLI sizden aşağıdaki bilgileri isteyecektir:

• 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 in.
• 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.

Subgraph’ınızı başlatırken neyle karşılaşacağınıza dair bir örnek için aşağıdaki ekran görüntüsüne bakın:

4. Edit your subgraph

Önceki adımda init komutu, subgraph’inizi oluşturmak için kullanabileceğiniz bir iskelet subgraph yaratır.

Subgraph’inizde değişiklik yaparken, ağırlıklı olarak üç dosya ile çalışacaksınız:

• Manifesto (subgraph.yaml): Subgraph’inizin hangi veri kaynaklarını endeksleyeceğini tanımlar.
• Şema (schema.graphql): Subgraph’ten hangi veriyi almak istediğinizi tanımlar.
• AssemblyScript Eşlemeleri (mapping.ts): Veri kaynaklarınızdan gelen veriyi şemada tanımlanan varlıklara dönüştürür.

Subgraph yazımı hakkında ayrıntılı bilgi için Subgraph Oluşturma sayfasına göz atın.

5. Subgraph’inizi yayına alın

When you deploy a subgraph, you push it to Subgraph Studio, where you can test, stage and review it. A deployed subgraph’s indexing is performed by the Upgrade Indexer, which is a single Indexer owned and operated by Edge & Node, rather than by the many decentralized Indexers in The Graph Network. A deployed subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes.

Subgraph’ınız yazıldıktan sonra aşağıdaki komutları çalıştırın:

1```sh2graph codegen && graph build3```

Subgraph’inizi kimlik doğrulayıp yayına alın. Yayına alma anahtarını, Subgraph Studio’daki subgraph sayfasında bulabilirsiniz.

1```sh23graph auth <DEPLOY_KEY>45graph deploy <SUBGRAPH_SLUG>6```

The CLI will ask for a version label. It’s strongly recommended to use semantic versioning⁠, e.g. 0.0.1.

6. Subgraph’inizi gözden geçirin

If you’d like to test your subgraph before publishing it, you can use Subgraph Studio to do the following:

• Örnek bir sorgu çalıştırabilirsiniz.

• Subgraph’iniz hakkında bilgi kontrol etmek için kontrol panelini analiz edebilirsiniz.

• Subgraph’inizde hata olup olmadığını görmek için kontrol panelindeki kayıtları kontrol edin. Çalışan bir subgraph’in kayıtları şu şekilde görünecektir:

  

7. Subgraph’inizi The Graph Ağında yayımlayın

When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing is an onchain action that does the following:

• It makes your subgraph available to be to indexed by the decentralized Indexers on The Graph Network.
• It removes rate limits and makes your subgraph publicly searchable and queryable in Graph Explorer.
• It makes your subgraph available for Curators to curate it.

Subgraph Studio ile yayımlama

Subgraph’inizi yayımlamak için, kontrol panelindeki Yayımla düğmesine tıklayın.

Subgraph’inizi yayımlamak istediğiniz ağı seçin.

CLI’den Yayımlama

Sürüm 0.73.0 itibarıyla, subgraph’inizi Graph CLI ile de yayımlayabilirsiniz.

graph-cliyi açın.

Şu komutları kullanın:

1```sh2graph codegen && graph build3```45Then,67```sh8graph publish9```

3. Bir pencere açılır ve cüzdanınızı bağlamanıza, metaveri eklemenize ve tamamlanmış subgraph’inizi tercih ettiğiniz bir ağa dağıtmanıza olanak tanır.

To customize your deployment, see Publishing a Subgraph.

Subgraph’inize sinyal ekleme

1. To attract Indexers to query your subgraph, you should add GRT curation signal to it.

   • Bu işlem, hizmet kalitesini artırır, gecikmeyi azaltır ve subgraph’inizin ağdaki yedekliliğini ve müsaitliğini artırır.

2. Endeksleme ödüllerine hak kazanan Endeksleyiciler sinyal miktarına bağlı olarak GRT ödülü alırlar.

   • En az 3 Endeksleyici çekmek için en az 3.000 GRT küratörlük yapmanız önerilir. Subgraph özelliği kullanımı ve desteklenen ağlara bağlı olarak ödül hak kazanımlarının nasıl dağıtıldığını kontrol edin.

To learn more about curation, read Curating.

Gas maliyetlerinden tasarruf etmek için, subgraph’inizi küratörlük işlemini, yayımlama işlemiyle aynı anda yapabilirsiniz. Bunun için şu seçeneği seçin:

8. Subgraph’inizi sorgulama

You now have access to 100,000 free queries per month with your subgraph on The Graph Network!

You can query your subgraph by sending GraphQL queries to its Query URL, which you can find by clicking the Query button.

For more information about querying data from your subgraph, read Querying The Graph.