Welcome to the Effect AI Task Execution Engine Monorepo. This repository contains all the core packages and components required to run our decentralized, peer-to-peer tasking infrastructure.
This monorepo is organized into the following main directories:
Directory | Description |
---|---|
core/protocol/ |
Core protocol implementation (@effectai/protocol-core ) - tasking infrastructure and shared utilities |
core/protobufs/ |
Protocol buffer definitions (@effectai/protobufs ) for cross-platform communication |
core/program/ |
Core Lib for Solana smart contracts and on-chain program logic |
Directory | Description |
---|---|
modules/manager/ |
Manager node implementation (@effectai/manager ) - orchestrates task distribution |
modules/worker/ |
Worker node implementation (@effectai/worker ) - executes assigned tasks |
modules/payment/ |
Payment processing module (@effectai/payment ) |
modules/reward/ |
Reward distribution system (@effectai/reward ) |
modules/stake/ |
Staking mechanism implementation (@effectai/stake ) |
modules/vesting/ |
Token vesting functionality (@effectai/vesting ) |
modules/migration/ |
Data migration utilities (@effectai/migration ) |
Directory | Description |
---|---|
packages/library/ |
Core protocol library (@effectai/protocol ) - main API package |
packages/utils/ |
Shared utilities (@effectai/utils ) |
packages/solana-utils/ |
Solana-specific utilities (@effectai/solana-utils ) |
packages/test-utils/ |
Testing utilities (@effectai/test-utils ) |
packages/ui/ |
Shared UI components (@effectai/ui ) |
packages/config/ |
Configuration management (@effectai/config ) |
packages/wallets-vue/ |
Vue.js wallet integration (@effectai/wallets-vue ) |
Directory | Description |
---|---|
apps/portal/ |
Main Effect portal web application |
apps/website/ |
Marketing and information website |
apps/docs/ |
Documentation site |
apps/staking-app/ |
Staking interface application |
apps/migration-app/ |
Token migration interface |
apps/task-poster/ |
Task creation and posting interface |
apps/playground/ |
Development playground and testing environment |
Directory | Description |
---|---|
tools/cli/ |
Command-line interface (@effectai/cli ) for network interaction |
tools/docker/ |
Docker configurations and deployment scripts |
tools/scripts/ |
Development and deployment scripts |
tools/keys/ |
Key management utilities |
tools/guix/ |
Guix package definitions |
services/cmc-endpoint/ |
CoinMarketCap API endpoint service |
idls/ |
Interface Definition Language files for Solana contracts |
assets/templates/ |
Task templates and predefined schemas |
- Node.js >= 23.x
- pnpm >= 10.x
pnpm install
To build the project, run:
pnpm build
To spin up a manager node:
pnpm manager:start
Alternatively, you can use the CLI directly:
pnpm cli manager run --help
Workers can be run programmatically using the worker module. See the modules/worker/
documentation for detailed setup instructions.
Note: When running a manager node, it will listen for incoming tasks and assign them to worker nodes. The manager node express server will be available at http://localhost:8889
.
To deploy the necessary programs, and get a local solana validator running, you can use the following command:
docker-compose -f docker-compose.solana.yml up -d
We welcome contributions! See CONTRIBUTING.md for guidelines.
Open an issue or reach out at team@effect.ai.