History

Adw8 509c00a8e5 Add remote host setup for nitro contracts README		2024-09-09 11:33:07 +05:30
..
templates/specs	Move nitro contracts deployment to separate directory	2024-09-09 09:52:42 +05:30
.gitignore	Add README steps to deploy nitro contracts on remote machine	2024-09-09 10:24:41 +05:30
contract-vars-example.yml	Move nitro contracts deployment to separate directory	2024-09-09 09:52:42 +05:30
deploy-contracts.yml	Move nitro contracts deployment to separate directory	2024-09-09 09:52:42 +05:30
README.md	Add remote host setup for nitro contracts README	2024-09-09 11:33:07 +05:30
setup-vars.yml	Move nitro contracts deployment to separate directory	2024-09-09 09:52:42 +05:30

README.md

nitro-contracts-setup

Setup Ansible

To get started, follow the installation guide to setup ansible on your machine

Setup Remote Hosts

To run the playbooks on a remote machine, follow these steps:

In the nitro-contracts-setup directory, create a new file named hosts.ini:
```
cp ../example-hosts.ini hosts.ini
```
Edit the hosts.ini file to run the playbook on a remote machine
```
[nitro_host]
<host_name> ansible_host=<TARGET_IP> ansible_user=<SSH_USER> ansible_ssh_common_args='-o ForwardAgent=yes'
```
- Replace <host_name> with the alias of your choice.
- Replace <TARGET_IP> with the IP address or hostname of the target machine.
- Replace <SSH_USER> with the SSH username (e.g., dev, ubuntu).

Verify that you are able to connect to the host using the following command

ansible all -m ping -i hosts.ini -k

# Expected output:

# <host_name> | SUCCESS => {
#  "ansible_facts": {
#      "discovered_interpreter_python": "/usr/bin/python3.10"
#  },
#  "changed": false,
#  "ping": "pong"
# }

Deploy Nitro Contracts

The following commands have to be executed in nitro-contracts-setup directory

Copy the contract-vars-example.yml vars file

cp contract-vars-example.yml contract-vars.yml

Edit contract-vars.yml and fill in the following values

# L1 RPC endpoint
geth_url: ""

# L1 chain ID
geth_chain_id: ""

# Private key for a funded account on L1 to use for contracts deployment on L1
geth_deployer_pk: ""

# Custom L1 token to be deployed
token_name: "LaconicNetworkToken"
token_symbol: "LNT"
intial_token_supply: "129600"

To deploy the L1 nitro contracts, execute the deploy-contracts.yml Ansible playbook by running one of the following commands:
- For local deployment, specify the "target_host": localhost in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
```
- For remote deployment, provide an inventory and specify the "target_host": nitro_host in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
```
NOTE: By default, deployments are created in the nitro-contracts-setup/out directory. To change this location, update the nitro_directory variable in the setup-vars.yml file.
- For skipping container build, run with "skip_container_build" : true in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER -kK
```

Check Deployment Status

Run the following command in the directory where the nitro-contracts-deployment is created:

Check logs for deployments:

# Check the L2 nitro contract deployment logs
laconic-so deployment --dir nitro-contracts-deployment logs l2-nitro-contracts -f

Get Contract Addresses

Run the following commands in the directory where the deployments are created:

Get addresses of L1 nitro contracts:

laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cat /app/deployment/nitro-addresses.json"