Skip to content

README.md

Latest commit

 

History

History
51 lines (37 loc) · 4.21 KB

README.md

File metadata and controls

51 lines (37 loc) · 4.21 KB
Raw

DIN Protocol Documentation

Documentation for the DIN Protocol DevNet as implemented on the develop branch.

Scope rule: everything in this folder describes what exists in the code on develop — not the live deployment on Optimism Sepolia (which may lag develop), and not planned or proposed designs. Plans, designs, proposals, and process docs live in Developer/. If a change to the code would make a document here wrong, the document belongs here; if it would still be valid, it belongs in Developer/.

Layout

  • public/ — for network participants (validators, clients, model owners). Assumes you operate the network through dincli; never requires reading source code.
  • technical/ — internal documentation for people modifying or auditing the code.

Public documentation

Document Purpose
Getting Started Onboarding guide for Model_0 on the live devnet (sepolia-op-devnet)
What can I train on DIN? DevNet 2.0 model fit, custom services, practical limits, and the path to trying a new task
Explore DIN with your community A short introduction for groups considering a testnet trial
Setup Guide Installing and configuring dincli: venv, wallet, network, logging, demo mode, IPFS
CLI Reference Common dincli reference across all roles
Manifest The per-model manifest.json: metadata, services, contract addresses
Services Service files a model owner must provide (model, client, auditor, aggregator logic)

Role guides — public/roles/

One guide per network role: Clients · Auditors · Aggregators · Model Owners · DIN-Representative (dinrep)

Workflows — public/workflows/

  • DIN Workflow — platform-level contracts and how they relate (deployed once, by the DIN-Representative)
  • Model Workflow — task-contract lifecycle per model: deploy → slasher authorization → genesis model → registration → Global Iterations

Guides — public/guides/

  • Wallet Setup — burner wallet and encrypted keystore setup
  • Keystore Migration — migrating from plaintext .env keys to encrypted keystores
  • IPFS — configuring the IPFS backend (node, Filebase, or custom provider)
  • Client Onboarding — model-owner-to-client onboarding instructions

Technical documentation

Area Contents
technical/ARCHITECTURE.md (not yet written) System architecture reference (first complete draft tracked as P3-DOC1)
contracts/ Per-contract references: DinCoordinator, DinToken, DinValidatorStake, DINModelRegistry, DINTaskCoordinator, DINTaskAuditor, DINShared; Foundry scripts and V2 fixtures (deploy/upgrade scripts, DeploymentsPath)
mechanisms/ Currently implemented protocol mechanisms (e.g. staking)
services/ Reference service internals (e.g. client service)
testing/ dincli testing guide, containerization guide
upgradable-contracts/ Transparent Proxy deployment architecture and upgrade test documentation; Foundry upgradeability reference (deploy, upgrade, validate)
manifest.md Manifest runtime resolution and service loading internals
requirements.md Pinned pip requirements reference