Immersion en développement sur Ethereum. Partie 5: Oraclize

L'accès à des fichiers volumineux et à diverses données dynamiques externes est souvent une partie très importante d'une application décentralisée. Dans le même temps, Ethereum lui-même ne fournit pas de mécanisme pour se tourner vers l'extérieur - les contrats intelligents ne peuvent être lus et écrits que dans la blockchain elle-même. Dans cet article, nous considérerons Oraclize, qui permet simplement d'interagir avec le monde extérieur en interrogeant presque toutes les ressources Internet. Un sujet connexe est IPFS, et mentionnez-le brièvement.

IPFS

IPFS est un système de fichiers distribué avec adressage de contenu. Cela signifie que pour le contenu de tout fichier qui y est ajouté, un hachage unique est pris en compte. Le même hachage est ensuite utilisé pour rechercher et récupérer ce contenu à partir du réseau.
Les informations de base ont déjà été décrites dans cet article et dans plusieurs autres, nous ne voyons donc aucune raison de répéter.

Pourquoi utiliser IPFS en conjonction avec Ethereum?

Sauvegarder tout contenu de volume sur la blockchain est trop cher et dangereux pour le réseau. Par conséquent, la meilleure option consiste à enregistrer une sorte de lien vers le fichier situé dans le stockage hors chaîne, pas nécessairement IPFS. Mais IPFS présente un certain nombre d'avantages:

• Un lien de fichier est un hachage qui est unique au contenu spécifique du fichier, donc si nous mettons ce hachage sur la blockchain, nous pouvons être sûrs que le fichier reçu est celui qui a été ajouté à l'origine, le fichier ne peut pas être remplacé
• Le système distribué assure contre l'indisponibilité d'un serveur spécifique (en raison d'un blocage ou pour d'autres raisons)
• Le lien vers le fichier et la confirmation de hachage sont combinés sur une seule ligne, ce qui signifie que vous pouvez écrire moins sur la blockchain et économiser du gaz

Parmi les lacunes, on peut mentionner que puisqu'il n'y a pas de serveur central, alors pour l'accessibilité des fichiers il faut qu'au moins un fichier soit «distribué». Mais si vous avez un fichier spécifique, la connexion aux distributeurs est facile - démarrez votre démon ipfs et ajoutez le fichier via ipfs add .

La technologie est très adaptée à l'idéologie de la décentralisation, par conséquent, en considérant Oraclize maintenant, nous rencontrerons souvent l'utilisation d'IPFS dans différents mécanismes oracle.

Oraclize

Pour effectuer presque tous les travaux utiles, un contrat intelligent doit recevoir de nouvelles données. Cependant, il n'y a pas de capacité intégrée pour répondre à une demande de la blockchain au monde extérieur. Bien sûr, vous pouvez ajouter manuellement tout ce qui est requis par les transactions, mais il est impossible de vérifier d'où proviennent ces données et leur fiabilité. De plus, vous devrez peut-être organiser une infrastructure supplémentaire pour mettre à jour rapidement les données dynamiques, telles que les taux de change. Et les mises à jour à intervalle fixe entraîneront des dépassements de gaz.

Par conséquent, le service fourni par Oraclize est pratique: dans un contrat intelligent, vous pouvez envoyer une demande à presque n'importe quelle API ou ressource sur Internet, assurez-vous que les données reçues de la ressource spécifiée sont inchangées et utilisez le résultat dans le même contrat intelligent.

Oraclize n'est pas seulement un service Ethereum, des fonctionnalités similaires sont fournies à d'autres blockchains, mais nous ne décrirons le bundle qu'avec Ethereum.

Pour commencer

Tout ce qui est nécessaire pour commencer est d'ajouter l'un des fichiers oraclizeAPI du référentiel au projet. Il vous suffit de choisir celui qui convient à votre version du compilateur (solc): oraclizeAPI_0.5.sol pour les versions à partir de 0.4.18, oraclizeAPI_0.4.sol pour les versions à partir de 0.4.1, oraclizeAPI_pre0.4.sol pour tout ce qui est plus ancien, support Cette version a déjà été abandonnée. Si vous utilisez la truffe, n'oubliez pas de renommer le fichier à l'aide d'Oraclize - cela nécessite que le nom du fichier et le contrat correspondent.

En incluant le fichier approprié dans votre projet, vous usingOraclize le contrat de l' usingOraclize d' usingOraclize . Et vous pouvez commencer à utiliser Oracle, ce qui se résume à deux choses principales: envoyer une demande à l'aide de l'assistant oraclize_query , puis traiter le résultat dans la fonction __callback . Le contrat intelligent le plus simple (pour obtenir le prix actuel du temps d'antenne en dollars) pourrait ressembler à ceci:

 pragma solidity 0.4.23; import "./usingOraclize.sol"; contract ExampleContract is usingOraclize { string public ETHUSD; event updatedPrice(string price); event newOraclizeQuery(string description); function ExampleContract() payable { updatePrice(); } function __callback(bytes32 myid, string result) { require (msg.sender == oraclize_cbAddress()); ETHUSD = result; updatedPrice(result); } function updatePrice() payable { if (oraclize_getPrice("URL") > this.balance) { newOraclizeQuery("Oraclize query was NOT sent, please add some ETH to cover for the query fee"); } else { newOraclizeQuery("Oraclize query was sent, standing by for the answer.."); oraclize_query("URL", "json(https://api.coinmarketcap.com/v1/ticker/ethereum/?convert=USD).0.price_usd"); } } } 

La fonction qui envoie la demande est updatePrice . Vous pouvez voir qu'en premier lieu, il est vérifié que oraclize_getPrice(“URL”) supérieur au solde actuel du contrat. En effet, l'appel oraclize_query doit être payé, le prix est calculé comme la somme de la commission fixe et du paiement de gaz pour appeler le rappel. “URL” est une désignation d'un des types de sources de données, dans ce cas, il s'agit d'une simple demande via https, puis nous considérerons d'autres options. Les réponses sur demande peuvent être analysées à l'avance en json (comme dans l'exemple) et de plusieurs autres manières (nous examinerons plus loin). Une ligne de __callback est retournée dans __callback . Au tout début, il est vérifié que l'appel passé depuis l'adresse de confiance oraclize

Toutes les options pour utiliser oraclize sont construites selon un schéma, seules les sources de données et la possibilité d'ajouter une authentification à __callback . Par conséquent, dans les exemples futurs, nous ne citerons que des différences importantes.

Utiliser le prix

Comme déjà mentionné, de l'éther supplémentaire est payé pour les demandes oraclize, et il est retiré du solde du contrat, et non de l'adresse d'appel. Une exception est seulement la première demande de chaque nouveau contrat, elle est fournie gratuitement. Il est également intéressant de noter que les mêmes mécanismes sont conservés dans les réseaux de test, mais le paiement est effectué en diffusant le réseau correspondant, c'est-à-dire que dans les demandes de testnet sont pratiquement gratuites.

Il a déjà été mentionné que le prix demandé se compose de deux valeurs: une commission fixe et le paiement d'un rappel de gaz. Une commission fixe est définie en dollars et le montant de l'éther est calculé à partir du taux actuel. La commission dépend de la source des données et des mécanismes de soutien supplémentaires, sur lesquels nous nous attarderons. Le tableau des prix actuel ressemble à ceci:


Comme vous pouvez le voir, le prix par demande d'URL est de plusieurs cents. Est-ce beaucoup ou peu? Pour ce faire, considérons combien coûte la deuxième partie - les frais de gaz de rappel.
Cela fonctionne selon le schéma suivant: la quantité d'éther nécessaire pour payer une quantité fixe de gaz à un prix fixe est transférée à l'avance avec la demande du contrat. Ce montant devrait être suffisant pour effectuer un rappel, et le prix devrait être adapté au marché, sinon la transaction ne se fera pas ou se bloquera très longtemps. Dans le même temps, il est clair qu'il n'est pas toujours possible de connaître la quantité de gaz à l'avance, par conséquent, la planche doit également être en réserve (la réserve n'est pas restituée). Les valeurs par défaut sont une limite de 200 000 gaz au prix de 20 gwei. Cela suffit pour un rappel moyen avec plusieurs entrées et une sorte de logique. Et le prix de 20 gwei, bien qu'il puisse sembler trop élevé pour le moment (au moment de la rédaction, la moyenne est de 4 gwei), mais au moment de l'afflux de transactions, le prix du marché peut soudainement sauter et être encore plus élevé, donc en général, ces valeurs sont proches de celles réellement utilisées. Ainsi, avec de telles valeurs et le prix de l'air dans la région de 500 $, les paiements de gaz approcheront 2 $, nous pouvons donc dire qu'une commission fixe prend une petite partie.

Si vous savez ce que vous faites, il existe une option pour modifier la limite et le prix du gaz, économisant ainsi considérablement sur les demandes.

Le prix du gaz peut être défini par une fonction distincte - oraclize_setCustomGasPrice(< wei>) . Après l'appel, le prix est enregistré et utilisé dans toutes les demandes suivantes.
La limite peut être définie dans la requête oraclize_query - oraclize_query , en la spécifiant avec le dernier argument, par exemple comme ceci:

 oraclize_query("URL", "<>", 50000); 

Si vous avez une logique complexe dans __callback et que le gaz est consommé plus de 200k, alors vous devrez certainement définir une limite qui couvre le pire des cas de consommation de gaz. Sinon, si la limite est dépassée, __callback simplement __callback .

Soit dit en passant, oraclize a récemment obtenu des informations que vous pouvez payer pour des demandes en dehors de la blockchain, ce qui vous permettra de ne pas dépenser la totalité de la limite ou de retourner le solde (et le paiement ne provient pas du contrat). Nous n'avons pas encore eu à l'utiliser, mais oraclize propose de les contacter à info@oraclize.it, si cette option est intéressante. Par conséquent, gardez à l'esprit.

Comment ça marche

Pourquoi, ayant hérité d'un contrat intelligent régulier, obtenons-nous des fonctionnalités qui n'étaient pas initialement prises en charge par les mécanismes de la chaîne de blocs? En fait, le service Oracle ne consiste pas seulement en contrats avec des fonctions d'assistance. Le principal travail d'obtention des données est effectué par un service externe. Les contrats intelligents forment des applications pour accéder aux données externes et les mettent sur la blockchain. Service externe - surveille les nouveaux blocs de la blockchain et s'il détecte une application - l'exécute. Schématiquement, cela peut être représenté comme suit:

Sources de données

En plus de l' URL considérée, oraclize propose 4 autres options (que vous avez vues dans la section sur les prix): WolframAlpha , IPFS , random et computation . Examinons chacun d'eux.

1. URL

L'exemple déjà discuté utilise cette source de données. Il s'agit de la source des requêtes HTTP vers diverses API. L'exemple était le suivant:

 oraclize_query("URL", "json(https://api.coinmarketcap.com/v1/ticker/ethereum/?convert=USD).0.price_usd"); 

C'est le prix de l'éther, et comme api fournit une chaîne json avec un ensemble de données, la demande est enveloppée dans un analyseur json et retourne uniquement le champ dont nous avons besoin. Dans ce cas, il s'agit de GET, mais l'URL source prend également en charge les requêtes POST. Le type de demande est automatiquement déterminé par un argument supplémentaire. S'il y a un json valide comme dans cet exemple:

 oraclize_query("URL", "json(https://shapeshift.io/sendamount).success.deposit", '{"pair":"eth_btc","amount":"1","withdrawal":"1AAcCo21EUc1jbocjssSQDzLna9Vem2UN5"}') 

puis la demande est traitée comme POST (l'api utilisée est décrite ici , si vous êtes intéressé)

2. WolframAlpha

Cette source de données vous permet d'accéder au service WolframAlpha , qui peut fournir des réponses à diverses demandes de faits ou de calculs, par exemple

 oraclize_query(“WolframAlpha”, “president of Russia”) 

retournera Vladimir Putin , et demander

 oraclize_query(“WolframAlpha”, “solve x^2-4”) 

renverra x = 2 .
Comme vous pouvez le voir, le résultat a été incomplet car le symbole ± a été perdu. Par conséquent, avant d'utiliser cette source, vous devez vérifier que la valeur d'une demande spécifique peut être utilisée dans un contrat intelligent. De plus, l'authentification n'est pas prise en charge pour les réponses. Par conséquent, oraclize lui-même recommande que cette source soit utilisée uniquement pour les tests.

3. IPFS

Comme vous pouvez le deviner, il vous permet de récupérer le contenu d'un fichier dans IPFS à l'aide d'un multi-hachage. Le délai de réception du contenu est de 20 secondes.

 oraclize_query(“IPFS”, “QmTL5xNq9PPmwvM1RhxuhiYqoTJcmnaztMz6PQpGxmALkP”) 

reviendra Hello, Habr! (si le fichier avec ce contenu est toujours disponible)

4. aléatoire

La génération de nombres aléatoires fonctionne de la même manière que les autres sources, mais si vous utilisez oraclize_query , la préparation des arguments prend du temps. Pour éviter cela, vous pouvez utiliser la oraclize_newRandomDSQuery(delay, nbytes, customGasLimit) assistance oraclize_newRandomDSQuery(delay, nbytes, customGasLimit) , en définissant uniquement le délai d'exécution (en secondes), le nombre d'octets générés et la limite de gaz pour appeler __callback .
L'utilisation de random a quelques éléments à garder à l'esprit:

• Pour confirmer que le nombre est réellement aléatoire, un type spécial de vérification est utilisé - Ledger, qui peut être effectué sur la blockchain (contrairement à tout le monde, mais plus à ce sujet plus tard). Cela signifie que dans le constructeur du contrat intelligent, vous devez définir cette méthode de vérification par la fonction:
  
  

   oraclize_setProof(proofType_Ledger); 

  
  Et au début du rappel, il devrait y avoir un contrôle lui-même:
  
  

    function __callback(bytes32 _queryId, string _result, bytes _proof) { require (oraclize_randomDS_proofVerify__returnCode(_queryId, _result, _proof) == 0) ); <...> 

  
  Cette vérification nécessite un vrai réseau et ne fonctionnera pas sur la ganache, donc pour les tests locaux, vous pouvez supprimer temporairement cette ligne. Soit dit en passant, le troisième argument de __callback est le paramètre _proof facultatif. Il est toujours requis lorsque l'un des types de confirmation est utilisé.
• Si vous utilisez un nombre aléatoire pour les moments critiques, par exemple, pour déterminer le gagnant de la loterie, capturez les entrées des utilisateurs avant d'envoyer newRandomDSQuery. Sinon, cette situation peut se produire: oraclize appelle _callback et la transaction est visible par tous dans la liste en attente. Parallèlement à cela, le nombre aléatoire lui-même est visible. Si les utilisateurs peuvent continuer, grosso modo, à faire des paris, ils pourront alors spécifier un prix du gaz plus élevé et pousser leur taux avant que _callback ne soit exécuté, sachant à l'avance qu'il gagnera.

5. calcul

C'est la plus flexible des sources. Il vous permet d'écrire vos propres scripts et de les utiliser comme source de données. L'informatique a lieu sur AWS. Pour l'exécution, vous devez décrire le Dockerfile et le mettre ensemble avec des fichiers supplémentaires arbitraires dans une archive zip, et télécharger l'archive dans IPFS. La mise en œuvre doit remplir les conditions suivantes:

• Écrivez la réponse que vous souhaitez retourner avec la dernière ligne dans stdout
• La réponse ne doit pas dépasser 2500 caractères
• L'initialisation et l'exécution ne devraient pas prendre plus de 5 minutes au total

Pour un exemple de la façon dont cela est fait, nous verrons comment effectuer l'union la plus simple des lignes transmises et renvoyer le résultat.

Dockerfile:

 FROM ubuntu:16.04 MAINTAINER "info@rubyruby.ru" CMD echo "$ARG0 $ARG1 $ARG2 $ARG3" 

Variables d'environnement ARG0 , ARG1 , etc. - Ce sont les paramètres transmis avec la demande.
Ajoutez le dockerfile à l'archive, démarrez le serveur ipfs et ajoutez cette archive là

 $ zip concatenation.zip Dockerfile $ ipfs daemon & $ ipfs add concatenation.zip QmWbnw4BBFDsh7yTXhZaTGQnPVCNY9ZDuPBoSwB9A4JNJD 

Nous utilisons le hachage résultant pour envoyer la demande via oraclize_query dans le contrat intelligent:

 oraclize_query("computation", ["QmVAS9TNKGqV49WTEWv55aMCTNyfd4qcGFFfgyz7BYHLdD", "s1", "s2", "s3", "s4"]); 

Un tableau est utilisé comme argument, dans lequel le premier élément est l'archive multihash, et tous les autres sont les paramètres qui tombent dans les variables d'environnement.

Si vous attendez la fin de la demande, __callback résultat s1 s2 s3 s4 .

Assistants et sous-requêtes de l'analyseur

À partir de la réponse retournée par n'importe quelle source, vous pouvez présélectionner uniquement les informations requises à l'aide d'un certain nombre d'aides, telles que:

1. Analyseur JSON

Vous avez vu cette méthode dans le tout premier exemple, où seul le prix a été retourné à partir du résultat renvoyé par coinmarketcap:

 json(https://api.coinmarketcap.com/v1/ticker/ethereum/?convert=USD).0.price_usd 

Le cas d'utilisation est assez évident, renvoyant par exemple:

 [ { "id": "ethereum", "name": "Ethereum", "symbol": "ETH", "rank": "2", "price_usd": "462.857", "price_btc": "0.0621573", "24h_volume_usd": "1993200000.0", "market_cap_usd": "46656433775.0", "available_supply": "100800968.0", "total_supply": "100800968.0", "max_supply": null, "percent_change_1h": "-0.5", "percent_change_24h": "-3.02", "percent_change_7d": "5.93", "last_updated": "1532064934" } ] 

Puisqu'il s'agit d'un tableau, nous prenons l'élément 0 , et de lui - le champ price_usd

2. XML

L'utilisation est similaire à JSON, par exemple:

 xml(https://informer.kovalut.ru/webmaster/getxml.php?kod=7701).Exchange_Rates.Central_Bank_RF.USD.New.Exch_Rate 

3. HTML

Vous pouvez analyser XHTML à l'aide de XPath. Par exemple, obtenez une capitalisation boursière avec etherscan:

 html(https://etherscan.io/).xpath(string(//*[contains(@href, '/stat/supply')]/font)) 

MARKET CAP OF $46.148 BillionB

4. Aide binaire

Vous permet de couper des pièces à partir de données brutes à l'aide de la fonction tranche (décalage, longueur). Autrement dit, nous avons un fichier avec le contenu de "abc":

 echo "abc" > example.bin 

Mettez-le sur IPFS:

 $ ipfs add example.bin added Qme4u9HfFqYUhH4i34ZFBKi1ZsW7z4MYHtLxScQGndhgKE 

Coupez maintenant 1 caractère du milieu:

 binary(Qme4u9HfFqYUhH4i34ZFBKi1ZsW7z4MYHtLxScQGndhgKE).slice(1, 1) 

Dans la réponse, nous obtenons b

Comme vous l'avez peut-être remarqué, dans le cas de l'assistant binaire, ce n'est pas la source IP qui a été utilisée, mais IPFS. En fait, les analyseurs peuvent être appliqués à toutes les sources, disons qu'il n'est pas nécessaire d'appliquer JSON à ce qui renvoie l'URL, vous pouvez ajouter un tel contenu au fichier:

 { "one":"1", "two":"2" } 

Ajoutez-le à IPFS:

 $ ipfs add test.json added QmZinLwAq5fy4imz8ZNgupWeNFTneUqHjPiTPX9tuR7Vxp 

Et puis démontez comme ceci:

 json(QmZinLwAq5fy4imz8ZNgupWeNFTneUqHjPiTPX9tuR7Vxp).one 

Nous obtenons 1

Et un cas d'utilisation particulièrement intéressant consiste à combiner toutes les sources de données et tous les analyseurs en une seule demande. Cela est possible à l'aide d'une source de données nested distincte. Nous utilisons le fichier que nous venons de créer dans une requête plus complexe (ajout de valeurs dans deux champs):

 [WolframAlpha] add ${[IPFS] json(QmZinLwAq5fy4imz8ZNgupWeNFTneUqHjPiTPX9tuR7Vxp).one} to ${[IPFS] json(QmZinLwAq5fy4imz8ZNgupWeNFTneUqHjPiTPX9tuR7Vxp).two} 

Nous obtenons 3
La demande est formée comme suit: spécifiez la source de données nested , puis pour chaque demande, ajoutez le nom de la source devant elle entre crochets et encadrez en outre toutes les sous-requêtes dans ${..} .

Test

Oraclize fournit un service de validation de requête utile sans avoir besoin de contrats intelligents. Entrez simplement, choisissez une source de données, une méthode de vérification et vous pouvez voir qu'elle reviendra à __callback si vous envoyez les demandes correspondantes

Pour une vérification locale en conjonction avec un contrat intelligent, vous pouvez utiliser une version spéciale de l'EDI Remix qui prend en charge les demandes oraclize.

Et pour vérifier localement avec la ganache, vous aurez besoin du pont ethereum , qui déploiera ou activera les contrats intelligents sur votre testnet. Pour les tests, ajoutez d'abord la ligne suivante au constructeur de votre contrat:

 OAR = OraclizeAddrResolverI(0x6f485C8BF6fc43eA212E93BBF8ce046C7f1cb475); 

courir

 ganache-cli 

Alors

 node bridge --dev 

Attendez que les contrats soient morts et vous pourrez tester. Dans la sortie du node bridge de node bridge vous pouvez voir les demandes envoyées et les réponses reçues.

Une autre aide non seulement lors des tests, mais également lors de l'utilisation réelle est la possibilité de surveiller les demandes ici . Si vous faites une demande sur un réseau public, vous pouvez utiliser le hachage de la transaction dans laquelle la demande est exécutée. Si vous utilisez l'authentification, gardez à l'esprit qu'ils sont garantis pour être envoyés uniquement au réseau principal, pour les autres réseaux, il peut retourner 0. Si la demande était sur le réseau local, vous pouvez utiliser l'ID de la demande, qui renvoie oraclize_query . Soit dit en passant, il est recommandé de toujours conserver cet identifiant, par exemple, dans un mappage similaire:

 mapping(bytes32=>bool) validIds; 

Au moment de la demande, marquez l'ID envoyé comme true :

 bytes32 queryId = oraclize_query(<...>); validIds[queryId] = true; 

Et puis dans __callback vérifiez que la demande avec cet identifiant n'a pas encore été traitée:

 function __callback(bytes32 myid, string result) { require(validIds[myid] != bytes32(0)); require(msg.sender == oraclize_cbAddress()); validIds[myid] = bytes32(0); <...> 

Cela est nécessaire car __callback sur une demande peut être appelée plus d'une fois en raison des particularités des mécanismes Oraclize.

Authentification

Dans le tableau avec les sources, vous pouvez voir que différentes sources peuvent prendre en charge différents types de confirmations et que des frais différents peuvent être facturés. C'est une partie très importante d'Oraclize, mais une description détaillée de ces mécanismes est un sujet distinct.

Le mécanisme le plus couramment utilisé, au moins par nous, est TLSNotary avec stockage dans IPFS. Le stockage dans IPFS est plus efficace car __callback ne __callback pas la preuve elle-même (peut-être de l'ordre de 4 à 5 kilo-octets), mais un multi-hachage beaucoup plus petit. Pour spécifier ce type, ajoutez une ligne dans le constructeur:

 oraclize_setProof(proofType_TLSNotary | proofStorage_IPFS); 

Nous pouvons seulement dire que ce type, en gros, nous protège de l'inexactitude des données reçues d'Oraclize. Mais Oraclize utilise des serveurs Amazon, qui agissent en tant qu'auditeur, ils n'ont donc qu'à faire confiance.

Lisez plus ici .

Conclusion

Oraclize fournit des outils qui augmentent considérablement le nombre de cas d'utilisation pour les contrats intelligents, ainsi que IPFS, qui peuvent être vus dans plusieurs versions des requêtes Oracle. Le principal problème est que nous utilisons à nouveau des données externes soumises aux menaces que la blockchain aurait dû protéger: centralisation, capacités de blocage, changements de code, usurpation de contenu. Mais bien que cela soit inévitable et que l'option d'obtenir des données soit très utile et viable, il vous suffit de savoir pourquoi l'utilisation de la blockchain a été introduite dans le projet et si l'utilisation de sources externes non fiables réduit les avantages à zéro.

Si vous êtes intéressé par certains sujets de développement sur Ethereum qui n'ont pas encore été divulgués dans ces articles - écrivez dans les commentaires, nous les couvrirons peut-être ci-dessous.

Immersion en développement sur Ethereum:
Partie 1: Introduction
Partie 2: Web3.js et le gaz
Partie 3: application utilisateur
Partie 4: déployer et déboguer dans la truffe, la ganache, l'infura