@@ -0,0 +1,76 @@
7+This document outlines some advanced techniques for interacting with Azimuth contracts from Urbit itself. It's strongly discouraged to do this unless you're very confident as Azimuth transactions will cost Etherium to complete. However, until you upload a signed transaction to the block chain no transaction will take place so it's safe to explore these tools. It will also be very helpful to have at least a rudimentary understanding of Hoon in order to read and modify parts of the code.
9+First you will want to boot a fakezod. You can do this with your live running ship but at this time this will need you to modify the code so it's best to do this on a ship you can make mistakes on. If you don't know how to boot a fakezod see this guide for instructions.
11+Be sure to have mounted your home desk so you can easily edit files on it.
12+The first edit that will probably need to be made is in [`app/claz.hoon`](https://github.com/urbit/urbit/blob/master/pkg/arvo/app/claz.hoon#L14). The listed url will need to be changed to
14+https://mainnet.infura.io/v3/2599df54929b47099bda360958d75aaf
16+or another valid endpoint.
18+The second change that will potentially be needed is to modify the [gas limit](https://github.com/urbit/urbit/blob/master/pkg/arvo/app/claz.hoon#L179). This number here is the maximum number of gas units that will be used. In future this will be configurable but for now you may need to change this manually. For a guide to what to set it to you can use the [constants in bridge](https://github.com/urbit/bridge/blob/master/src/lib/constants.js#L23) as a guide based on what action you are going to be preforming. You will need at least the maximum gas units multiplied by the gwei you're going to set later in your etherium account as it may cost that much though is likely to be far less.
20+Once you have made these changes be sure to run `|commit %home` to get them into your ship.
22+Next run `|start %claz` after which you'll be able to generate transactions.
25+:claz [%generate %/transaction/eth-txs %mainnet author %single %spawn ~ship to]
28+Here we have an example of generating a transaction to spawn a ship. Something to note is that for this to be successful you'll need to actually have the right to spawn the ship in question. Let's break down the command.
31+`%generate` is how all commands to `claz` are going to start.
33+`%/transaction/eth-txs` is simply the path for the output file
35+`%mainnet` specifies which network this is going to sent out on.
37+`author` here is an etherium address that is issuing the transaction. Remember that it will need to be written all in lower case, dotted notation, e.g. 0x3b17.d097.d9dd.711e.4ef8.517a.bbf1.8b2b.a643.81fe
39+`%single` specifies what kind of batch that will be created. If you are going to do multiple transactions you will need to either set this to `%more` and create a list of batches or upload them before generating the next one. The reason this ship needs to have internet access is because it needs to look up the nonce for the specified address.
41+`%spawn` is the command we want to issue. After this what the arguments are will vary based on the command.
43+`~ship` will be the ship to be spawned.
45+`to` is the etherium address to spawn the ship to.
47+You will want to read `sur/claz.hoon` which you can find [here](https://github.com/urbit/urbit/blob/master/pkg/arvo/sur/claz.hoon).
48+This will contain more details about the various kinds of transactions you can perform particularly `++call`
50+After running this command you should find a csv file at the specified path. You can examine this file to learn how they are constructed but it's not important for this guide.
52+This file can now be signed and uploaded. At this point, you can transfer this file to an airgapped machine which has your keys if you want. If you choose to do that you will need to download the urbit binary as well as the most recent pill file or a copy of the fakezod pier you have already booted.
54+For this guide, we'll continue on the same ship.
56+Run `|start %eth-sender` and then you can use it to sign the transaction file.
59+:eth-sender [%sign %/transaction-signed/txt %/transaction/eth-txs %/mykey/txt ~[80]]
62+Let's again break this down.
64+`%sign` is the action we are going to perform here.
66+`%/transaction-signed/txt` is the path to the output file.
68+`%/transaction/eth-txs` is the path to the transaction file we generated earlier. It will need to be accessible so don't forget to `|comit %home` if you moved it to a different pier.
70+`%/mykey/txt` is the path to your private key file. This file is most likely the reason you will want to use an airgapped machine so that your private key never touches a networked computer. Opsec is left to the reader.
72+`~[80]` is a list of possible gwei costs a signed transaction file will be created for each one. Here we just specify 80 gwei. You may need to adjust this based on current etherium network traffic and average gas costs.
74+Now you should have a directory in your pier that contains one file for each of the specified gwei costs.
76+To actually transmit the transaction, paste the contents of one of these files into https://etherscan.io/pushTx or whatever other transmission system you would like to use. **This is the action that will actually cost you etherium. Only do this step if you want to actually perform the action.**