Começo Rápido

Aprenda como construir, editar, e solicitar queries de um subgraph do The Graph com facilidade.

Pré-requisitos

• Uma carteira de criptomoedas
• Um endereço de contrato inteligente numa rede apoiada
• Ter o Node.js⁠ instalado
• Um gestor de pacotes da sua escolha (npm, yarn ou pnpm)

Como Construir um Subgraph

1. Crie um subgraph no Subgraph Studio

Entre no Subgraph Studio e conecte a sua carteira de criptomoedas.

O Subgraph Studio permite a criação, gestão, implantação e edição de subgraphs, assim como a criação e a gestão de chaves de API.

Click “Create a Subgraph”. It is recommended to name the Subgraph in Title Case: “Subgraph Name Chain Name”.

2. Como instalar o Graph CLI

Execute um dos seguintes comandos na sua máquina local:

Uso de npm⁠:

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

Uso de yarn⁠:

1yarn global add @graphprotocol/graph-cli

3. Inicialize o seu Subgraph

O comando graph init criará automaticamente uma estrutura de subgraph com base nos eventos do seu contrato.

O comando a seguir inicializa o seu subgraph a partir de um contrato existente:

1graph init

Se o seu contrato for verificado no scanner de blocos respetivo onde foi implantado (por exemplo, Etherscan⁠), a interface binária de aplicativo será criada na CLI.

Ao inicializar o seu subgraph, a CLI pedirá pelas seguintes informações:

• Protocolo: Escolha o protocolo do qual o seu subgraph indexará dados.
• Slug do subgraph: crie um nome para o seu subgraph. O slug serve como uma identidade para o seu subgraph.
• Diretório: Escolha um diretório para criar o seu subgraph.
• Rede Ethereum (opcional): é possível que tenha de especificar a rede compatível com EVM de onde o seu subgraph indexará dados.
• Endereço de contrato: Localize o endereço do contrato inteligente do qual quer solicitar dados por queries.
• ABI (interface binária de aplicativo): Se a ABI não estiver preenchida automaticamente, insira-a manualmente como um arquivo JSON.
• Bloco Inicial: Insira o bloco inicial para poupar tempo enquanto o seu subgraph indexa dados da blockchain. O bloco inicial pode ser localizado ao encontrar o bloco onde o seu contrato foi implantado.
• Nome do Contrato: Insira o nome do seu contrato.
• Indexar eventos de contrato como entidades: Sugerimos configurar isto como true, já que ele automaticamente adicionará mapeamentos ao seu subgraph para cada evento emitido.
• Adicionar outro contrato (opcional): também é possível adicionar outro contrato.

Veja a imagem a seguir para um exemplo do que esperar quando for inicializar o seu subgraph:

4. Revise o seu Subgraph

O comando init no passo anterior cria uma estrutura de subgraph que pode ser usada como ponto de início para construir o seu subgraph.

Enquanto faz mudanças ao subgraph, você trabalhará principalmente com três arquivos:

• Manifest (subgraph.yaml) — define quais fontes de dados serão indexadas pelos seus subgraphs.
• Schema (schema.graphql) — define quais dados deseja retirar do subgraph.
• Mapeamentos em AssemblyScript (mapping.ts) — traduz dados das suas fontes de dados às entidades definidas no schema.

Para mais informações sobre como escrever o seu subgraph, veja Como Criar um Subgraph.

5. Implante o seu subgraph

Ao implantar um subgraph, você o envia para o Subgraph Studio, onde ele pode ser testado, preparado e revisto. A indexação de um subgraph implantado é realizada pelo Indexador de Atualização, que é um único Indexador operado pela Edge & Node (que também é a proprietária do mesmo), em vez dos muitos indexadores descentralizados na The Graph Network. Um subgraph implantado é gratuito para uso, limitado por taxa, não visível ao público e destinado a fins de programação, preparação e teste.

Quando o seu subgraph estiver pronto, execute os seguintes comandos:

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

Autentique e implante o seu subgraph. A chave de implantação (“deploy key”) pode ser encontrada na página do subgraph no Subgraph Studio.

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

A CLI solicitará um rótulo de versão. Recomendamos fortemente que use controle semântico de versão⁠; por exemplo, 0.0.1.

6. Analise o seu subgraph

Se quiser testar o seu subgraph antes de editá-lo, use o Subgraph Studio para:

• Executar um exemplo de query.

• Analisar o seu subgraph no painel de controlo para verificar informações.

• Verificar os registos no painel de controlo para ver se há erros com o seu subgraph. Os registos de um subgraph operacional parecerão com isto:

  

7. Edite o seu subgraph na The Graph Network

Quando o seu subgraph estiver pronto para um ambiente de produção, ele pode ser editado na rede descentralizada. Editar é uma ação na chain que:

• Torna o seu subgraph disponível para indexação pelos indexadores descentralizados na The Graph Network.
• Remove limites de taxa, e torna o seu subgraph disponível a buscas e queries no Graph Explorer.
• Disponibiliza o seu subgraph para curadoria por Curadores.

Como Editar com o Subgraph Studio

Para editar o seu subgraph, clique no botão Publish (“Editar”) no painel de controlo.

Selecione a rede onde deseja editar o seu subgraph.

Publicação da CLI

Desde a versão 0.73.0, é possível editar o seu subgraph com a Graph CLI.

Abra a graph-cli.

Use os seguintes comandos:

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

3. A window will open, allowing you to connect your wallet, add metadata, and deploy your finalized Subgraph to a network of your choice.

Para personalizar a sua implantação, veja Como Editar um Subgraph.

Adding signal to your Subgraph

1. Para atrair Indexadores de modo a fazer queries no seu subgraph, adicione um sinal de curadoria de GRT a ele.

   • Isto melhora a qualidade do serviço, reduz a latência, e aprimora a redundância e a disponibilidade da rede para o seu subgraph.

2. Se tiverem direito a recompensas por indexação, os Indexadores recebem recompensas em GRT com base na quantia sinalizada.

   • Recomendamos curar pelo menos 3.000 GRT para atrair 3 Indexadores. Verifique a elegibilidade de recompensas com base no uso de funções do subgraph e nas redes apoiadas.

Para saber mais sobre curadoria, clique aqui.

Para economizar gás, é possível selecionar o seu subgraph na mesma transação em que o edita através desta opção:

8. Consulte o seu Subgraph

Agora, você tem acesso a 100 mil queries grátis por mês com o seu subgraph na The Graph Network!

Agora, é possível solicitar queries do seu subgraph com o envio de queries da GraphQL para o URL de Query do seu subgraph, visível ao clicar no botão Query.

Para mais informações sobre queries de dados do seu subgraph, leia mais aqui.