Skip to content

GridlockNetwork/guardian-node

Repository files navigation

Gridlock Guardian Node

The guardian node is the heart of the Gridlock network. It stores part of a user's private key and works together with other guardian nodes to approve transactions and recover accounts. This distributed approach removes single points of failure, which is the root cause of most crypto loss.

Anyone can run one or more guardian nodes. You can run them to protect your own assets or participate in Gridlock's main network and help protect others—earning rewards in the process.

To understand how the full system works, see SystemOverview.md.
Related: Orch Node | SDK | CLI

Prerequisites

⚠️ Important: The guardian node requires the Orchestration Node and its associated services to be running. Make sure you have this set up before proceeding.

Quick Start

Configuration

Guardian nodes require a .env file for configuration. Copy the example configuration file:

cp example.env .env

Then edit the .env file to customize settings like storage directories and network configuration.

Running a Single Guardian Node

If you already have an orchestration node running, you can run a single guardian node:

docker run --rm --name guardian-node --network gridlock-net \
  -v $(pwd)/.env:/app/.env:ro \
  gridlocknetwork/guardian-node:latest

Running Multiple Guardian Nodes

For advanced setups including multiple guardian nodes, see Customization and Development Guide.

🚀 Pro Tip: Want to run everything with a single command? Check out the Gridlock CLI which can set up and run the entire Gridlock network stack - orchestration node, guardian nodes, network, and database - with just one command!

Join the Network

Running a guardian node gets better when you're part of the official Gridlock network. Run a guardian node and earn rewards while helping others.

Get started learning about the community and LOCK token at gridlock.network/join

About

Core engine for Gridlock’s Threshold Signature crypto operations

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages