← Blog
10 min de lecture
|
Publié le
|
Mis à jour le

API blockchain dans les applications Web3

Ce que fait une API blockchain dans une application Web3 : lecture des données, envoi de transactions, notifications, et rôle des oracles.

Chapitres
C
Chaingateway Team
Experts blockchain

Relu par Maurice Sobiera

Une API blockchain est une interface web qui permet à une application de lire des données blockchain et de soumettre des transactions sans faire tourner son propre nœud. Dans une application Web3, elle se place entre l’interface utilisateur et la chaîne. Les smart contracts ne peuvent pas appeler eux-mêmes des API web : les données venant de l’extérieur de la chaîne leur parviennent par l’intermédiaire d’oracles.

Cet article distingue les deux sens dans lesquels les API et les blockchains se connectent, et explique où chacun est utilisé.

Que fait une API blockchain dans une application Web3 ?

Une API blockchain fournit trois services à une application : elle lit les données de la chaîne, elle soumet des transactions et elle signale des événements. Sans elle, votre backend devrait faire tourner un nœud, le maintenir synchronisé et analyser lui-même les blocs.

FonctionExempleFonctionnement
LireSolde d’une adresse, transactions d’un blocUne requête à un nœud ou à un fournisseur d’API
ÉcrireEnvoyer un transfert de tokenLa transaction est signée avec une clé privée, puis diffusée sur le réseau
NotifierPrévenir le backend qu’un dépôt est arrivéUn webhook, ou l’interrogation du nœud

Chaingateway est une API de ce type. Ses endpoints de portefeuille, de transfert et de webhook sont listés dans le fichier OpenAPI. Des webhooks existent pour Bitcoin, Ethereum, BNB Smart Chain, Polygon, Arbitrum et Tron. Solana n’a pas de webhooks : une application Solana doit donc interroger la chaîne.

Pourquoi un smart contract ne peut-il pas appeler une API web ?

Un smart contract ne peut pas appeler une API web, car chaque nœud doit l’exécuter et aboutir au même résultat. La documentation d’Ethereum indique que récupérer des données externes rendrait le déterminisme impossible : une API de prix pourrait renvoyer des valeurs différentes à des nœuds différents, qui ne seraient plus d’accord sur l’état de la chaîne (ethereum.org : oracles).

C’est une propriété de la conception. Elle ne dépend ni du langage de la chaîne ni d’une API particulière. La conséquence : les données doivent être inscrites sur la chaîne par une transaction avant qu’un contrat puisse les utiliser.

Comment les données externes parviennent-elles à un smart contract ?

Les données externes atteignent un contrat par l’intermédiaire d’un oracle. Un oracle est une application qui collecte, vérifie et transmet des informations externes aux smart contracts. Un protocole de prêt qui a besoin du cours d’un actif, ou un contrat qui dépend de données météo ou de vols, en a besoin.

La documentation d’Ethereum décrit deux schémas courants :

  • Publication-abonnement : l’oracle publie un flux de données, et les contrats le lisent. Ce schéma convient aux données qui changent souvent, comme les cours des tokens.
  • Requête-réponse : un contrat demande des données précises, et l’oracle répond par un callback. Ce schéma convient aux grands jeux de données dont un contrat n’a besoin que d’une petite partie. Le demandeur paie la recherche et le gas du callback.

Un oracle exploité par une seule partie est un point de défaillance unique. Si cette partie tombe en panne, se fait pirater ou ment, le contrat agit sur de mauvaises données. La même documentation décrit des services d’oracles décentralisés, où plusieurs participants s’accordent sur les données avant qu’elles n’atteignent le contrat. La décentralisation est un spectre, et il vous revient de décider quelle confiance accorder à l’oracle choisi.

Quelle API faut-il pour quelle tâche ?

La réponse dépend du sens du flux de données.

SensProblèmeOutil
De la chaîne vers l’applicationLire des soldes, envoyer des transferts, recevoir des notifications de dépôtAPI blockchain ou votre propre nœud
Du monde extérieur vers le contratDonner à un contrat un prix, un score ou une valeur météoOracle
Du contrat vers le monde extérieurDéclencher une action après un événement on-chainLogs d’événements lus par un service, ou un oracle

Un système de paiement n’utilise que la première ligne. Un utilisateur paie vers une adresse, un webhook atteint votre backend, et votre backend crédite le compte dans sa propre base de données. Aucun oracle n’intervient. Voir blockchain vs base de données pour savoir comment répartir le travail entre la chaîne et votre base.

Comment une application lit-elle les événements d’un contrat ?

Une application lit les événements d’un contrat via les logs. Lorsqu’un contrat émet un événement, le nœud le stocke dans le reçu de la transaction. La méthode eth_getLogs de l’API JSON-RPC d’Ethereum, qui suit la spécification JSON-RPC 2.0, renvoie les logs correspondant à un filtre. C’est la méthode habituelle pour retrouver les transferts de tokens.

Un filtre pour les événements Transfer d’un token ERC-20, sur une plage de blocs, ressemble à ceci :

{
"jsonrpc": "2.0",
"method": "eth_getLogs",
"params": [{
"fromBlock": "0x10d4f00",
"toBlock": "0x10d4f0a",
"address": "0xTokenContract",
"topics": ["0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"]
}],
"id": 1
}

Le premier topic est le hash de la signature de l’événement Transfer(address,address,uint256). Les autres topics contiennent les arguments indexés, ici l’expéditeur et le destinataire. Le montant figure dans le champ data de chaque log, sous forme de nombre hexadécimal.

Les plages de blocs comptent. De nombreux fournisseurs limitent la plage ou le nombre de résultats d’un appel eth_getLogs, si bien qu’un scanner doit parcourir les blocs page par page. Une API blockchain qui décode ces logs à votre place, ou les transmet en webhooks, supprime ce code. Elle ne change pas pour autant leur signification : un log contenu dans un bloc réorganisé plus tard disparaît avec ce bloc.

Quelles sont les limites des API blockchain ?

Une API ne modifie pas le fonctionnement de la chaîne. Une transaction n’est finale que lorsque la chaîne le dit, et une API peut la signaler comme en attente ou confirmée plus tôt que cela. Ne considérez un dépôt comme réglé qu’après le passage des règles de finalité de la chaîne.

Les livraisons de webhooks échouées ne sont pas relancées automatiquement. Chaingateway les liste dans l’endpoint des notifications échouées de chaque chaîne, par exemple GET /api/v2/tron/webhooks/notifications/failed, et vous les renvoyez avec l’endpoint de relance. Un backend qui traite les webhooks doit aussi être idempotent, afin qu’une notification renvoyée ne crédite pas un compte deux fois.

Une API hébergée ajoute aussi une dépendance envers le fournisseur. Si vous avez besoin d’un accès direct au protocole, vous pouvez toujours faire tourner un nœud et lui parler via JSON-RPC.

Comment nous rédigeons ces articles

Prêt à le construire vous-même ? Obtenir votre clé API — essai de 7 jours, sans carte bancaire — ou consultez API Blockchain pour la référence complète des endpoints.

C
Chaingateway Team
Experts blockchain

L'équipe Chaingateway s'attache à simplifier l'intégration blockchain pour les développeurs du monde entier.