loading...
Cover image for Build your first Harberger Tax App - Part 1
Wildcards

Build your first Harberger Tax App - Part 1

jasoons profile image Jason Smythe Originally published at blog.wildcards.world ・6 min read

Build your first Harberger Tax App - Part 1

If you get through this tutorial and are inspired to build something new you might consider participating in this hackathon challenge, you can win 200USD :)

Wildcards has been running in production for many months, and all the code is opensource. However, we are yet to see a flourishing of applications built with harberger tax. This article aims to make the code that is used to build wildcards easily accessible to the public. There are quite a few manual steps in this tutorial, but if you follow everything step by step you will be able to have a default working harberger tax application on Ethereum with a UI in under 15 minutes.

There are more links and explanations marked with the heading Extra. We highly encourage you to go through these, but if you just want to get started they are not necessary (and they will cause you to take longer than 15 minutes). If something goes wrong check if there are any NOTE sections. Otherwise please create an issue on github

Once you have completed the basic tutorial we will explore how to customize your application by modifying the contracts and extending the UI. This toolkit is designed to be easy to get started with, yet, (or so we hope) infinitely customizable.

Contents:

This tutorial has 3 parts:

  • First part is to deploy the smart contracts.
  • Second part is to create a subgraph that allows you to easily query data from the blockchain.
  • The final step is to run a sample UI

Aside: While we truly love thegraph and the power it gives, it also adds quite a lot of config and complexity to an application. I wouldn't recommend using the graph for very small and quick projects, for that it is simpler to just query blockchain data directly from the blockchain via a provider such as infura.io.

Get the contracts and deploy them.

Extra: These contracts use Zeppelin-SDK to allow them to be up-gradable. Please go through their docs carefully to understand what this means and the requirements if you wish to upgrade.

Clone the repository and install the dependencies:

git clone https://github.com/wildcards-world/harberger-base-contracts.git
cd harberger-base-contracts
yarn # You can also use `npm install` but yarn is recommended.

Then deploy the contracts to the goerli test network:

yarn migrate --network goerli

NOTE: This command will take a few minutes

NOTE: If there is an issue with this command it is likely that someone has used/stolen all the goerli testnet eth that is stored by the private key hardcoded in this repo. Another possibility is that the infura keys are exhausted (since they are on free tier). Generate new keys here and paste them into ./secrectsManager.example.js to replace the old private key. If you want to use your own infura keys, generate them here and paste your keys into ./secrectsManager.example.js.

It should output something similar to this on completion.
Expected Output

Extra: these contracts currently use truffle + ganache, but over time the goal is to move it completely to buidler. At the moment you will find traces of configuration for both in the repo.

Now that the contract is deployed to the goerli testnet we need to get the contract addresses. It is found in the ./openzeppelin/goerli.json file near the bottom under proxies > "the contract name" > address as shown below:

where-to-find-contract-addresses
In our case the address for the HarbergerSteward is 0x4bE0Eab8f41c8109AA134509086Cbcb18b10C0fB and for the ERC721Patronage it is 0x48C12e1c5aBC5239FD6e2642C929E8FA8bE29999 - we will use these in the next steps, so keep them somewhere for reference.

Create a subgraph

This repo allows us to read data from the ethereum blockchain.

Extra: the subgraph is provided by thegraph.com . It uses graphQL which is a specification for how to structure data requests and it is a powerful tool because it allows you to fetch exactly the data you want from the graph. The UI library uses a library called apollo to fetch the data from the subgraph.

Get the code and install the dependencies by running the following in a new terminal and folder:

git clone https://github.com/wildcards-world/harberger-base-subgraph.git
cd harberger-base-subgraph
yarn # Once again, you can use `npm install` if you prefer.

Next you will need to create an account with the Graph. Once you have an account go to your dashboard and click the button that says "Add Subgraph" in the top right corner:

create-graph-button

Fill in your preferred details for your new subgraph:
create-graph
Once created it will present you with some default instructions. I have summarised them below.

Install thegraph cli tool:

npm install --global @graphprotocol/graph-cli

NOTE: this command will take some time, so feel free to continue in the meantime. You do need this command to run the graph auth command below.

Authenticate with thegraph. Copy the code in the top bar and run it in the following command:
secret-graph-code

graph auth https://api.thegraph.com/deploy/ <ACCESS_TOKEN> # find this access token as circled in the image above.

success example

You are ready to test deploying this graph. First change the package.json to point to the correct subgraph:
set-upstream-graph-endpoint

For example if you github name is "jasoons" and your new subgraph is called "harberger-app" you should set this line to say "deploy": "graph deploy --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ jasoons/harberger-app",

Next you need to auto-generate some setup code:

yarn codegen

Extra: you will need to run this anytime you change the abi (which you will need to change anytime you change the interface of your contract) or your subgraph.yaml file. It generates helper code based on the interface (abi) of your contracts.

You are now ready to deploy this version of the subgraph, but will it deploy the correct subgraph for your contracts? The answer is no, you need to tell the graph to watch the contracts you deployed in the previous step. To do that edit the subgraph.yaml file with the addresses that you deployed earlier:
set-contracts-in-graph

Now run the deploy script with the correct contract addresses

yarn deploy

Go to back your graph, reload the page and check that everything is working. It should look something like this:

thegraph-playground

Extra: The docs for thegraph.com are excelent. Do yourself a favour and read through them thoroughly, thegraph will likely help you build on Ethereum for many future projects.

Setup the basic UI

git clone https://github.com/wildcards-world/harberger-ui.git
cd harberger-ui
yarn
yarn re:build

The UI is configured to run with a single simple command:

yarn start

EXTRA: You can do all your coding in Javascript or Typescript, however you can also use ReasonMl which is a new typesafe language which is being pioneered by facebook.

Now you will need to set the contract address of the steward and the graph endpoint of your subgraph.

You should be able to now buy token #0 (the starter code has this value hardcoded) via the UI and set its price. To use the UI you will need to have the metamask.

To hit the ground running with your own custom UI code you will need to start with the app.js file. The code should be easy to follow.

For doing more advanced enhancements to this code, check out tutorial #2 of this series!


Visit our website Wildcards where you can buy some wildcards and start contributing toward endangered animal conservation today! Follow our socials to learn more about our project and the conservation causes we are working towards.

Follow us on twitter: @wildcards_world

Follow us on Facebook: @wildcardscrypto

Follow us on Telegram: Telegram

As always, stay cool, stay safe and stay tuned

Team Wildcards

Posted on May 27 by:

jasoons profile

Jason Smythe

@jasoons

Buidler using Ethereum + ReasonML. Working on https://wildcards.world and other cool projects with http://avolabs.io Making a more just society with code. :)

Wildcards

Wildcards connects global conservation organisations to users. Social, gamified and transparent giving makes wildcards the perfect platform to start making your difference.

Discussion

markdown guide
 

You can do all your coding in Javascript or Typescript, however you can also use ReasonMl which is a new typesafe language which is being pioneered by facebook.

What do you think of ReasonML? I've been interested in trying it out as an alternative to Typescript.

 

It is my favourite language at the moment.

The guarantees it gives you about the safety of your code are simply superior to typescript. The whole of the wildcards ui and quite a few backend services are written in Reason. It is has made the code easy to refactor while we working with the new technology.

The compiler(transpiler) is extremely fast, the type system is sound (see #3 in 'non-goals' of typescript), the interop via bucklescript with javascript is very expressive (although does have a learning curve), you can also progressively integrate (or convert) an existing javascript/typescript codebase into reason (although typescript is better as this) - gentype for example helps a lot.

There is also very exciting new work (very early) on cross compiling reason to native (mac,linux,windows,android, etc) and javascript/web. You can see the revery framework and an example application using it onivim2.

Another example I'll highlight is the tooling for graphql in reason being absolutely first class. eg: github.com/reasonml-community/grap...

The main thing, for me is that my code never feels like it is 'legacy' even if I haven't looked at or touched it for half a year or more. I don't get that feeling with any other language (well elm was good too - its inferior interop with javascript was my issue).

That said, you definitely need to have a very good understanding of javascript before trying to write javacript applications using reason. Also learning Reason like learning any new language, there is a learning curve!

 

tldr, I recommend giving it a try. You'll learn a lot even if you don't find it suitable for you project

Thanks for the great writeup! I'll definitely give it a shot.