nitro-stack/stack-orchestrator/stacks/nitro-node/README.md
Prathamesh Musale ceae9fe8d4 Remove go-nitro repo dependency from nitro-node and bridge stacks (#12)
Part of [Create bridge channel in go-nitro](https://www.notion.so/Create-bridge-channel-in-go-nitro-22ce80a0d8ae4edb80020a8f250ea270)
- Remove `go-nitro` repo from `bridge` and `nitro-node` stacks
- Add a separate image for Nitro contracts deployment
- Update `go-nitro` Dockerfile to:
	- Fetch `nitro` and `bridge` binaries from <https://git.vdb.to/cerc-io/nitro>  instead of building from source
	- Use `ubuntu:latest` as base image instead of `deban:bullsye-slim`
- Update `nitro-client` Dockerfile to:
	- Install `nitro-rpc-client` package from `git.vdb.to/cerc-io` instead of building from source

Co-authored-by: Adw8 <adwaitgharpure@gmail.com>
Co-authored-by: Shreerang Kale <shreerangkale@gmail.com>
Reviewed-on: #12
Co-authored-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
Co-committed-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
2024-10-17 07:46:14 +00:00

80 lines
1.7 KiB
Markdown

# nitro-node
## Setup
- Clone the stack repo
```bash
laconic-so fetch-stack git.vdb.to/cerc-io/nitro-stack
```
- Build the container image
```bash
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node build-containers
```
## Create a deployment
- Create a spec file
```bash
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output nitro-node-spec.yml
```
- TODO: Edit `network` in the spec file to map container ports to host ports as required:
```bash
network:
ports:
go-nitro:
- 3005:3005
- 4005:4005
```
- Create deployment
```bash
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy create --spec-file nitro-node-spec.yml --deployment-dir nitro-node-deployment
```
## Configuration
- Inside the `nitro-node-deployment` deployment directory, open `config.env` file and set following env variables:
```bash
# URL endpoint of the chain (Example: ws://host.docker.internal:8545)
NITRO_CHAIN_URL=
# Private key of account to be used by Nitro node (derived address is used as Nitro address)
NITRO_PK=
# Private key of the account on chain that is used for funding channels in Nitro node
NITRO_CHAIN_PK=
# Port to be used by P2P message service (Example: 3009)
NITRO_MSG_PORT=
# Port to be used by RPC server (Example: 4009)
NITRO_RPC_PORT=4009
# Contract address of NitroAdjudicator
NA_ADDRESS=
# Contract address of VirtualPaymentApp
VPA_ADDRESS=
# Contract address of ConsensusApp
CA_ADDRESS=
# Address of the bridge node
BRIDGE_ADDRESS=
```
## Start the deployment
```bash
laconic-so deployment --dir nitro-node-deployment start
```
<!-- TODO: Implement -->