Skip to content

Commit

Permalink
docs(transfers): Format README and remove redundant instructions (#107)
Browse files Browse the repository at this point in the history 
Signed-off-by: Thane Thomson <[email protected]>
  • Loading branch information
@thanethomson
thanethomson authored Jul 19, 2024
1 parent b1ab0dc commit 1d85bc1
Showing 1 changed file with 99 additions and 78 deletions.
177 changes: 99 additions & 78 deletions apps/transfers/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Transfers

This is a simple Quartz demo app. It allows users to deposit funds to a contract, transfer them around privately within the contract's encrypted state,
This is a simple Quartz demo app. It allows users to deposit funds to a
contract, transfer them around privately within the contract's encrypted state,
and withdraw whatever funds they have.

## Setup

### Install Rust

We only have this working so far with rust v1.76.0 since we're running against wasmd v0.44.
We only have this working so far with Rust v1.76.0 since we're running against
wasmd v0.44.

Install rust by executing a script from the internet (😅):

```
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

You may want to exit and start a new terminal session to get the rust toolchain on your path.
You may want to exit and start a new terminal session to get the rust toolchain
on your path.

Now downgrade rust to v1.76.0:

```
```bash
rustup install 1.76.0
rustup default 1.76.0
```
Expand All @@ -28,7 +31,7 @@ Check the version with `cargo version`.

Finally add the wasm target:

```
```bash
rustup target add wasm32-unknown-unknown
```

Expand All @@ -38,23 +41,24 @@ And you should be good to go!

You need a few other Go based tools. You should already have go.

First add the `~/go/bin` to your path by adding this line to the end of your `~/.bashrc`:
First add the `~/go/bin` to your path by adding this line to the end of your
`~/.bashrc`:

```
```bash
export PATH="${PATH}:${HOME}/go/bin"
```

Then `source ~/.bashrc`. Now we can install some stuff.

You need grpcurl:

```
```bash
go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
```

You need wasmd v0.44.0:

```
```bash
git clone https://github.com/cosmwasm/wasmd/
cd wasmd
git checkout v0.44.0
Expand All @@ -63,21 +67,25 @@ go install ./cmd/wasmd

Check that both work by running `grpcurl` and `wasmd`.

Finally, you neeed `websocat`:
Finally, you need `websocat`:

```
```bash
cargo install websocat
```

### Fetch the Repo

While the repos are private you will need an ssh key registered on github in order to fetch them. Run `ssh-keygen` and just follow the defaults. On Github, go to Settings -> SSH and GPG Keys -> New SSH Key. Run `cat ~/.ssh/id_rsa.pub` on the machine and copy and paste the result into Github.
While the repos are private you will need an ssh key registered on github in
order to fetch them. Run `ssh-keygen` and just follow the defaults. On Github,
go to Settings -> SSH and GPG Keys -> New SSH Key. Run `cat ~/.ssh/id_rsa.pub`
on the machine and copy and paste the result into Github.

This key will now have full access to your github account so its a good idea to remove it when you're done and re-add everytime you need to push/pull the repo.
This key will now have full access to your github account so its a good idea to
remove it when you're done and re-add everytime you need to push/pull the repo.

Now clone the repo:

```
```bash
git clone ssh://[email protected]/informalsystems/cycles-quartz
cd cycles-quartz
```
Expand All @@ -86,31 +94,37 @@ Tada!

### Setup Wasmd Accounts

Run `wasmd init <your name> --chain-id testing` to initialize the local wasmd folder.
Run `wasmd init <your name> --chain-id testing` to initialize the local wasmd
folder.

Now open the file `~/.wasmd/config/client.toml` and change the field `keyring-backend` from `os` to `test`:
Now open the file `~/.wasmd/config/client.toml` and change the field
`keyring-backend` from `os` to `test`:

```
```toml
keyring-backend = "test"
```

Now, finally, we can create a local admin key for your wasmd. You'll use this to deploy contracts:
Now, finally, we can create a local admin key for your wasmd. You'll use this to
deploy contracts:

```
```bash
wasmd keys add admin
```

This should output a wasm address.
This should output a wasm address.

Now either you will setup a local testnet or use an existing testnet. If its an existing testnet, you need to fund this account. Send this address to someone who has access to the admin account for your testnet. If you have access yourself you can send funds yourself:
Now either you will setup a local testnet or use an existing testnet. If its an
existing testnet, you need to fund this account. Send this address to someone
who has access to the admin account for your testnet. If you have access
yourself you can send funds yourself:

```
wasmd tx bank send <sender key name> <recipient address> <amount ucosm> --chain-id testing -y
```bash
wasmd tx bank send <sender key name> <recipient address> <amount ucosm> --chain-id testing -y
```

If you're setting up your own local testnet, continue with the following:

```
```bash
# generate a second key for the validator
wasmd keys add validator

Expand All @@ -123,19 +137,21 @@ wasmd genesis gentx validator 100000000stake --chain-id testing
wasmd genesis collect-gentxs
```

Before finally starting the node, for it to work with the front end, you need to configure CORS.
Before finally starting the node, for it to work with the front end, you need to
configure CORS.

In `~/.wasmd/config/config.toml`, you'll need to make sure the listen address binds to the public IP (0.0.0.0) and the CORS allows all origins:
In `~/.wasmd/config/config.toml`, you'll need to make sure the listen address
binds to the public IP (0.0.0.0) and the CORS allows all origins:

```
```toml
[rpc]
laddr = "tcp://0.0.0.0:26657"
laddr = "tcp://0.0.0.0:26657"
cors_allowed_origins = ["*"]
```

And in `~/.wasmd/config/app.toml`:

```
```toml
[api]
enable = true
address = "tcp://0.0.0.0:1317"
Expand All @@ -144,75 +160,78 @@ enabled-unsafe-cors = true

Now, finally:

```
```bash
wasmd start
```

And you should have a chain making blocks!

You can also reduce the block time by lowering `timeout_commit` in `~/.wasmd/config/config.toml`.
You can also reduce the block time by lowering `timeout_commit` in
`~/.wasmd/config/config.toml`.

Now that you have the chain running, you can start running the enclave and proxy in other windows.
Now that you have the chain running, you can start running the enclave and proxy
in other windows.

## Run

First set the `NODE_URL` variable to the address of the blockchain node. If it's a local node, set it to `localhost:26657`. If it's a remote node, set it to that node's address (eg. `export NODE_URL=143.244.186.205:26657`).
First set the `NODE_URL` variable to the address of the blockchain node. If it's
a local node, set it to `localhost:26657`. If it's a remote node, set it to that
node's address (eg. `export NODE_URL=143.244.186.205:26657`).

The `scripts` dir contains some bash scripts to help run the app.
These scripts should be replaced by a new `quartz` tool. See [issue](https://github.com/informalsystems/cycles-quartz/issues/61).
The `scripts` dir contains some bash scripts to help run the app. These scripts
should be replaced by a new `quartz` tool. See
[issue](https://github.com/informalsystems/cycles-quartz/issues/61).

Note: to build/run on a non-SGX machine you must set the `MOCK_SGX` env var for all bash scripts below
```
# 1st Terminal
$ export MOCK_SGX=1
$ bash scripts/build.sh
$ bash scripts/start.sh
# 2nd Terminal
$ export MOCK_SGX=1
$ bash scripts/deploy.sh
$ ...
**NOTE: If you want to run on a non-SGX machine, you must set the following
*environment variable prior to running any further commands in *all* terminals
*in which you run them:**

```bash
export MOCK_SGX=1
```

### Build the Binaries

Build the enclave binary and the smart contract binary:

```
```bash
bash scripts/build.sh
```

### Configure and Run Gramine

Setup and sign the Gramine config, and then start the gramine process, which will run the
grpc server that hosts the transfer application. The quartz port defaults to `11090`, but you can set it deliberately with
`export QUARTZ_PORT=XXXXX`. It is best to set it everytime, since if 2 people are sshing into the same machine to use
the secure enclave, this could create undesired env conditions where your app is talking to the wrong enclave.
Setup and sign the Gramine config, and then start the gramine process, which
will run the gRPC server that hosts the transfer application. The quartz port
defaults to `11090`, but you can set it deliberately with `export
QUARTZ_PORT=XXXXX`. It is best to set it everytime, since if 2 people are sshing
into the same machine to use the secure enclave, this could create undesired env
conditions where your app is talking to the wrong enclave.

```
```bash
bash scripts/start.sh
```

The enclave binary is now running, waiting for commands.


### Contract Setup

With the enclave running in one window, open another window to deploy the contract and start the listener.
With the enclave running in one window, open another window to deploy the
contract and start the listener.

In the new window, set the NODE_URL env variable again (eg. `export NODE_URL=143.244.186.205:26657`)
In the new window, set the `NODE_URL` env variable again (e.g.
`export NODE_URL=143.244.186.205:26657`)

Now we can deploy the contract:

```
```bash
bash scripts/deploy.sh
```

Note the deployed contract address and save it into the `CONTRACT` env variable.

Now run the quartz handshake between contract and enclave:

```
```bash
bash scripts/handshake.sh $CONTRACT
```

Expand All @@ -222,28 +241,30 @@ This should output the pubkey and nonce.

Finally, we're ready to listen to events from the contract and trigger execution on the enclave:

```
```bash
bash scripts/listen.sh $CONTRACT
```

Now we can interact with the contract, and we'll see the events and contract data come through.

Now we can interact with the contract, and we'll see the events and contract
data come through.

### Run the Frontend

Now on your own machine, checkout the https://github.com/informalsystems/cycles-hackathon-app.
Now on your own machine, checkout the
https://github.com/informalsystems/cycles-hackathon-app.

Copy the `.env.example` file to `.env.local`:

```
```bash
cp .env.example .env.local
```

and set the relevant fields. You should have the contract address and TEE pubkey
from the output of the `deploy.sh` and `handshake.sh` scripts, respectfully. The
chain id is probably `testing` and the IP address for the URLs is probably
`143.244.186.205`. Modify accordingly. For example:

and set the relevant fields. You should have the contract address and TEE pubkey from the output of the `deploy.sh` and `handshake.sh` scripts, respectfully. The chain id is probably `testing` and the IP address for the URLs is probably `143.244.186.205`.
Modify accordingly. For example:

```
```bash
#.env.local
NEXT_PUBLIC_TRANSFERS_CONTRACT_ADDRESS=wasm1ch9ed27cdu3a4fkx37gnagm7jcthj0rggnmmjwwwe4xhwmk0d65q8fn9pz
NEXT_PUBLIC_ENCLAVE_PUBLIC_KEY=030c25e39743fd4c7553d87873919281d567b5c328fb903cbfbe9541518736a2d2
Expand All @@ -254,22 +275,22 @@ NEXT_PUBLIC_CHAIN_REST_URL=http://143.244.186.205:1317

Install and run the app:

```
```bash
npm install -f
npm run dev
```

You can now open the app in http://localhost:3000/.

Make sure you have Keplr installed in your browser and you should now be able to use the app!

You may have to go to "Manage Chain Visibility" in Keplr settings to add the `My Testing Chain` so you can see your balance.

You will also need to fund any keplr account by sending funds from the CLI using your `admin` account.

Then you should be able to deposit, transfer, and withdraw using different Keplr accounts. And everything will get processed automatically by the transfer.sh script we have running on the enclave host!

You can now open the app in http://localhost:3000/.

Make sure you have Keplr installed in your browser and you should now be able to
use the app!

You may have to go to "Manage Chain Visibility" in Keplr settings to add the `My
Testing Chain` so you can see your balance.

You will also need to fund any keplr account by sending funds from the CLI using
your `admin` account.

Then you should be able to deposit, transfer, and withdraw using different Keplr
accounts. And everything will get processed automatically by the transfer.sh
script we have running on the enclave host!

0 comments on commit 1d85bc1

Please sign in to comment.