2 minutes
La bibliothèque Graph TypeScript (graph-ts)
Bibliothèque TypeScript/AssemblyScript pour l’écriture de mappages de Subgraphs à déployer sur The Graph.
Usage
Pour un guide détaillé sur la création d’un Subgraph, veuillez consulter le document suivant Graph CLI docs.
Une étape de la création du Subgraph consiste à écrire des mappages qui traiteront les événements de la blockchain et écriront des entités dans le magasin. écrire des entités dans le store. Ces mappages sont écrits en TypeScript/AssemblyScript.
La bibliothèque graph-ts fournit des API pour accéder au store Graph Node, aux données de la blockchain, aux contrats intelligents, aux données sur IPFS, aux fonctions cryptographiques et plus encore. Pour l’utiliser, tout ce que vous avez à faire est d’ajouter une dépendance
une dépendance sur cette bibliothèque :
npm install --dev @graphprotocol/graph-ts # NPMyarn add --dev @graphprotocol/graph-ts # YarnEnsuite, vous pouvez importer l’API store et d’autres fonctionnalités de cette bibliothèque dans vos mappages. Quelques exemples :
import { crypto, store } from '@graphprotocol/graph-ts'// Ceci est juste un exemple de type d'événement généré par `graph-cli`// à partir d'un contrat intelligent Ethereum ABIimport { NameRegistered } from './types/abis/SomeContract'// Voici un exemple de type d'entité généré à partir du schéma GraphQL d'un subgraph.// schéma GraphQL d'un subgraphimport { Domain } from './types/schema'function handleNameRegistered(event: NameRegistered) { // Exemple d'utilisation d'une fonction crypto let id = crypto.keccak256(name).toHexString() // Exemple d'utilisation de la classe `Entry` générée let domain = new Domain() domain.name = name domain.owner = event.params.owner domain.timeRegistered = event.block.timestamp // Exemple d'utilisation du store API store.set('Name', id, entity)}Fonctions d’aide pour AssemblyScript
Référez-vous au fichier helper-functions.ts dans
this
pour quelques fonctions communes qui aident à construire au-dessus de la bibliothèque AssemblyScript, comme la concaténation de tableaux de byte, entre autres.
la concaténation de tableaux byte, entre autres.
API
La documentation sur l’API est disponible ici.
Pour des exemples d’utilisation de graph-ts, regardez l’un des Subgraphs suivants :
- https://github.com/graphprotocol/ens-subgraph
- https://github.com/graphprotocol/decentraland-subgraph
- https://github.com/graphprotocol/adchain-subgraph
- https://github.com/graphprotocol/0x-subgraph
- https://github.com/graphprotocol/aragon-subgraph
- https://github.com/graphprotocol/dharma-subgraph
Licence
Copyright © 2018 Graph Protocol, Inc. et contributeurs.
La bibliothèque TypeScript The Graph est soumise à une double licence, à savoir la licence MIT et de la licence Apache, version 2.0. Apache License, Version 2.0.
Sauf obligation légale ou accord écrit, le logiciel distribué dans le cadre de la licence est distribué « EN L’ÉTAT », SANS GARANTIE NI CONDITION DE QUELQUE NATURE QUE CE SOIT, expresse ou implicite. explicites ou implicites. Voir la Licence pour le langage spécifique régissant les permissions et les limitations dans le cadre de la La licence.