Skip to content
This repository has been archived by the owner on May 28, 2021. It is now read-only.

Commit

Permalink
Deploy indra-7.3.11
Browse files Browse the repository at this point in the history
  • Loading branch information
@LayneHaber
LayneHaber committed Aug 30, 2020
2 parents 9ec72ae + 039da99 commit f2e5ddc
Show file tree
Hide file tree
Showing 152 changed files with 55,350 additions and 51,890 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cd-staging.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,5 @@ jobs:
export INDRA_DOMAINNAME="$STAGING_DOMAINNAME";
make restart-prod;
docker container prune -f;
docker image ls -q | xargs docker image rm || true;
docker image ls -q | xargs docker image rm -f || true;
'
5 changes: 4 additions & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,10 @@ test-watcher: watcher
bash ops/test/watcher.sh

test-node: node
bash ops/test/node.sh
bash ops/test/node.sh test

watch-node:
bash ops/test/node.sh watch

test-tps: bot
bash ops/test/tps.sh 5 0 10
Expand Down
2 changes: 1 addition & 1 deletion docs/src/background/protocol.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ The currently supported outcome types are:

## Note:

Any consumer of the Node should set up a handler for the event `DEPOSIT_CONFIRMED` so as to define how this Node behaves when a counter party has initiated a deposit and is asking this Node to make a counter deposit and collateralize the channel. The parameters passed with this event correspond to the same ones used by the initiator, tha is `DepositParams` (as defined in the `@counterfactual/types packages`).
Any consumer of the Node should set up a handler for the event `DEPOSIT_CONFIRMED_EVENT` so as to define how this Node behaves when a counter party has initiated a deposit and is asking this Node to make a counter deposit and collateralize the channel. The parameters passed with this event correspond to the same ones used by the initiator, tha is `DepositParams` (as defined in the `@counterfactual/types packages`).

If no such handler is defined, `No event handler for counter depositing into channel <info>` is printed indicating the Node does not know how to handle a counter deposit request.
128 changes: 11 additions & 117 deletions docs/src/how-to/deploy-indra.md
View file
Original file line number Diff line number Diff line change
@@ -1,118 +1,12 @@
# Deploy Indra Node

## Launch Indra Locally

**Prerequisites:**

- `make`: Probably already installed, otherwise install w `brew install make` or `apt install make` or similar.
- `jq`: Probably not installed yet, install w `brew install jq` or `apt install jq` or similar.
- `docker`: sadly, Docker is kinda annoying to install. See [website](https://www.docker.com/) for instructions.

To start, clone & enter the Indra repo:

```bash
git clone https://github.com/ConnextProject/indra.git
cd indra
```

To build everything and deploy Indra in dev-mode, run the following:

```bash
make start

# view the node logs
bash ops/logs.sh node
```

That's all! But beware: the first time `make start` is run, it will take a very long time (maybe 10 minutes, depends on your internet speed) but have no fear: downloads will be cached & most build steps won't ever need to be repeated again so subsequent `make start` runs will go much more quickly. Get this started asap & browse the rest of the README while the first `make start` runs.

By default, Indra will launch using two local chains (ganache with chain id `1337` and `1338`) but you can also run a local Indra stack against a public chain (or multiple chains!) such as Rinkeby. To do so, run `make start` with a custom `INDRA_CHAIN_PROVIDERS` environment variable. The variable is formatted as a JSON string with a chainId:providerUrl mapping:

```bash
INDRA_CHAIN_PROVIDERS='{"4":"https://rinkeby.infura.io/abc123","42":"https://kovan.infura.io/abc123"}' make start
```

Note: this will start a local Connext node pointed at a remote chain, so make sure the mnemonic used to start your node is funded in the appropriate native currencies and supported chain assets. By default, the node starts with the account:

```node
mnemonic: "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat";
privateKey: "0xc87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3";
address: "0x627306090abaB3A6e1400e9345bC60c78a8BEf57";
```

### Interacting with Local Indra

#### Onchain Funding

If you're using the local dev-mode blockchain, you can load the default node account into your wallet to directly access funds on a local chain running at `http://localhost:8545`

There are also some command line options:

```bash
# Send ETH from node to provided recipient
bash ops/fund.sh <RECIPIENT_ADDRESS> <ETH_AMOUNT_TO_SEND>

# Drip ERC20 to provided account
# if you don't specify an eth provider, http://localhost:8545 is used as the
# default
bash ops/drip.sh <RECIPIENT_PRIVATE_KEY> <ETH_PROVIDER_URL>
```

#### Local Daicard

To interact with the stack using a browser UI, run:

```bash
make start-daicard
```

This will start the Daicard UI at `http://localhost:3000` with an integrated client connected to a locally running indra node.

Try visiting the Daicard, find your address (top left) & copy it to your clipboard, and then run the following to send a bit of test-ETH to your account:

```bash
bash ops/fund.sh <RECIPIENT_ADDRESS>
```

Daicard should detect this transfer & automatically deposit these funds into your channel.

Note: Each Daicard stores account info in localStorage so if you want to play with two different Daicard accounts at the same time (eg to experiment with sending payments back and forth), open one of them in an incognito window or in a different browser.

As you play with the Daicard, you can monitor the node's logs with `bash ops/logs.sh node` or substitute "node" with any other service of the Indra stack (see all services with `make dls`).

#### Useful Commands

- `make`: Builds everything that has changed since the last build
- `make all`: Builds all images, including any extras or prod mode bundles.
- `make start`: Builds anything out of date & then starts the app
- `make stop`: Stop the app once it's been started
- `make restart`: Stop the app & start it again, rebuilding anything that's out of date
- `make clean`: Stops the app & deletes all build artifacts eg transpiled typescript
- `make reset`: Stops the app & removes all persistent data eg database data
- `make dls`: Show all running services (groups of containers) plus list all running containers.
- `bash ops/db.sh`: Opens a console attached to the running app's database. You can also run `bash ops/db.sh '\d+'` to run a single PostgreSQL query (eg `\d+` to list table details).
- `bash ops/logs.sh node`: Monitor the node's logs. You can also monitor logs for the database, webserver, 1337, etc. by changing the first argument

#### Running Tests

- `make test-cf`: run unit tests for core protocol logic (cf-core).
- `make test-contracts`: run unit tests for Ethereum smart contracts.
- `make test-client`: run unit tests for the channel client.
- `make test-node`: run unit tests for the node server.
- `make start && make test-daicard`: run integration tests for the Daicard UI.
- `make start && make test-integration`: run client-node integration test suite.
- `make start && make watch-ui`: Open a test-optimized browser & use cypress to run automated e2e tests. Tests will be re-run any time test files change.
- `make start && make watch-integration`: start a test watcher that will re-run integration tests whenever test code changes (great to use while debugging).

## Production Deployment
# How To Deploy an Indra Node

Lets say you want to deploy an Indra payment node to `https://indra.example.com` (we'll call this url `$DOMAINNAME`)

First step: get a server via AWS or DigitalOcean or hardware at home. For best results, use the most recent LTS version of Ubuntu & make sure it has at least 32GB of disk space. If using DigitalOcean, make sure you toggle on the VPC network when instantiating a droplet. Note this new server's IP address (we'll call it `$SERVER_IP`). Make sure it's able to connect to the internet via ports 80, 443, 4221, and 4222 (no action required on DigitalOcean, Security Group config needs to be setup properly on AWS).

Set up DNS so that `$DOMAINNAME` points to this server's IP address. If you're using CloudFlare name servers, turn on CloudFlare's built-in SSL support & make sure it's set to "Full (strict)".

Next: Clone the repo and cd into it.
We won't need to ssh into this server right away, most of the setup will be done locally. Start by cloning the repo to your local machine if you haven't already and `cd` into it.

```
git clone [email protected]:connext/indra.git
Expand All @@ -121,17 +15,17 @@ cd indra

Every Indra node needs access to a hot wallet, you should generate a fresh mnemonic for your node's wallet that isn't used anywhere else. You can generate a new mnemonic from a node console with ethers by doing something like this: `require('ethers').Wallet.createRandom()`. Alternatively, you can generate one [here](https://iancoleman.io/bip39/).

Save this mnemonic somewhere safe, copy it to your clipboard, and then run:
Save this mnemonic somewhere safe and copy it to your clipboard. From your local machine, run:

```bash
SSH_KEY=$HOME/.ssh/id_rsa bash ops/setup-ubuntu.sh $SERVER_IP
```

(`$HOME/.ssh/id_rsa` is the default `SSH_KEY`, if this is what you're using then no need to supply it)
(`$HOME/.ssh/id_rsa` is the default `SSH_KEY`, if this is the key you'll use to access `$SERVER_IP` then you don't need to supply it explicitly)

If this is a fresh Ubuntu server from DigitalOcean or AWS then the above script should:
If this is a fresh Ubuntu server from DigitalOcean or AWS then the `ops/setup-ubuntu.sh` script should ssh into your server using the specified ssh key and go through the following steps:

- configure an "ubuntu" user and disable root login (if enabled)
- create & configure an "ubuntu" user and disable root login (if root login was enabled to begin with)
- give an additional ssh public key login access if key specified by the `PUB_KEY` env var is available (defaults to `$HOME/.ssh/autodeployer.pub`)
- install docker & make & other dependencies
- upgrade everything to the latest version
Expand All @@ -140,8 +34,6 @@ If this is a fresh Ubuntu server from DigitalOcean or AWS then the above script

Note: this script is idempotent aka you can run it over and over again w/out causing any problems. In fact, re-running it every month or so will help keep things up-to-date (you can skip inputting the mnemonic on subsequent runs).

If you already have a server with docker & make installed, there's another helper script you can use to easily load your mnemonic: `bash ops/save-secret.sh`. Run this on your prod server & copy/paste in your mnemonic.

For convenience's sake, we recommend adding an entry to your ssh config to easily access this server. Add something that looks like the following to `$HOME/.ssh/config`:

```bash
Expand All @@ -165,7 +57,7 @@ Ensure you've added correct values for two important env vars: `INDRA_DOMAINNAME
The `INDRA_CHAIN_PROVIDERS` env var is a tricky one, there is no default provided as it's value depends entirely on which chains you want to support (if this env var is not provided, a local testnet will be started up & Indra will use this). The format is very specific: it must be valid JSON where the key is a chain id (eg `"4"`) and the value is that chain's provider url (eg `"https://eth-rinkeby.alchemyapi.io/v2/abc123"`). The double quotes within this env var must be preserved, this is accomplished most reliably by both single-quoting the env var value and escaping the double quotes with back slashes. When you're done, you should have a line in your `.env` file that looks something like this:

```bash
export INDRA_CHAIN_PROVIDERS='{\"4\":\"https://eth-rinkeby.alchemyapi.io/v2/abc123\"}'
export INDRA_CHAIN_PROVIDERS='{"4":"https://eth-rinkeby.alchemyapi.io/v2/abc123"}'
```

Upload the prod env vars to the indra server. If you're using a custom address book, upload that too:
Expand All @@ -175,7 +67,9 @@ scp .env new-indra:~/indra/
scp address-book.json new-indra:~/indra/
```

Login to your prod server then run the following to launch your Indra node:
Now, it's finally time to login to your prod server using `ssh new-indra` (or whichever host you've specified in your ssh config file).

Once you've ssh'd into your new server, run the following to launch your Indra node:

```bash
cd indra
Expand All @@ -186,7 +80,7 @@ make restart-prod
The above will download & run docker images associated with the commit/tag you have checked out. If you want to launch a specific version of indra, checkout that version's tag & restart:

```bash
git checkout indra-6.0.8 && make restart-prod
git checkout indra-7.3.8 && make restart-prod
```

Before you are able to start sending payments, you will have to make sure to properly collateralize your node. The signer address is available as `accounts[0]` off of your mnemonic and can also be found by querying the `/config` endpoint under `signerAddress`. Node's should have collateral in all supported tokens, as well as sufficient eth to pay for all transactions from the wallet to the channels. By default, the supported token addresses will include ETH and the `Token` address from the network context of your node (available in `address-book.json`).
30 changes: 15 additions & 15 deletions docs/src/quickstart/advanced.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,26 @@ The callback has a single parameter `data` which contains contextual data from t
Channel Events:

```javascript
CREATE_CHANNEL,
DEPOSIT_CONFIRMED,
DEPOSIT_FAILED,
DEPOSIT_STARTED,
WITHDRAWAL_CONFIRMED,
WITHDRAWAL_FAILED,
WITHDRAWAL_STARTED,
CREATE_CHANNEL_EVENT,
DEPOSIT_CONFIRMED_EVENT,
DEPOSIT_FAILED_EVENT,
DEPOSIT_STARTED_EVENT,
WITHDRAWAL_CONFIRMED_EVENT,
WITHDRAWAL_FAILED_EVENT,
WITHDRAWAL_STARTED_EVENT,
```

App Instance Events:

```javascript
INSTALL,
INSTALL_VIRTUAL,
REJECT_INSTALL,
UNINSTALL,
UNINSTALL_VIRTUAL,
UPDATE_STATE,
PROPOSE_INSTALL,
REJECT_INSTALL_VIRTUAL,
INSTALL_EVENT,
INSTALL_VIRTUAL_EVENT,
REJECT_INSTALL_EVENT,
UNINSTALL_EVENT,
UNINSTALL_VIRTUAL_EVENT,
UPDATE_STATE_EVENT,
PROPOSE_INSTALL_EVENT,
REJECT_INSTALL_VIRTUAL_EVENT,
```

Protocol Events:
Expand Down
29 changes: 29 additions & 0 deletions docs/src/reference/node.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Node

## Configuration

### Environment Variables

The following environment variables are used by the node:

| Variable Name | Type | Description | Example |
| --------------------------------------- | ----------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `INDRA_ADMIN_TOKEN` | String | Token for administrative functions. | cxt1234 |
| `INDRA_CHAIN_PROVIDERS` | JSON String | Mapping of chainId to ethProviderUrl | '{"1":"https://mainnet.infura.io/v3/TOKEN","4":"https://rinkeby.infura.io/v3/TOKEN"}' |
| `INDRA_CONTRACT_ADDRESSES` | JSON String | Contract information, keyed by chainId | '{ "1337": { "ChallengeRegistry": { "address": "0x8CdaF0CD259887258Bc13a92C0a6dA92698644C0", "creationCodeHash": "0x42eba77f58ecb5c1352e9a62df1eed73aa1a89890ff73be1939f884f62d88c46", "runtimeCodeHash": "0xc38bff65185807f2babc2ae1334b0bdcf5fe0192ae041e3033b2084c61f80950", "txHash": "0x89f705aefdffa59061d97488e4507a7af4a4751462e100b8ed3fb1f5cc2238af" }, ...}' |
| `INDRA_DEFAULT_REBALANCE_PROFILE_ETH` | JSON String | Rebalance Profile to use by default | '{"collateralizeThreshold":"500000000000","target":"1500000000000","reclaimThreshold":"10000000000000"}' |
| `INDRA_DEFAULT_REBALANCE_PROFILE_TOKEN` | JSON String | Rebalance Profile to use by default (real units) | '{"collateralizeThreshold":"500000000000","target":"1500000000000","reclaimThreshold":"10000000000000"} |
| `INDRA_LOG_LEVEL` | Number | Log level - 1 = Error, 4 = Debug | 3 |
| `INDRA_MNEMONIC_FILE` |
| `INDRA_NATS_JWT_SIGNER_PRIVATE_KEY` |
| `INDRA_NATS_JWT_SIGNER_PUBLIC_KEY` |
| `INDRA_NATS_SERVERS` |
| `INDRA_NATS_WS_ENDPOINT` |
| `INDRA_PG_DATABASE` |
| `INDRA_PG_HOST` |
| `INDRA_PG_PASSWORD_FILE` |
| `INDRA_PG_PORT` |
| `INDRA_PG_USERNAME` |
| `INDRA_PORT` |
| `INDRA_REDIS_URL` |
| |
4 changes: 2 additions & 2 deletions docs/src/reference/watcher.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ type WatcherInitOptions = {
signer: IChannelSigner | string; // wallet or pk
provider: providers.JsonRpcProvider | string;
context: ContractAddresses;
store: IWatcherStoreService;
store: IStoreService;
logger?: ILoggerService | ILogger;
logLevel?: number;
};
Expand All @@ -130,7 +130,7 @@ The options object contains the following fields:
A json containing all the addresses across the relevant network (should be derived from your `address-book.json`). This will be shared with an internal instance of the ChainListener class.

- `store`:
`IWatcherStoreService` is an interface containing all the store methods for saving challenge records. You can use any connext store, or implement your own. See [challenge storage](#challengestorage) for more detail.
`IStoreService` is an interface containing all the store methods for saving challenge records. You can use any connext store, or implement your own. See [challenge storage](#challengestorage) for more detail.

- `logger (optional)`:
Optional logger, can use the exported logger from the `@connext/utils` package
Expand Down
8 changes: 4 additions & 4 deletions modules/apps/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@connext/apps",
"version": "7.3.6",
"version": "7.3.11",
"description": "Connext Counterfactual Apps",
"main": "dist/index.js",
"module": "dist/index.esm.js",
Expand All @@ -19,10 +19,10 @@
},
"devDependencies": {
"@connext/contracts": "3.5.0",
"@connext/types": "7.3.6",
"@connext/utils": "7.3.6",
"@connext/types": "7.3.11",
"@connext/utils": "7.3.11",
"@rollup/plugin-json": "4.1.0",
"ethers": "5.0.8",
"ethers": "5.0.7",
"rollup": "2.23.0",
"rollup-plugin-typescript2": "0.27.1",
"typescript": "3.9.7"
Expand Down
Loading

0 comments on commit f2e5ddc

Please sign in to comment.