Docs
⌘ K

5 dakika

Bir Subgraph'i Birden Fazla Ağda Dağıtma

This page explains how to deploy a Subgraph to multiple networks. To deploy a Subgraph you need to first install the Graph CLI⁠. If you have not created a Subgraph already, see Creating a Subgraph.

Deploying the Subgraph to multiple networks

In some cases, you will want to deploy the same Subgraph to multiple networks without duplicating all of its code. The main challenge that comes with this is that the contract addresses on these networks are different.

graph-cli Kullanarak

Hem graph build (v0.29.0’dan itibaren) hem de graph deploy (v0.32.0’dan itibaren) komutları iki yeni seçeneği kabul eder:

Seçenekler:      ...      --network <name>          Ağ yapılandırmasını networks config dosyasını kullanarak yapmak için      --network-file <path>     Ağ yapılandırma dosya yolu (varsayılan: "./networks.json")

You can use the --network option to specify a network configuration from a json standard file (defaults to networks.json) to easily update your Subgraph during development.

Not: Artık, init komutu, sağlanan bilgilere dayanarak otomatik olarak bir networks.json dosyası oluşturmaktadır. Daha sonra mevcut ağları güncelleyebilir veya yeni ağlar ekleyebilirsiniz.

Eğer bir networks.json dosyanız yoksa, aşağıdaki yapı ile manuel olarak oluşturmanız gerekecek:

{    "network1": { // ağ adı        "dataSource1": { //veri kaynağı adı            "address": "0xabc...", // sözleşme adresi (isteğe bağlı)            "startBlock": 123456 // başlangıç bloku (isteğe bağlı)        },        "dataSource2": {            "address": "0x123...",            "startBlock": 123444        }    },    "network2": {        "dataSource1": {            "address": "0x987...",            "startBlock": 123        },        "dataSource2": {            "address": "0xxyz..",            "startBlock": 456        }    },    ...}

Not: Yapılandırma dosyasında templates (şablonlar, eğer varsa) kısmını doldurmanıza gerek yoktur, yalnızca dataSources (veri kaynaklarını) belirtmelisiniz. Eğer subgraph.yaml dosyasında templates kısmı tanımlanmışsa, bunların ağı --network seçeneği ile belirtilen ağa otomatik olarak güncellenecektir.

Now, let’s assume you want to be able to deploy your Subgraph to the mainnet and sepolia networks, and this is your subgraph.yaml:

# ...dataSources:  - kind: ethereum/contract    name: Gravity    network: mainnet    source:      address: '0x123...'      abi: Gravity    mapping:      kind: ethereum/events

Ağ yapılandırma dosyanız şu şekilde olmalıdır:

{  "mainnet": {    "Gravity": {      "address": "0x123..."    }  },  "sepolia": {    "Gravity": {      "address": "0xabc..."    }  }}

Şimdi aşağıdaki komutlardan birini çalıştırabilirsiniz:

# Varsayılan networks.json dosyasını kullanarakyarn build --network sepolia# Özel adlandırılmış bir dosya kullanarakyarn build --network sepolia --network-file path/to/config

The build command will update your subgraph.yaml with the sepolia configuration and then re-compile the Subgraph. Your subgraph.yaml file now should look like this:

# ...dataSources:  - kind: ethereum/contract    name: Gravity    network: sepolia    source:      address: '0xabc...'      abi: Gravity    mapping:      kind: ethereum/events

Artık yarn deploy komutunu çalıştırmaya hazırsınız.

Not: Daha önce de belirtildiği gibi, graph-cli 0.32.0 sürümünden itibaren yarn deploy komutunu doğrudan --network seçeneğiyle çalıştırabilirsiniz:

# Varsayılan networks.json dosyasını kullanarakyarn deploy --network sepolia# Özel adlandırılmış bir dosya kullanarakyarn deploy --network sepolia --network-file path/to/config

subgraph.yaml şablonunu kullanarak:

Daha eski graph-cli sürümlerini kullanarak kontrat adresleri gibi unsurları parametrize etmenin bir yolu, bunların bir kısmını Mustache⁠ veya Handlebar⁠ gibi bir şablonlama sistemiyle oluşturmaktır.

To illustrate this approach, let’s assume a Subgraph should be deployed to mainnet and Sepolia using different contract addresses. You could then define two config files providing the addresses for each network:

{  "network": "mainnet",  "address": "0x123..."}

ve

{  "network": "sepolia",  "address": "0xabc..."}

Bununla birlikte, ağ adını ve adresleri manifesto içinde {{network}} ve {{address}} gibi değişken yer tutucularla değiştirir ve manifestoyu örneğin subgraph.template.yaml olarak yeniden adlandırırsınız:

# ...dataSources:  - kind: ethereum/contract    name: Gravity    network: mainnet    network: {{network}}    source:      address: '0x2E645469f354BB4F5c8a05B3b30A929361cf77eC'      address: '{{address}}'      abi: Gravity    mapping:      kind: ethereum/events

Her iki ağ için de bir manifesto oluşturmak amacıyla, package.json dosyasına mustache gereksinimiyle birlikte iki ek komut ekleyebilirsiniz:

{  ...  "scripts": {    ...    "prepare:mainnet": "mustache config/mainnet.json subgraph.template.yaml > subgraph.yaml",    "prepare:sepolia": "mustache config/sepolia.json subgraph.template.yaml > subgraph.yaml"  },  "devDependencies": {    ...    "mustache": "^3.1.0"  }}

To deploy this Subgraph for mainnet or Sepolia you would now simply run one of the two following commands:

# Mainnet:yarn prepare:mainnet && yarn deploy# Sepolia:yarn prepare:sepolia && yarn deploy

Bunun çalışan bir örneğini burada⁠ bulabilirsiniz.

Not: Bu yaklaşım, sözleşme adresleri ve ağ adlarının ötesinde daha fazla değişiklik yapmanın, veya şablonlardan mapping ya da ABI’ler oluşturmanın gerekli olduğu, daha karmaşık durumlara da uygulanabilir.

This will give you the chainHeadBlock which you can compare with the latestBlock on your Subgraph to check if it is running behind. synced informs if the Subgraph has ever caught up to the chain. health can currently take the values of healthy if no errors occurred, or failed if there was an error which halted the progress of the Subgraph. In this case, you can check the fatalError field for details on this error.

Subgraph Studio Subgraph archive policy

A Subgraph version in Studio is archived if and only if it meets the following criteria:

  • Sürüm ağa yayımlanmamıştır (veya yayım askıda kalmıştır)
  • Sürüm, 45 gün veya daha uzun bir süre önce oluşturulmuştur
  • The Subgraph hasn’t been queried in 30 days

In addition, when a new version is deployed, if the Subgraph has not been published, then the N-2 version of the Subgraph is archived.

Every Subgraph affected with this policy has an option to bring the version in question back.

Checking Subgraph health

If a Subgraph syncs successfully, that is a good sign that it will continue to run well forever. However, new triggers on the network might cause your Subgraph to hit an untested error condition or it may start to fall behind due to performance issues or issues with the node operators.

Graph Node exposes a GraphQL endpoint which you can query to check the status of your Subgraph. On the hosted service, it is available at https://api.thegraph.com/index-node/graphql. On a local node, it is available on port 8030/graphql by default. The full schema for this endpoint can be found here⁠. Here is an example query that checks the status of the current version of a Subgraph:

{  indexingStatusForCurrentVersion(subgraphName: "org/subgraph") {    synced    health    fatalError {      message      block {        number        hash      }      handler    }    chains {      chainHeadBlock {        number      }      latestBlock {        number      }    }  }}

This will give you the chainHeadBlock which you can compare with the latestBlock on your Subgraph to check if it is running behind. synced informs if the Subgraph has ever caught up to the chain. health can currently take the values of healthy if no errors occurred, or failed if there was an error which halted the progress of the Subgraph. In this case, you can check the fatalError field for details on this error.