Oya Commitments

Oya Commitments are Safe-based commitments controlled by plain-language rules and enforced via an Optimistic Governor module. This repo contains the Solidity contracts, deployment scripts, an optional web UI, and an offchain agent scaffold.

Beta Disclaimer

This is beta software provided “as is.” Use at your own risk. No guarantees of safety, correctness, or fitness for any purpose.

How It Works (At a Glance)

• Write plain-language rules that define what the commitment may do.
• Deploy a Safe wired to an Optimistic Governor module with those rules.
• An agent or user proposes transactions via the module and posts a bond.
• If no challenge occurs during the window, the proposal is executed by the Safe.

Quick Start

1. Install Foundry: https://book.getfoundry.sh/
2. Set required environment variables (see docs/deployment.md).
3. Run the deployment script:

forge script script/DeploySafeWithOptimisticGovernor.s.sol:DeploySafeWithOptimisticGovernor \
  --rpc-url <your_rpc_url> \
  --broadcast \
  --private-key <your_private_key>

Build An Agentic Commitment

The fastest path to a new commitment/agent combo is:

1. Copy agent-library/agents/default/ to agent-library/agents/<agent-name>/.
2. Write the commitment rules in agent-library/agents/<agent-name>/commitment.txt.
3. Implement commitment-specific behavior in agent-library/agents/<agent-name>/agent.js.
4. Put non-secret runtime settings in agent-library/agents/<agent-name>/config.json.
5. Keep only secrets in agent/.env.
6. Validate and smoke test locally:

node agent/scripts/validate-agent.mjs --module=<agent-name>
node agent/scripts/testnet-harness.mjs smoke --module=<agent-name> --profile=local-mock
node agent/scripts/testnet-harness.mjs down --module=<agent-name> --profile=local-mock

The detailed workflow for module structure, config.json, and local/remote harness profiles is in agent/README.md and agent-library/README.md.

Documentation

• Contribution workflow and policy: CONTRIBUTING.md
• Skill for new agent/commitment combos: skills/add-agent-commitment/SKILL.md
• Agent module layout and new-commitment workflow: agent-library/README.md
• Runner config, message API, and harness usage: agent/README.md
• Deployment and configuration: docs/deployment.md
• Signer options and with-signer helper: docs/signers.md
• Offchain agent usage: docs/agent.md
• Agent extension decision rules: docs/agent-extension-guidelines.md
• Web frontend: docs/frontend.md
• Testing and common commands: docs/testing.md

Repo Layout

• src/ Solidity contracts
• script/ Foundry deployment and ops scripts
• test/ Foundry tests
• agent/ Offchain agent scaffold
• frontend/ Web UI
• lib/ External dependencies (Foundry)