README.md

METHOD

Open index compiler network for the SoSoValue ecosystem.

Creators define deterministic crypto-index methodologies, compile them against evidence-backed SoSoValue data, operate live shadow indexes, collect non-custodial capital intent, obtain independent compiler consensus, execute explicitly approved SoDEX Spot testnet rebalances, and export SSI-compatible graduation packages.

METHOD does not issue official SSI tokens, custody user funds, or promise returns.

Source of truth

• Product: docs/PRD.md
• Design: docs/DESIGN.md
• Architecture: docs/ARCHITECTURE.md
• Security: docs/SECURITY.md

Monorepo

apps/web            Next.js product (Bento design system)
apps/api            Hono API /api/v1
apps/worker         BullMQ / local scheduler
apps/compiler-node  method-compiler CLI
packages/*          Shared libraries
contracts/          Foundry Solidity (ValueChain)

Quick start

pnpm install
pnpm --filter @method/shared build
pnpm --filter @method/canonical-json build
pnpm --filter @method/methodology-schema build
pnpm --filter @method/compiler build
pnpm test
pnpm contracts:test

# API + web (separate terminals)
pnpm --filter @method/api dev
pnpm --filter @method/web dev

Copy .env.example to .env and fill credentials when available.

Contracts

cd contracts
forge test
forge script script/Deploy.s.sol --rpc-url $VALUECHAIN_RPC_URL --broadcast

Compiler node

export COMPILER_NODE_API_URL=http://localhost:4000
export COMPILER_OPERATOR_ADDRESS=0x...
pnpm --filter @method/compiler-node dev compile <round-id>

Environment blockers

Variable	Purpose
SOSOVALUE_API_KEY	Live market data
SODEX_API_KEY_* + SODEX_EXECUTION_ENABLED	Live Spot orders
VALUECHAIN_RELAYER_PRIVATE_KEY	On-chain relays
DATABASE_URL / REDIS_URL	Persistence & queues
ADMIN_WALLET_ADDRESSES	Admin authorization

Missing credentials never produce fabricated production responses. Fixture tests cover offline paths.

License

Licensed under the MIT License.