Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sparta bot #470

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
License text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.
"Business Source License" is a trademark of MariaDB Corporation Ab.

Parameters

Licensor: HashiCorp, Inc.
Licensed Work: Terraform Version 1.6.0 or later. The Licensed Work is (c) 2024
HashiCorp, Inc.
Additional Use Grant: You may make production use of the Licensed Work, provided
Your use does not include offering the Licensed Work to third
parties on a hosted or embedded basis in order to compete with
HashiCorp's paid version(s) of the Licensed Work. For purposes
of this license:

A "competitive offering" is a Product that is offered to third
parties on a paid basis, including through paid support
arrangements, that significantly overlaps with the capabilities
of HashiCorp's paid version(s) of the Licensed Work. If Your
Product is not a competitive offering when You first make it
generally available, it will not become a competitive offering
later due to HashiCorp releasing a new version of the Licensed
Work with additional capabilities. In addition, Products that
are not provided on a paid basis are not competitive.

"Product" means software that is offered to end users to manage
in their own environments or offered as a service on a hosted
basis.

"Embedded" means including the source code or executable code
from the Licensed Work in a competitive offering. "Embedded"
also means packaging the competitive offering in such a way
that the Licensed Work must be accessed or downloaded for the
competitive offering to operate.

Hosting or using the Licensed Work(s) for internal purposes
within an organization is not considered a competitive
offering. HashiCorp considers your organization to include all
of your affiliates under common control.

For binding interpretive guidance on using HashiCorp products
under the Business Source License, please visit our FAQ.
(https://www.hashicorp.com/license-faq)
Change Date: Four years from the date the Licensed Work is published.
Change License: MPL 2.0

For information about alternative licensing arrangements for the Licensed Work,
please contact [email protected].

Notice

Business Source License 1.1

Terms

The Licensor hereby grants you the right to copy, modify, create derivative
works, redistribute, and make non-production use of the Licensed Work. The
Licensor may make an Additional Use Grant, above, permitting limited production use.

Effective on the Change Date, or the fourth anniversary of the first publicly
available distribution of a specific version of the Licensed Work under this
License, whichever comes first, the Licensor hereby grants you rights under
the terms of the Change License, and the rights granted in the paragraph
above terminate.

If your use of the Licensed Work does not comply with the requirements
currently in effect as described in this License, you must purchase a
commercial license from the Licensor, its affiliated entities, or authorized
resellers, or you must refrain from using the Licensed Work.

All copies of the original and modified Licensed Work, and derivative works
of the Licensed Work, are subject to this License. This License applies
separately for each version of the Licensed Work and the Change Date may vary
for each version of the Licensed Work released by Licensor.

You must conspicuously display this License on each original or modified copy
of the Licensed Work. If you receive the Licensed Work in original or
modified form from a third party, the terms and conditions set forth in this
License apply to your use of that work.

Any use of the Licensed Work in violation of this License will automatically
terminate your rights under this License for the current and all other
versions of the Licensed Work.

This License does not grant you any right in any trademark or logo of
Licensor or its affiliates (provided that you may use a trademark or logo of
Licensor as expressly required by this License).

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
TITLE.
9 changes: 9 additions & 0 deletions terraform.tfstate
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tfstate files shouldn't be included, add to .gitignore

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually seeing that .gitignore has *.tfstate so not sure how this was included

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was prob cached before I added it to .gitignore. I'll remove it. Actually I will probably go with another AWS solution. Still discussing with Charlie so I'll move this to draft in the time being

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"version": 4,
"terraform_version": "1.10.4",
"serial": 1,
"lineage": "5b4500a2-d397-e510-9de0-aaeab4d564c0",
"outputs": {},
"resources": [],
"check_results": null
}
40 changes: 40 additions & 0 deletions tooling/sparta/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Node.js
node_modules/
dist/
*.log
.env
.env.*
!.env.example

# Terraform
*.tfstate
*.tfstate.*
.terraform/
terraform.tfvars
.terraform.lock.hcl
*.tfvars
!terraform.tfvars.example

# Build artifacts
*.zip
deployment-*.zip

# IDE
.vscode/
.idea/
*.swp
*.swo

# OS
.DS_Store
Thumbs.db

# Elastic Beanstalk Files
.elasticbeanstalk/*
!.elasticbeanstalk/*.cfg.yml
!.elasticbeanstalk/*.global.yml

# Package managers
bun.lockb
yarn.lock
package-lock.json
141 changes: 141 additions & 0 deletions tooling/sparta/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# Sparta Discord Bot

A Discord bot for managing Aztec validators, built with Node.js and deployed on AWS Elastic Beanstalk.

## Prerequisites

- Node.js v18 or higher
- AWS CLI configured with appropriate credentials
- Terraform v1.0 or higher
- Discord Bot Token and Application ID from [Discord Developer Portal](https://discord.com/developers/applications)

## Security Notice

⚠️ **Important**: This project uses sensitive credentials that should never be committed to version control:
- Discord bot tokens
- Ethereum private keys
- AWS credentials
- Environment variables

Always use:
- `.env` files for local development (never commit these)
- AWS Secrets Manager for production secrets
- `terraform.tfvars` for Terraform variables (never commit this)

## Local Development

1. Clone the repository:
```bash
git clone <repository-url>
cd sparta
```

2. Install dependencies:
```bash
cd src
npm install
```

3. Create a `.env` file in the `src` directory using `.env.example` as a template:
```bash
cp .env.example .env
```

4. Fill in the required environment variables in `.env`:
```
# Discord Bot Configuration
BOT_TOKEN=your_bot_token
BOT_CLIENT_ID=your_client_id
GUILD_ID=your_guild_id

# Ethereum Configuration
ETHEREUM_HOST=http://localhost:8545
ETHEREUM_ROLLUP_ADDRESS=your_rollup_address
ETHEREUM_ADMIN_ADDRESS=your_admin_address
ETHEREUM_CHAIN_ID=1337
ETHEREUM_PRIVATE_KEY=your_private_key
ETHEREUM_VALUE=20ether
```

5. Start the bot in development mode:
```bash
npm run watch
```

## Deployment

The bot is deployed using Terraform to AWS Elastic Beanstalk. Follow these steps:

1. Navigate to the terraform directory:
```bash
cd terraform
```

2. Create `terraform.tfvars` using the example file:
```bash
cp terraform.tfvars.example terraform.tfvars
```

3. Fill in the required variables in `terraform.tfvars`:
```hcl
environment = "production"
aws_region = "us-west-2"
bot_token = "your_bot_token"
bot_client_id = "your_client_id"
guild_id = "your_guild_id"
ethereum_host = "your_ethereum_host"
# ... other variables
```

4. Initialize Terraform:
```bash
terraform init
```

5. Deploy:
```bash
terraform apply
```

## Architecture

- **Discord.js**: Handles bot interactions and commands
- **AWS Elastic Beanstalk**: Hosts the bot in a scalable environment
- **AWS Secrets Manager**: Securely stores sensitive configuration
- **TypeScript**: Provides type safety and better development experience

## Environment Variables

### Development
- Uses `.env` file for local configuration
- Supports hot reloading through `npm run watch`

### Production
- Uses AWS Secrets Manager for secure configuration
- Automatically loads secrets in production environment
- Supports staging and production environments

## Commands

- `/get-info`: Get chain information
- `/admin validators get`: List validators
- `/admin validators remove`: Remove a validator
- `/admin committee get`: Get committee information

## Contributing

1. Create a feature branch
2. Make your changes
3. Submit a pull request

## Security

- All sensitive information is stored in AWS Secrets Manager
- IAM roles are configured with least privilege
- Environment variables are never committed to version control
- SSH access is controlled via key pairs
- No sensitive information in logs or error messages

## License

[Your License]
12 changes: 12 additions & 0 deletions tooling/sparta/src/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Discord Bot Configuration
BOT_TOKEN=your_bot_token_here
BOT_CLIENT_ID=your_client_id_here
GUILD_ID=your_guild_id_here

# Ethereum Configuration
ETHEREUM_HOST=http://localhost:8545
ETHEREUM_PRIVATE_KEY=your_private_key_here
ETHEREUM_ROLLUP_ADDRESS=your_rollup_address_here
ETHEREUM_CHAIN_ID=1337
ETHEREUM_VALUE=20ether
ETHEREUM_ADMIN_ADDRESS=your_admin_address_here
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/bash
echo "export ENVIRONMENT=${ENVIRONMENT}" >> /etc/profile.d/eb_env.sh
echo "export AWS_REGION=${AWS_REGION}" >> /etc/profile.d/eb_env.sh

# Update system packages
sudo yum update -y
sudo yum install -y docker

# Install and configure Docker
sudo systemctl enable docker
sudo systemctl start docker
sudo usermod -a -G docker webapp
sudo usermod -a -G docker ec2-user

# Install Foundry
curl -L https://foundry.paradigm.xyz | bash
source /root/.bashrc
foundryup

# Verify installations
echo "Verifying installations..."
docker --version || echo "Docker not installed"
source /etc/profile.d/foundry.sh && cast --version || echo "Foundry not installed"
3 changes: 3 additions & 0 deletions tooling/sparta/src/admins/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import validators from "./validators.js";

export default { validators };
Loading