In progress

.env.sample

@@ -0,0 +1,59 @@
+# Starknet network
+STARKNET_NETWORK=sepolia
+# Public Sepolia RPC (Blast) - used by clients that accept a direct RPC URL
+STARKNET_RPC_URL=https://starknet-sepolia.public.blastapi.io/rpc/v0_8
+
+# Account (signing)
+STARKNET_ACCOUNT_ADDRESS=0x...
+STARKNET_PRIVATE_KEY=0x...
+
+# Deployment keys (contracts/config.json)
+DEPLOYER_ACCOUNT=0x...
+DEPLOYER_PRIVATE_KEY=0x...
+DEVNET_PRIVATE_KEY=0x...
+DUMMY_CLASS_HASH=0x...
+CAIROX_CLASS_HASH=0x...
+
+# Deployed contract addresses
+ORACLE_CONTRACT_ADDRESS=0x...
+RESOLUTION_VERIFIER_ADDRESS=0x..
+ZK_VERIFIER_ADDRESS=0x...
+ORACLE_PROPOSER_BOND=100
+ORACLE_REQUIRE_SIGNED=1
+ORACLE_SIGNER_PUBLIC_KEY=0x...
+ORACLE_SIGNER_PRIVATE_KEY=0x...
+ORACLE_ZK_PROOF_PATH=
+ORACLE_ZK_PROOF_DIR=
+ORACLE_ZK_PUBLIC_INPUTS_PATH=
+CALCULATOR_CONTRACT_ADDRESS=0x...
+MARKET_FACTORY_ADDRESS=0x...
+
+# Stablecoin (Cairox EUR)
+STABLECOIN_NAME=Cairox EUR
+STABLECOIN_SYMBOL=cEUR
+STABLECOIN_DECIMALS=6
+STABLECOIN_INITIAL_SUPPLY=1000000000000
+STABLECOIN_OWNER=0x...
+STABLECOIN_RECIPIENT=0x...
+STABLECOIN_PRICE_FEED=0x...
+STABLECOIN_PRICE_FEED_TYPE=1
+STABLECOIN_TOKEN_ADDRESS=0x...
+CHAINLINK_EUR_USD_FEED=0x...
+EUR_PRICE_ORACLE_ADDRESS=0x...
+INITIAL_SUBSIDY=1000000
+
+# Collateral + bonds (use the stablecoin)
+COLLATERAL_TOKEN_ADDRESS=0x...
+BOND_TOKEN_ADDRESS=0x...
+
+# Testnet helper scripts
+ORACLE_ADDRESS_TESTNET=0x...
+MARKET_FACTORY_ADDRESS_TESTNET=0x...
+COLLATERAL_VAULT_ADDRESS_TESTNET=0x...
+STABLECOIN_ADDRESS_TESTNET=0x...
+USDC_ADDRESS_TESTNET=0x...
+
+# Oracle feeder bot
+ORACLE_ADDRESS=0x...
+WALLET_ADDRESS=0x...
+PRIVATE_KEY=0x...

.github/workflows/ci.yml

@@ -29,19 +29,8 @@ jobs:
         with:
           scarb-version: "2.8.0"
 
-      - name: Setup Starknet Foundry (snforge)
-        uses: foundry-rs/setup-snfoundry@v4
-
       - name: Show tool versions
-        run: |
-          scarb --version
-          snforge --version
+        run: scarb --version
 
       - name: Build
         run: scarb build
-
-      - name: Test
-        run: snforge test
-
-      - name: Format check
-        run: scarb fmt --check

.gitignore

@@ -0,0 +1,64 @@
+# OS / Editor
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Env files
+.env
+.env.*
+*.env
+!.env.sample
+!**/.env.sample
+
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+.python-version
+.venv/
+venv/
+env/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.tox/
+.coverage
+coverage.xml
+htmlcov/
+*.egg-info/
+dist/
+build/
+
+# Node / JS
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+.pnpm-store/
+.npm/
+
+# Cairo / Scarb / Starknet
+**/target/
+**/.snforge/
+**/.snfoundry_cache/
+**/.starknet/
+
+# ZK build artifacts
+zk/build/
+zk/**/*.ptau
+zk/**/*.zkey
+zk/**/*.r1cs
+zk/**/*.wasm
+zk/**/*.sym
+zk/**/*.wtns
+zk/**/*.calldata
+zk/cairox/*
+
+
+# Runtime caches / outputs
+oracle-agent/.cache/
+oracle-agent/cache/
+indexer/proofs/
+indexer/commitments/

CONTRIBUTING.md

@@ -1,12 +1,11 @@
-cairox
 # Cairox - Starknet Ecosystem Prediction Protocol
 
 ## Quick Start
 
 ```bash
 # Clone the repository
-git clone https://github.com/YOUR_USERNAME/cairox.git
-cd cairox
+git clone https://github.com/the-axmc/Cairox.git
+cd Cairox
 
 # Install dependencies
 cd contracts
@@ -25,20 +24,25 @@ make deploy-local
 ## Project Structure
 
 ```
-cairox/
-├── contracts/           # Cairo smart contracts (Scarb workspace)
-│   ├── Cargo.toml       # Scarb workspace manifest
+Cairox/
+├── contracts/           # Cairo smart contracts (Scarb package)
+│   ├── Scarb.toml       # Package manifest
 │   ├── src/             # Contract source code
 │   ├── tests/           # Integration tests
-│   └── Snapshots.json   # Test snapshots
-├── oracle-agent/        # Data oracle agent
+│   └── scripts/         # Deployment/helpers
+├── oracle-agent/        # Data oracle agent (Python)
 │   ├── README.md
-│   ├── package.json     # Node.js dependencies
+│   ├── requirements.txt
 │   └── src/             # Oracle implementation
-├── indexer/             # Indexer service (optional)
-│   └── README.md
+├── indexer/             # Indexer service (Python)
+│   ├── README.md
+│   ├── requirements.txt
+│   └── src/
 ├── specs/               # Market specifications (JSON)
 │   └── markets.json
+├── docs/                # Protocol documentation
+├── zk/                  # ZK tooling and circuits
+├── scripts/             # Repo-level utilities
 ├── .github/workflows/   # CI workflows
 │   └── ci.yml
 ├── Makefile             # Build targets
@@ -50,16 +54,22 @@ cairox/
 The Cairox protocol consists of:
 
 1. **MarketFactory** - Creates and manages prediction markets
-2. **ConditionalTokens** - ERC-1155 style outcome tokens
-3. **Resolver** - Oracle for market resolution using growthepie API
-4. **AMM** - Bonding curve market maker
+2. **Market** - Core market logic (mint, redeem, resolve)
+3. **CollateralVault** - Holds collateral deposits
+4. **OutcomeToken** - ERC-1155 style outcome tokens
+5. **Oracle / OptimisticOracle** - Data commitments and proposals
+6. **ResolutionVerifier** - Verifies multi-user resolution claims
+7. **LMSRMarketMaker / LMSRMulti** - Bonding curve pricing
+8. **Arbitration** - Dispute resolution
+9. **LaunchConfig** - Market creation parameters
+10. **PriceOracle / Stablecoin** - Pricing + collateral primitives
 
 ## Tooling
 
 - **Scarb** - Cairo package manager and build tool
 - **Starknet Foundry (snforge)** - Testing framework
 - **Starknet Devnet** - Local development network
-- **Starknet.js** - Frontend SDK
+- **Python** - Oracle agent and indexer services
 
 ## Development