Sonic Bridge Validator

Table of Contents

• Introduction
• Features
• Prerequisites
• Installation
• Configuration
  • Wallet Private Key
  • Environment Variables
• Usage
• Security Considerations
• Infrastructure Requirements
• Troubleshooting
• Contributing
• License

Introduction

The Sonic Bridge Validator is a service that listens for bridge events emitted by smart contracts. Upon detecting an event, the validator verifies it, signs the event message, and sends the signed message to relayer services. This crucial component ensures the integrity and security of cross-chain transactions in the Sonic Bridge ecosystem.

Features

• Real-time monitoring of bridge events
• Event verification and signature
• Secure key management using AWS KMS
• Efficient message relay to relayer services

Prerequisites

• Node.js (version 18.14.0 or higher)
• AWS account with KMS access
• Basic understanding of blockchain bridges and validator operations

Installation

1. Clone the repository:

   git clone https://github.com/mirrorworld-universe/sonic-bridge-validator.git
   cd sonic-bridge-validator
   

2. Install dependencies:

   npm install
   

Configuration

Wallet Private Key

The validator service uses AWS KMS (Key Management Service) to securely manage your wallet's private key. Follow these steps to set up your private key:

1. Generate an encrypted wallet private key using AWS KMS.
2. Set the encrypted private key to the WALLET_PRIVATE_KEY environment variable.

Environment Variables

Create a .env file in the root directory and add the following variables:

# wallet setings
WALLET_PRIVATE_KEY=your_encrypted_private_key
KMS_KEY_ID=your_kms_key_id
KMS_REGION=your_kms_region
KMS_AWS_ACCESS_KEY_ID=your_aws_key_id
KMS_AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key

# network and rpc
# sonic networks: sonic_devnet, sonic_testnet, sonic_mainnet
SONIC_NETWORK=sonic_network
SONIC_RPC=sonic_rpc_url
# solana networks: solana_devnet, solana_testnet, solana_mainnet
SOLANA_NETWORK=solana_network
SOLANA_RPC=solana_rpc_url

# AWS SNS settings, provided by mirrorworld
AWS_ACCESS_KEY_ID=aws_sns_key_id
AWS_SECRET_ACCESS_KEY=aws_sns_access_key
AWS_REGION=aws_sns_region
SNS_TOPIC=aws_sns_topic
SNS_GROUP=aws_sns_group

Usage

To start the validator service:

npm start

Security Considerations

While AWS KMS provides a secure environment for key management, it's essential to follow these best practices:

1. Safeguard Key Usage Permissions: Implement least privilege access principles, granting only necessary permissions to trusted users or applications.

2. Regularly Review IAM and KMS Permissions: Periodically audit permissions associated with your KMS keys to prevent stale or excessive access.

3. Set Up CloudWatch Alerts: Use AWS CloudWatch to monitor unusual activity related to your KMS keys. Set alerts for key creation, deletion, or unauthorized access attempts.

Infrastructure Requirements

The Sonic Bridge Validator has modest hardware requirements and can run on physical or virtual machines with a stable network connection.

Recommended Configuration:

• CPU: 1 core
• Memory: 1GB RAM
• Storage: 10GB
• Bandwidth: 100Mbps

Troubleshooting

If you encounter issues:

1. Check the logs for error messages
2. Verify your AWS credentials and permissions
3. Ensure your network connection is stable
4. Reach out to Sonic Engineering Support team at operators@sonic.game
5. Open an issue on this GitHub repository)

For additional help, please open an issue on our GitHub repository.

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

This project is licensed under the Apache License 2.0.