skale-admin

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 23 Open GitHub ↗

SKALE admin docker container orchestrates all other SKALE Docker containers

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SKALE Admin

![Test](https://github.com/skalenetwork/skale-admin/workflows/Test/badge.svg)
![Build and publish](https://github.com/skalenetwork/skale-admin/workflows/Build%20and%20publish/badge.svg)
[![Discord](https://img.shields.io/discord/534485763354787851.svg)](https://discord.gg/vvUtWJB)

This repo contains source code for 3 core SKALE Node containers:

* `skale_admin` - worker that manages sChains creation and node rotation
* `skale_api` - webserver that provides node API
* `celery` - distributed task queue

## Development

### Dependencies

Install `uv`:

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Install all dependencies:

```bash
uv sync --prerelease=allow --all-extras
```

### Linting and type checking

#### Check linting/formatting issues

```bash
uv run ruff check
```

#### Check type issues

```bash
uv run mypy .
```

#### Auto-fix ruff issues (linting + formatting)

```bash
uv run ruff check --fix
```

# Format code with ruff

```bash
uv run ruff format
```

In file `.git/hooks/pre-commit` add:

```shell
#!/bin/sh
uv run ruff check
```

### Run tests locally

1. Run local ganache, download and deploy SKALE Manager contracts to it

```bash
   ETH_PRIVATE_KEY=[..] MANAGER_BRANCH=[..] bash ./scripts/deploy_manager.sh
   ```

* `ETH_PRIVATE_KEY` - it could be any valid Ethereum private key (without `0x` prefix!)
   * `MANAGER_BRANCH` - tag of the SKALE Manager image to use (`$MANAGER_BRANCH-latest` will be used)
   * `SGX_WALLET_TAG` - tag of the SGX simulator to use (optional, `latest` will be used by default)

List of the available SM tags: <https://hub.docker.com/r/skalenetwork/skale-manager/tags>\
   List of the available SGX tags: <https://hub.docker.com/r/skalenetwork/sgxwallet_sim/tags>

2. Run SGX wallet simulator and all tests after it

```bash
ETH_PRIVATE_KEY=[...] SCHAIN_TYPE=[...] bash ./scripts/run_tests.sh
```

* `ETH_PRIVATE_KEY` - it could be any valid Ethereum private key (without `0x` prefix!)
* `SCHAIN_TYPE` - type of the chain for the DKG test (could be `test2` - 2 nodes, `test4` - 4 nodes, `tiny` - 16 nodes)

Test build:

```bash
export BRANCH=$(git branch | grep -oP "^\*\s+\K\S+$")
export VERSION=$(bash scripts/calculate_version.sh)
bash scripts/build.sh
```

## License

[![License](https://img.shields.io/github/license/skalenetwork/skale-admin.svg)](https://raw.githubusercontent.com/skalenetwork/skale-admin/develop/LICENSE)

All contributions to SKALE Admin are made under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.en.html). See [LICENSE](LICENSE).

skale-admin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README