# README
LSC Client CLI
This CLI app provides functionalities such as key management, operator registration, chain subscription, monitoring configuration and automated docker deployment which are necessary to run the LSC Attestation Node.
Lagrange State Committees
For a full breakdown of the Lagrange State Committee architecture, please refer to the below two documents:
Installing CLI from source
To begin with, install Go programming language following the steps mentioned in the docs.
- Clone CLI repository
git clone https://github.com/Lagrange-Labs/lsc-client-cli.git
- Set CGO Flags
export CGO_CFLAGS="-O -D__BLST_PORTABLE__"
export CGO_CFLAGS_ALLOW="-O -D__BLST_PORTABLE__"
- Create binary
cd client-cli
mkdir -p dist
go build -o ./dist cmd/main.go
or
cd client-cli
sudo apt install make gcc
make build
Running a LSC Attestation Node
Please refer to the detailed documentation.
- Networks:
- Holesky
- Mainnet
- System Requirements
- Supported Chains
- Prerequisite Installations
- Setup configuration file
- Commands
- Setup Keystore
- Register Operator
- Deploy attestation node
- Post deployment
Commands
The below commands will allow a developer to run a node and attest to the state of supported chains.
- generate-keystore
- import-keystore
- export-keystore
- export-public-key
- register-operator
- deregister-operator
- update-bls-pub-key
- update-signer-address
- add-bls-pub-key
- remove-bls-pub-key
- subscribe-chain
- unsubscribe-chain
- generate-config
- generate-docker-compose
- deploy
- generate-signer-config
- deploy-signer
- generate-config-deploy
- bulk-generate-config-deploy
Post Deployment
-
If you wish to setup Grafana dashboard for monitoring your attestation node, please review the steps mentioned in this documentation
-
The detailed information for the post-deployment monitoring can be found on our documentation page.
If you face any issues while running the LSC Attestation Node, please reach out to the Lagrange Labs team on Discord.