Graph Protocol Workshops, 8 Jul 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Building a Subgraph with Subgraph Studio

Description

In this video, you'll learn how to create, test, and publish a subgraph to The Graph's decentralized network using Subgraph Studio, Graph CLI, and Graph TypeScript library.

Zora contract address referenced in video:
0xabEFBc9fD2F806065b4f3C237d4b59D9A97Bcac7

The Graph Website
http://thegraph.com/

A

In this video you'll learn how to build and publish a subgraph to the graph explorer with subgraph studio.

A

The subgraph that we'll be building today will be indexing data from the zora smart contract. Zora is a popular nft marketplace.

A

To be successful in this guide, you should have a metamask wallet installed as an extension to your web browser, as well as nodejs, installed locally on your machine to get started, navigate to thegraph.com studio.

A

Here you'll see a button to connect your wallet, choose meta, mask and then choose the address that you would like to authenticate.

A

With to create a sub graph, click create a subgraph here, give your subgraph a name and then click.

A

Continue this view allows you to see information about your subgraph, including the name, the status, the slug and the deployment key. You can also edit metadata about the sub-graph, including the description, the source code, url, the website url and up to three categories.

A

Now that the subgraph has been initialized in the studio open your terminal, so we can start writing some code. The first thing you'll need to do is install the graph cli globally using npm install g at graph protocol graph cli.

A

If the graph cli is installed successfully, you should now have the graph binary.

A

To create a new subgraph, you can use the graph init command here, we'll pass in additional arguments for the contract name to index the contract. Events to set the product as subgraph studio.

A

And then set the from contract pacing in the contract address you can copy the contract address from the description below or visit slash, docs.zora.com os, slash, dev and copy the media contract address for the subgraph name paste. In the name of the subgraph that you created in subgraph studio. You should now be able to choose the defaults for the rest of the options.

A

Next change into the new directory and you should see all of the files that have been created for the subgraph boilerplate. Next, let's go ahead and open the project in our text. Editor.

A

The first file that we will update is the graphql schema located at schema.graphql.

A

Here we can delete the existing boilerplate code and create a new entity for a token type.

A

The token will have fields for id token id content, uri metadata uri, created at timestamp creator and owner the creator and owner will be of a user type that we'll create next, the user type will have fields for id tokens owned and tokens created.

A

One-To-Many relationships can be created using the derived from directive passing in the field of the parent type from which the relationship was derived.

A

Save this file and open subgraph.yaml subgraph.yaml describes the main configuration for your sub graph.

A

In addition to some of the boilerplate code that we will see in this subgraph.yaml file, the cli was also able to pull down the abis for this smart contract.

A

By passing in the index events, flag, boilerplate event, handlers have also been created for us.

A

The first update that we'll make is setting the start block. The start block is an optional setting that allows you to define from which block in the chain the data source will start indexing.

A

If no start block is defined. The subgraph will index events, starting from the genesis block next update the entities to be token and user to match the entities defined in our graphql schema.

A

Finally, the only two event handlers that we'll be using are token uri, updated and transfer. So we can delete all of the others.

A

In order to make working with smart contracts, events and entities easy and type safe, the graph cli can generate assembly script types from the subgraphs graphql schema and the contract abis included in the data sources.

A

To do so, let's jump back to our terminal and run the codegen command.

A

When the codegen is complete, you should see a file named schema.ts and a folder named token located in the generated folder. The last thing we need to do is write our mappings to do so. Open, src, mapping.ts.

A

Next, we'll import references to the token uri, updated and transfer events, as well as a reference to the token contract from the code that was generated for us by the cli. These imports will give us type safety as well as functions that will allow us to interact directly with the smart contract.

A

Next, we'll import the token in the user from the schema. These imports will allow us to interact with the graph node. The interactions that we'll be using are facilitated by the graph typescript.

A

A

The graph typescript library gives us the following: an api for working with smart contracts, events blocks transactions and smart contract values, a store api to load and save entities from and to the graph node store a log api to log and debug messages to the graph node output in the graph explorer and ipfs api to load files from ipfs, a json api to parse json data, a crypto api to use, cryptographic, functions and low level primitives to translate between different type systems such as ethereum, json, graphql and assembly script.

A

Next, we'll create our handle, transfer function, let's walk through what this function is doing.

A

We first try to load the token from the graph node by calling token.load passing in the token id.

A

If the token does not exist, we create a new token setting the creator token id and created at time stamp from values passed in from the event.

A

Next, we call out to the token contract itself to get and set the content uri in the metadata uri.

A

Here we set the token owner and then save the token to the store.

A

Next, we check to see if the user exists. If they do not, we go ahead and create a new user.

A

The handle token uri, updated function, updates the content uri of the token and then saves it back to the store.

A

Now we're finished writing code and we can deploy and publish the subgraph to publish the subgraph, we're going to need the deploy key to do so. We can go back to our sub graph in the studio and copy the deploy key to our clipboard.

A

To configure the deploy key, we can run graph, auth dash dash studio and then paste in the deploy key when prompted.

A

To deploy, we can run graph, deploy, dash dash studio, passing in the name of our subgraph and a setting of version label.

A

Once your subgraph has been deployed successfully, it should show up in your subgraph studio, dashboard and begin syncing.

A

In this view, you should see the graphql playground, as well as logs and details for the subgraph.

A

To test everything out, we can run the example query given to us in the graphql playground.

A

We can also define our own queries by updating arguments and fields.

A

Our subgraph is now ready to publish to the decentralized network to test how this works. We can publish to the rinkeby network to do so. I'll first update my network to be the rinkeby test network instead of the ethereum mainnet.

A

For rinkeby test tokens visit, fawcett.rinkabee.io.

A

To publish your subgraph to rinkaby click, publish, choose rinkeby as the network and then click publish again.

A

Once the subgraph is successfully deployed, you should see links to view it both in the subgraph explorer, as well as etherscan.

A

Next click view subgraph and explorer.

A

Here we can now test out signaling on our subgraph to test signaling on a subgraph. You will need some test grt. You can request test grt in the graph protocol discord in the testnet faucet channel.

A

Once you've received your testnet grt, click signal here enter the amount of grt that you would like to signal, and then click approve.

A

Once you've confirmed the amount, click on signal to finalize.

A

A

Once signaling is successful, you should see yourself show up as a.

A