NOVO: Solana Privacy Rings já está disponível na mainnet
como usar a das api para retornar todos os ativos de uma coleção
Blog/Desenvolvimento

Solana Dev 101 — Como usar a DAS API para buscar todos os NFTs de uma coleção

Líder de Relações com DesenvolvedoresHunter Davis no LinkedIn
6 min de leitura

Visão geral

A API do Digital Asset Standard (DAS) é uma interface recém-lançada que unifica ativos comuns e compactados na Solana (tokens, NFTs etc.). Com a introdução dos ativos compactados, os desenvolvedores da Solana agora podem recuperar com mais eficiência todos os ativos associados a uma carteira, coleção ou autoridade, eliminando a necessidade de usar vários endpoints. A DAS API também é indexada nos bastidores, o que garante chamadas com o melhor desempenho para você como desenvolvedor. Com a DAS disponível, você pode simplificar o processo de recuperação de informações eliminando chamadas gPA demoradas. No endpoint getAssetsByOwner, você pode acessar metadados e informações off-chain de todos os ativos pertencentes a uma coleção específica usando o ID on-chain dela.

Neste tutorial, demonstraremos como usar a DAS API para recuperar informações sobre ativos da coleção Mad Lads. Para acompanhar usando nossa base de código atual, consulte o repositório do GitHub aqui. Você também pode consultar nossa abrangente documentação da DAS API para saber mais.

Pré-requisitos

  • Node.js instalado (v18.0 ou superior para usar o fetch integrado).
  • Conhecimento básico de JavaScript.

Como configurar seu ambiente

  1. Crie uma pasta chamada collection para este projeto.
  2. Dentro da pasta collection, crie um arquivo chamado assetList.js. Escreveremos nossa função nesse arquivo.
  3. Crie uma chave de API em nosso Portal do Desenvolvedor. Acesse RPCs e copie o link RPC da Mainnet, que será usado neste tutorial como a variável URL.
  4. Obtenha o ID de uma coleção certificada para fazer o teste com uma coleção de demonstração. Neste caso, usaremos Mad Lads, cujo ID da coleção é J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w. Você pode encontrar o endereço on-chain da coleção em um marketplace como o Magic Eden ao visualizar um NFT específico.

Etapas

Veja como usar a DAS API para recuperar informações sobre ativos de uma coleção de NFTs.

1. Crie a função getAssetsByGroup

Primeiro, vamos criar uma função para recuperar todos os ativos relacionados a uma coleção. Aninharemos nossa solicitação POST à DAS API dentro dessa função.

Comece definindo uma função assíncrona:

Código
const { promises : fs } = require("fs");
const url = `https://rpc.helius.xyz/?api-key=`;

const getAssetsByGroup = async () => {
// Code goes here.
};

getAssetsByGroup();

Nesta seção, importamos o módulo fs para lidar com operações do sistema de arquivos, identificamos a URL do RPC e declaramos a função getAssetsByGroup.

Substitua <api-key> pela sua chave de API do Portal do Desenvolvedor.

2. Crie uma solicitação POST para a DAS

Vamos definir a função getAssetsByGroup e especificar a página inicial e os parâmetros de retorno da solicitação. Usaremos a função fetch para seguir nossa documentação do método.

Código
console.time('getAssetsByGroup');
let page = 1;
let assetList = [];

Iniciamos um temporizador com console.time('getAssetsByGroup') e inicializamos variáveis para a página atual e um array vazio para armazenar os ativos buscados.

Usamos fetch com await para enviar uma solicitação POST assíncrona ao endpoint de URL especificado:

Código
try {
   while (page) {
    const response = await fetch(url, {
      method: 'POST',

Em seguida, entramos em um loop while que continuará buscando dados da API enquanto a variável page não for false.

Depois, usamos fetch com await, uma operação assíncrona usada para enviar solicitações HTTP. Especificamos o url do endpoint da API e definimos o método como 'POST'. Isso significa que estamos enviando dados ao servidor no corpo da solicitação.

Código
headers: {
	'Content-Type': 'application/json',
},

Nos cabeçalhos da solicitação, definimos 'Content-Type' como 'application/json'. Isso informa ao servidor que estamos enviando dados JSON.

Código
body: JSON.stringify({
	jsonrpc: '2.0',
	id: 'my-id',
	method: 'getAssetsByGroup',
	params: {
		groupKey: 'collection',
		groupValue: 'J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w',
		page: page,
		limit: 1000,
	},
}),

Depois disso, configuramos o corpo da solicitação, um objeto JSON que convertemos em string para um formato que possa ser enviado ao endpoint. É aqui que definimos nosso groupKey (que será “collection”) e nosso groupValue (que representará o ID on-chain da coleção).

Código
if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
    }

const { result } = await response.json();

Agora, geramos um erro caso a resposta do servidor não seja positiva. Se a solicitação for bem-sucedida, a resposta será processada no formato JSON.

Você poderá receber um erro se não houver uma chave de API válida definida na URL.

3. Adicione novos ativos à lista

No segmento anterior, inicialmente instruímos getAssetsByGroup a operar quando a página estivesse definida como 1. No entanto, a função ainda não está configurada para percorrer todas as páginas de resultados possíveis. Vamos configurar isso agora:

Código
assetList.push(...result.items);
    if (result.total !== 1000) {
      page = false;
    } else {
      page++;
    }
  }

Esse código adiciona os itens da resposta ao array assetList. Se o número total de resultados não for igual ao limite de 1.000, definiremos page como false para sair do loop.

4. Registre os ativos em um arquivo

Para salvar as informações recuperadas sobre os ativos em um arquivo JSON externo, adicione o seguinte código:

Código
const resultData = {
    totalResults: assetList.length,
    results: assetList,
  };

  await fs.writeFile('results.json', JSON.stringify(resultData, null, 2));
	console.log('Results saved to results.json')
  console.timeEnd('getAssetsByGroup');

Esse código cria um objeto resultData com a contagem total de resultados e o array assetList. Aplicamos fs.writeFile para gravar os dados em um arquivo JSON chamado results.json. Por fim, registramos uma mensagem de confirmação e encerramos o temporizador com console.timeEnd.

5. Implemente o tratamento de erros

Agora, precisamos criar uma proteção para lidar com possíveis falhas nas solicitações ao servidor. Isso pode ser feito com a configuração a seguir. Esse bloco de código registrará uma mensagem de erro em nosso console se ocorrer um problema durante a execução da solicitação.

Código
} catch (error) {
    console.error('Error occurred:', error);
}

Você poderá receber um erro na solicitação se não inserir um ID on-chain válido para a coleção.

Código final

Seu arquivo assetList.js deve ser semelhante ao trecho de código a seguir.

Código
const { promises : fs } = require("fs");
const url = `https://rpc.helius.xyz/?api-key=`;

const getAssetsByGroup = async () => {
  console.time('getAssetsByGroup'); // Start the timer
  let page = 1;
  let assetList = [];

try {
   while (page) {
    const response = await fetch(url, {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({
        jsonrpc: '2.0',
        id: 'my-id',
        method: 'getAssetsByGroup',
        params: {
          groupKey: 'collection',
          groupValue: 'J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w',
          page: page,
          limit: 1000,
        },
      }),
    });
		if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
    }
    const { result } = await response.json();

    assetList.push(...result.items);
    if (result.total !== 1000) {
      page = false;
    } else {
      page++;
    }
  }

  const resultData = {
    totalResults: assetList.length,
    results: assetList,
  };

  await fs.writeFile('results.json', JSON.stringify(resultData, null, 2));
	console.log('Results saved to results.json')
  console.timeEnd('getAssetsByGroup');

	} catch (error) {
    console.error('Error occurred:', error);
  }

};

getAssetsByGroup();

Resultado

Quando seu arquivo estiver semelhante ao código acima, você poderá executá-lo usando o comando node assetList.js no terminal para iniciar a solicitação. Isso gerará um arquivo results.json.

Após a conclusão, o console indicará que os resultados foram salvos no arquivo results.json e registrará o tempo necessário para buscar os ativos. Em nosso caso, ao usar Node.js para recuperar informações sobre os ativos da coleção on-chain Mad Lads, o processo levou em média 9,27 segundos.

Ao abrir o arquivo results.json, você verá o número total de resultados retornados, além dos detalhes dos ativos. Eles representarão os NFTs individuais que pertencem à coleção consultada.

Para personalizar ainda mais os dados retornados, você pode extrair informações específicas consideradas relevantes, como imagem, proprietário e outros metadados.

results.json

Código
{
  "totalResults": 9967,
  "results": [
    {
      "interface": "Custom",
      "id": "GVPX9rXRXo9SVGktJCzA3Qb9v263kQzEyAWsgX3LL8P5",
      "content": {
        "$schema": "https://schema.metaplex.com/nft1.0.json",
        "json_uri": "https://madlads.s3.us-west-2.amazonaws.com/json/859.json",
        "files": [
          {
            "uri": "https://madlads.s3.us-west-2.amazonaws.com/images/859.png",
            "cdn_uri": "https://cdn.helius.services/cdn-cgi/image//https://madlads.s3.us-west-2.amazonaws.com/images/859.png",
            "mime": "image/png"
          },
          {
            "uri": "https://arweave.net/qJ5B6fx5hEt4P7XbicbJQRyTcbyLaV-OQNA1KjzdqOQ/859.png",
            "cdn_uri": "https://cdn.helius.services/cdn-cgi/image//https://arweave.net/qJ5B6fx5hEt4P7XbicbJQRyTcbyLaV-OQNA1KjzdqOQ/859.png",
            "mime": "image/png"
          }
        ],
        "metadata": {
          "attributes": [
            {
              "value": "Male",
              "trait_type": "Gender"
            },
            {
              "value": "Galaxy",
              "trait_type": "Type"
            },
            {
              "value": "Galaxy",
              "trait_type": "Expression"
            },
            {
              "value": "Gambler",
              "trait_type": "Hat"
            },
            {
              "value": "Galaxy",
              "trait_type": "Eyes"
            },
            {
              "value": "Dark Windsor",
              "trait_type": "Clothing"
            },
            {
              "value": "Grey",
              "trait_type": "Background"
            }
          ],
          "description": "Fock it.",
          "name": "Mad Lads #859",
          "symbol": "MAD"
        },
        "links": {
          "external_url": null
        }
      },
      "authorities": [
        {
          "address": "2RtGg6fsFiiF1EQzHqbd66AhW7R5bWeQGpTbv2UMkCdW",
          "scopes": [
            "full"
          ]
        }
      ],
      "compression": {
        "eligible": false,
        "compressed": false,
        "data_hash": "",
        "creator_hash": "",
        "asset_hash": "",
        "tree": "",
        "seq": 0,
        "leaf_id": 0
      },
      "grouping": [
        {
          "group_key": "collection",
          "group_value": "J1S9H3QjnRtBbbuD4HjPV6RpRhwuk4zKbxsnCHuTgh9w"
        }
      ],
      "royalty": {
        "royalty_model": "creators",
        "target": null,
        "percent": 0.042,
        "basis_points": 420,
        "primary_sale_happened": true,
        "locked": false
      },
      "creators": [
        {
          "address": "5XvhfmRjwXkGp3jHGmaKpqeerNYjkuZZBYLVQYdeVcRv",
          "share": 0,
          "verified": true
        },
        {
          "address": "2RtGg6fsFiiF1EQzHqbd66AhW7R5bWeQGpTbv2UMkCdW",
          "share": 100,
          "verified": true
        }
      ],
      "ownership": {
        "frozen": false,
        "delegated": false,
        "delegate": null,
        "ownership_model": "single",
        "owner": "GX6KFMFS6yZGJzuZ28Q5Cbk9RN8Wv8UmNP2abcC4kcM2"
      },
      "supply": null,
      "mutable": true
    }, ...
    // Addtional Items
]

Isso mostrará todos os ativos retornados. Agora, você pode detalhar ainda mais os resultados para retornar apenas o endereço do token, o proprietário e diversas outras informações de metadados.

Conclusão

Parabéns! Você recuperou com sucesso todos os ativos de uma coleção com 10 mil itens usando a recém-lançada API do Digital Asset Standard (DAS). Em resumo:

  • A DAS API oferece uma abordagem simplificada para buscar ativos em dApps da Solana.
  • O método funciona tanto para coleções comuns quanto compactadas.
  • Ao usar a DAS API, você pode acessar metadados relevantes e informações de propriedade em menos de 15 segundos.

Com a DAS API, podemos simplificar a busca de ativos para dApps na Solana. Em vez de fazer várias chamadas de API para coletar informações, precisamos usar apenas um endpoint.

Abordaremos algumas outras opções simplificadas para retornar e interagir com ativos em tutoriais futuros.

Participe do nosso Discord e envie suas dúvidas!

‍

Assine a Helius

Acompanhe as novidades mais recentes do desenvolvimento Solana e receba atualizações quando publicarmos

Imagem ampliada