Refactor for shiv package

2023-01-07 21:02:14 -07:00
parent c99687cc80
commit 0435a71b5e
124 changed files with 9 additions and 7 deletions
@@ -0,0 +1,157 @@
+# ERC20 Watcher
+
+Instructions to deploy a local ERC20 watcher stack (core + watcher) for demonstration and testing purposes using [laconic-stack-orchestrator](../../README.md#setup)
+
+## Setup
+
+* Clone / pull required repositories:
+
+  ```bash
+  $ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts --pull
+  ```
+
+* Build the core and watcher container images:
+
+  ```bash
+  $ laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc20
+  ```
+
+  This should create the required docker images in the local image registry.
+
+* Deploy the stack:
+
+  ```bash
+  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 up
+  ```
+
+## Demo
+
+* Find the watcher container's id using `docker ps` and export it for later use:
+
+  ```bash
+  $ export CONTAINER_ID=<CONTAINER_ID>
+  ```
+
+* Deploy an ERC20 token:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn token:deploy:docker
+  ```
+
+  Export the address of the deployed token to a shell variable for later use:
+
+  ```bash
+  $ export TOKEN_ADDRESS=<TOKEN_ADDRESS>
+  ```
+
+* Open `http://localhost:3002/graphql` (GraphQL Playground) in a browser window
+
+* Connect MetaMask to `http://localhost:8545` (with chain ID `99`)
+
+* Add the deployed token as an asset in MetaMask and check that the initial balance is zero
+
+* Export your MetaMask account (second account) address to a shell variable for later use:
+
+  ```bash
+  $ export RECIPIENT_ADDRESS=<RECIPIENT_ADDRESS>
+  ```
+
+* To get the primary account's address, run:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn account:docker
+  ```
+
+* To get the current block hash at any time, run:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn block:latest:docker
+  ```
+
+* Fire a GQL query in the playground to get the name, symbol and total supply of the deployed token:
+
+  ```graphql
+  query {
+    name(
+      blockHash: "LATEST_BLOCK_HASH"
+      token: "TOKEN_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    symbol(
+      blockHash: "LATEST_BLOCK_HASH"
+      token: "TOKEN_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    totalSupply(
+      blockHash: "LATEST_BLOCK_HASH"
+      token: "TOKEN_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+  }
+  ```
+
+* Fire the following query to get balances for the primary and the recipient account at the latest block hash:
+
+  ```graphql
+  query {
+    fromBalanceOf: balanceOf(
+        blockHash: "LATEST_BLOCK_HASH"
+        token: "TOKEN_ADDRESS",
+        # primary account having all the balance initially
+        owner: "PRIMARY_ADDRESS"
+      ) {
+      value
+      proof {
+        data
+      }
+    }
+    toBalanceOf: balanceOf(
+        blockHash: "LATEST_BLOCK_HASH"
+        token: "TOKEN_ADDRESS",
+        owner: "RECIPIENT_ADDRESS"
+      ) {
+      value
+      proof {
+        data
+      }
+    }
+  }
+  ```
+
+  * The initial balance for the primary account should be `1000000000000000000000`
+  * The initial balance for the recipient should be `0`
+
+* Transfer tokens to the recipient account:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn token:transfer:docker --token $TOKEN_ADDRESS --to $RECIPIENT_ADDRESS --amount 100
+  ```
+
+* Fire the above GQL query again with the latest block hash to get updated balances for the primary (`from`) and the recipient (`to`) account:
+
+  * The balance for the primary account should be reduced by the transfer amount (`100`)
+  * The balance for the recipient account should be equal to the transfer amount (`100`)
+
+* Transfer funds between different accounts using MetaMask and use the playground to query the balance before and after the transfer.
+
+## Clean up
+
+* To stop all the services running in background run:
+
+  ```bash
+  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 down
+  ```
@@ -0,0 +1,18 @@
+version: "1.0"
+name: erc20-watcher
+repos:
+  - cerc-io/go-ethereum
+  - cerc-io/ipld-eth-db
+  - cerc-io/ipld-eth-server
+  - cerc-io/watcher-ts
+containers:
+  - cerc/go-ethereum
+  - cerc/go-ethereum-foundry
+  - cerc/ipld-eth-db
+  - cerc/ipld-eth-server
+  - cerc/watcher-erc20
+pods:
+  - go-ethereum-foundry
+  - db
+  - ipld-eth-server
+  - watcher-erc20
@@ -0,0 +1,214 @@
+# ERC721 Watcher
+
+Instructions to deploy a local ERC721 watcher stack (core + watcher) for demonstration and testing purposes using [laconic-stack-orchestrator](../../README.md#setup)
+
+## Setup
+
+* Clone / pull required repositories:
+
+  ```bash
+  $ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts --pull
+  ```
+
+* Build the core and watcher container images:
+
+  ```bash
+  $ laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc721
+  ```
+
+  This should create the required docker images in the local image registry.
+
+* Deploy the stack:
+
+  ```bash
+  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 up
+  ```
+
+## Demo
+
+* Find the watcher container's id using `docker ps` and export it for later use:
+
+  ```bash
+  $ export CONTAINER_ID=<CONTAINER_ID>
+  ```
+
+* Deploy an ERC721 token:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn nft:deploy:docker
+  ```
+
+  Export the address of the deployed token to a shell variable for later use:
+
+  ```bash
+  $ export NFT_ADDRESS=<NFT_ADDRESS>
+  ```
+
+* Open `http://localhost:3009/graphql` (GraphQL Playground) in a browser window
+
+* Connect MetaMask to `http://localhost:8545` (with chain ID `99`)
+
+* Export your MetaMask account (second account) address to a shell variable for later use:
+
+  ```bash
+  $ export RECIPIENT_ADDRESS=<RECIPIENT_ADDRESS>
+  ```
+
+* To get the primary account's address, run:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn account:docker
+  ```
+
+  Export it to shell variable for later use:
+
+  ```bash
+  $ export PRIMARY_ADDRESS=<PRIMARY_ADDRESS>
+  ```
+
+* To get the current block hash at any time, run:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn block:latest:docker
+  ```
+
+* Fire the following GQL query (uses `eth_call`) in the playground:
+
+  ```graphql
+  query {
+    name(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    symbol(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    balanceOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+      owner: "PRIMARY_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+  }
+  ```
+
+  Balance for the `PRIMARY_ADDRESS` should be `0` as the token is yet to be minted.
+
+* Fire the following GQL query (uses `storage` calls) in the playground:
+
+  ```graphql
+  query {
+    _name(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    _symbol(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    _balances(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+      key0: "PRIMARY_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+  }
+  ```
+
+* Mint the token:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn nft:mint:docker --nft $NFT_ADDRESS --to $PRIMARY_ADDRESS --token-id 1
+  ```
+
+  Fire the GQL query above again with latest block hash. The balance should increase to `1`.
+
+* Get the latest block hash and run the following GQL query in the playground for `balanceOf` and `ownerOf` (`eth_call`):
+
+  ```graphql
+  query {
+    fromBalanceOf: balanceOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+      owner: "PRIMARY_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    toBalanceOf: balanceOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+      owner: "RECIPIENT_ADDRESS"
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+
+    ownerOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      contractAddress: "NFT_ADDRESS"
+      tokenId: 1
+    ) {
+      value
+      proof {
+        data
+      }
+    }
+  }
+  ```
+
+  Balance should be `1` for the `PRIMARY_ADDRESS`, `0` for the `RECIPIENT_ADDRESS` and owner value of the token should be equal to the `PRIMARY_ADDRESS`.
+
+* Transfer the token:
+
+  ```bash
+  $ docker exec $CONTAINER_ID yarn nft:transfer:docker --nft $NFT_ADDRESS --from $PRIMARY_ADDRESS --to $RECIPIENT_ADDRESS --token-id 1
+  ```
+
+  Fire the GQL query above again with the latest block hash. The token should be transferred to the recipient.
+
+## Clean up
+
+* To stop all the services running in background:
+
+  ```bash
+  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 down
+  ```
@@ -0,0 +1,18 @@
+version: "1.0"
+name: erc721-watcher
+repos:
+  - cerc-io/go-ethereum
+  - cerc-io/ipld-eth-db
+  - cerc-io/ipld-eth-server
+  - cerc-io/watcher-ts
+containers:
+  - cerc/go-ethereum
+  - cerc/go-ethereum-foundry
+  - cerc/ipld-eth-db
+  - cerc/ipld-eth-server
+  - cerc/watcher-erc721
+pods:
+  - go-ethereum-foundry
+  - db
+  - ipld-eth-server
+  - watcher-erc721
@@ -0,0 +1,98 @@
+# fixturenet-eth
+
+Instructions for deploying a local a geth + lighthouse blockchain "fixturenet" for development and testing purposes using laconic-stack-orchestrator (the installation of which is covered [here](https://github.com/cerc-io/stack-orchestrator#user-mode)):
+
+## Clone required repositories
+```
+$ laconic-so setup-repositories --include cerc-io/go-ethereum
+```
+
+## Build the fixturenet-eth containers
+```
+$ laconic-so build-containers --include cerc/go-ethereum,cerc/lighthouse,cerc/fixturenet-eth-geth,cerc/fixturenet-eth-lighthouse
+```
+This should create several container images in the local image registry: 
+
+* cerc/go-ethereum
+* cerc/lighthouse
+* cerc/fixturenet-eth-geth
+* cerc/fixturenet-eth-lighthouse
+
+## Deploy the stack
+```
+$ laconic-so deploy-system --include fixturenet-eth up
+```
+
+## Check status
+
+```
+$ container-build/cerc-fixturenet-eth-lighthouse/scripts/status.sh
+Waiting for geth to generate DAG ..................................................... DONE!
+Waiting for beacon phase0 .... DONE!
+Waiting for beacon altair .... DONE!
+Waiting for beacon bellatrix pre-merge .... DONE!
+Waiting for beacon bellatrix merge .... DONE!
+
+$ docker ps -f 'name=laconic' --format 'table {{.Names}}\t{{.Ports}}'  | cut -d'-' -f3- | sort
+NAMES                                                                           PORTS
+fixturenet-eth-bootnode-geth-1         8545-8546/tcp, 30303/udp, 0.0.0.0:55847->9898/tcp, 0.0.0.0:55848->30303/tcp
+fixturenet-eth-bootnode-lighthouse-1
+fixturenet-eth-geth-1-1                8546/tcp, 30303/tcp, 30303/udp, 0.0.0.0:55851->8545/tcp
+fixturenet-eth-geth-2-1                8545-8546/tcp, 30303/tcp, 30303/udp
+fixturenet-eth-lighthouse-1-1          0.0.0.0:55858->8001/tcp
+fixturenet-eth-lighthouse-2-1
+```
+
+## Additional pieces
+
+Several other containers can used with the basic `fixturenet-eth`:
+
+* `ipld-eth-db` (enables statediffing)
+* `ipld-eth-server` (GQL and Ethereum API server, requires `ipld-eth-db`)
+* `ipld-eth-beacon-db` and `ipld-eth-beacon-indexer` (for indexing Beacon chain blocks)
+* `eth-probe` (captures eth1 tx gossip)
+* `keycloak` (nginx proxy with keycloak auth for API authentication)
+* `tx-spammer` (generates and sends automated transactions to the fixturenet)
+	
+It is not necessary to use them all at once, but a complete example follows:
+
+```
+# Setup
+$ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/ipld-eth-beacon-db,cerc-io/ipld-eth-beacon-indexer,cerc-io/eth-probe,cerc-io/tx-spammer
+
+# Build
+$ laconic-so build-containers --include cerc/go-ethereum,cerc/lighthouse,cerc/fixturenet-eth-geth,cerc/fixturenet-eth-lighthouse,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/ipld-eth-beacon-db,cerc/ipld-eth-beacon-indexer,cerc/eth-probe,cerc/keycloak,cerc/tx-spammer
+
+# Deploy
+$ laconic-so deploy-system --include db,fixturenet-eth,ipld-eth-server,ipld-eth-beacon-db,ipld-eth-beacon-indexer,eth-probe,keycloak,tx-spammer up
+
+# Status
+
+$ container-build/cerc-fixturenet-eth-lighthouse/scripts/status.sh
+Waiting for geth to generate DAG.... DONE!
+Waiting for beacon phase0.... DONE!
+Waiting for beacon altair.... DONE!
+Waiting for beacon bellatrix pre-merge.... DONE!
+Waiting for beacon bellatrix merge.... DONE!
+
+$ docker ps -f 'name=laconic' --format 'table {{.Names}}\t{{.Ports}}'  | cut -d'-' -f3- | sort
+NAMES                                                                           PORTS
+eth-probe-db-1                         0.0.0.0:55849->5432/tcp
+eth-probe-mq-1
+eth-probe-probe-1
+fixturenet-eth-bootnode-geth-1         8545-8546/tcp, 30303/udp, 0.0.0.0:55847->9898/tcp, 0.0.0.0:55848->30303/tcp
+fixturenet-eth-bootnode-lighthouse-1
+fixturenet-eth-geth-1-1                8546/tcp, 30303/tcp, 30303/udp, 0.0.0.0:55851->8545/tcp
+fixturenet-eth-geth-2-1                8545-8546/tcp, 30303/tcp, 30303/udp
+fixturenet-eth-lighthouse-1-1          0.0.0.0:55858->8001/tcp
+fixturenet-eth-lighthouse-2-1
+ipld-eth-beacon-db-1                   127.0.0.1:8076->5432/tcp
+ipld-eth-beacon-indexer-1
+ipld-eth-db-1                          127.0.0.1:8077->5432/tcp
+ipld-eth-server-1                      127.0.0.1:8081-8082->8081-8082/tcp
+keycloak-1                             8443/tcp, 0.0.0.0:55857->8080/tcp
+keycloak-db-1                          0.0.0.0:55850->5432/tcp
+keycloak-nginx-1                       0.0.0.0:55859->80/tcp
+migrations-1
+tx-spammer-1
+```
@@ -0,0 +1,12 @@
+version: "1.0"
+name: fixturenet-eth
+repos:
+  - cerc-io/go-ethereum
+  - cerc-io/lighthouse
+containers:
+  - cerc/go-ethereum
+  - cerc/lighthouse
+  - cerc/fixturenet-eth-geth
+  - cerc/fixturenet-eth-lighthouse
+pods:
+  - fixturenet-eth
@@ -0,0 +1,18 @@
+# Laconicd Fixturenet
+
+Instructions for deploying a local Laconic blockchain "fixturenet" for development and testing purposes using laconic-stack-orchestrator (the installation of which is covered [here](https://github.com/cerc-io/stack-orchestrator#user-mode)):
+
+## Clone required repositories
+```
+$ laconic-so setup-repositories --include cerc-io/laconicd,cerc-io/laconic-sdk,cerc-io/laconic-cns-cli
+```
+## Build the laconicd container
+```
+$ laconic-so build-containers --include cerc/laconicd
+```
+This should create a container with tag `cerc/laconicd` in the local image registry.
+## Deploy the stack
+```
+$ laconic-so deploy-system --include fixturenet-laconicd up
+```
+Correct operation should be verified by checking the laconicd container's log.
@@ -0,0 +1,11 @@
+version: "1.0"
+name: laconicd-fixturenet
+repos:
+  - cerc-io/laconicd
+  - cerc-io/laconic-sdk
+  - cerc-io/laconic-cns-cli
+containers:
+  - cerc/laconicd
+  - cerc/laconic-cns-cli
+pods:
+  - fixturenet-laconicd
@@ -0,0 +1,53 @@
+# MobyMask
+
+The MobyMask watcher is a Laconic Network component that provides efficient access to MobyMask contract data from Ethereum, along with evidence allowing users to verify the correctness of that data. The watcher source code is available in [this repository](https://github.com/cerc-io/watcher-ts/tree/main/packages/mobymask-watcher) and a developer-oriented Docker Compose setup for the watcher can be found [here](https://github.com/cerc-io/mobymask-watcher). The watcher can be deployed automatically using the Laconic Stack Orchestrator tool as detailed below:
+
+## Deploy the MobyMask Watcher
+
+The instructions below show how to deploy a MobyMask watcher using laconic-stack-orchestrator (the installation of which is covered [here](https://github.com/cerc-io/stack-orchestrator#user-mode)).
+
+This deployment expects that ipld-eth-server's endpoints are available on the local machine at http://ipld-eth-server.example.com:8083/graphql and http://ipld-eth-server.example.com:8082. More advanced configurations are supported by modifying the watcher's [config file](../../config/watcher-mobymask/mobymask-watcher.toml).
+
+## Clone required repositories
+
+```
+$ laconic-so setup-repositories --include cerc-io/watcher-ts
+```
+
+## Build the watcher container
+
+```
+$ laconic-so build-containers --include cerc/watcher-mobymask
+```
+
+This should create a container with tag `cerc/watcher-mobymask` in the local image registry.
+
+## Deploy the stack
+
+First the watcher database has to be initialized. Start only the mobymask-watcher-db service:
+
+```
+$ laconic-so deploy-system --include watcher-mobymask up mobymask-watcher-db
+```
+
+Next find the container's id using `docker ps` then run the following command to initialize the database:
+
+```
+$ docker exec -i <mobymask-watcher-db-container> psql -U vdbm mobymask-watcher < config/watcher-mobymask/mobymask-watcher-db.sql
+```
+
+Finally start the remaining containers:
+
+```
+$ laconic-so deploy-system --include watcher-mobymask up
+```
+
+Correct operation should be verified by following the instructions [here](https://github.com/cerc-io/mobymask-watcher/tree/main/mainnet-watcher-only#run), checking GraphQL queries return valid results in the watcher's [playground](http://127.0.0.1:3001/graphql).
+
+## Clean up
+
+Stop all the services running in background:
+
+```bash
+$ laconic-so deploy-system --include watcher-mobymask down
+```
@@ -0,0 +1,8 @@
+version: "1.0"
+name: mobymask-watcher
+repos:
+  - cerc-io/watcher-ts/v0.2.19
+containers:
+  - cerc/watcher-mobymask
+pods:
+  - watcher-mobymask
@@ -0,0 +1,83 @@
+# Uniswap v3
+
+Instructions to deploy Uniswap v3 watcher stack (watcher + uniswap-v3-info frontend app) using [laconic-stack-orchestrator](../../README.md#setup)
+
+## Prerequisites
+
+* Access to [uniswap-watcher-ts](https://github.com/vulcanize/uniswap-watcher-ts).
+
+* This deployment expects core services to be running; specifically, it requires `ipld-eth-server` RPC and GQL endpoints. Update the `upstream.ethServer` endpoints in the [watcher config files](../../config/watcher-uniswap-v3) accordingly:
+
+  ```toml
+  [upstream]
+    [upstream.ethServer]
+      gqlApiEndpoint = "http://ipld-eth-server.example.com:8083/graphql"
+      rpcProviderEndpoint = "http://ipld-eth-server.example.com:8082"
+  ```
+
+* `uni-watcher` and `uni-info-watcher` database dumps (optional).
+
+## Setup
+
+* Clone / pull required repositories:
+
+  ```bash
+  $ laconic-so setup-repositories --include vulcanize/uniswap-watcher-ts,vulcanize/uniswap-v3-info --git-ssh --pull
+  ```
+
+* Build watcher and info app container images:
+
+  ```bash
+  $ laconic-so build-containers --include cerc/watcher-uniswap-v3,cerc/uniswap-v3-info
+  ```
+
+  This should create the required docker images in the local image registry.
+
+## Deploy
+
+* (Optional) Initialize the watcher database with existing database dumps if available:
+
+  * Start the watcher database to be initialized:
+
+    ```bash
+    $ laconic-so deploy-system --include watcher-uniswap-v3 up uniswap-watcher-db
+    ```
+
+  * Find the watcher database container's id using `docker ps` and export it for further usage:
+
+    ```bash
+    $ export CONTAINER_ID=<CONTAINER_ID>
+    ```
+
+  * Load watcher database dumps:
+
+    ```bash
+    # uni-watcher database
+    $ docker exec -i $CONTAINER_ID psql -U vdbm uni-watcher < UNI_WATCHER_DB_DUMP_FILE_PATH.sql
+
+    # uni-info-watcher database
+    $ docker exec -i $CONTAINER_ID psql -U vdbm uni-info-watcher < UNI_INFO_WATCHER_DB_DUMP_FILE_PATH.sql
+    ```
+
+* Start all the watcher and info app services:
+
+  ```bash
+  $ laconic-so deploy-system --include watcher-uniswap-v3 up
+  ```
+
+* Check that all the services are up and healthy:
+
+  ```bash
+  $ docker ps
+  ```
+
+  * The `uni-info-watcher` GraphQL Playground can be accessed at `http://localhost:3004/graphql`
+  * The frontend app can be accessed at `http://localhost:3006`
+
+## Clean up
+
+* To stop all the services running in background:
+
+  ```bash
+  $ laconic-so deploy-system --include watcher-uniswap-v3 down
+  ```
@@ -0,0 +1,10 @@
+version: "1.0"
+name: uniswap-v3
+repos:
+  - vulcanize/uniswap-watcher-ts
+  - vulcanize/uniswap-v3-info
+containers:
+  - cerc/watcher-uniswap-v3
+  - cerc/uniswap-v3-info
+pods:
+  - watcher-uniswap-v3