diff --git a/README.md b/README.md index 689ae27..7135433 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ agenc-sdk/ ## Public API Families - Proofs and prover wiring: `proofs.ts`, `prover.ts`, `proof-validation.ts` -- Task lifecycle and queries: `tasks.ts`, `queries.ts`, `tokens.ts` +- Task lifecycle, validation flows, and queries: `tasks.ts`, `queries.ts`, `tokens.ts` - Agent, dispute, governance, and protocol helpers: `agents.ts`, `disputes.ts`, `governance.ts`, `protocol.ts`, `state.ts` - Diagnostics and compatibility: `errors.ts`, `logger.ts`, `process-identity.ts`, `version.ts` - Convenience wrapper: `client.ts` @@ -113,6 +113,23 @@ The SDK derives and submits the required verification accounts: - `completeTask(...)` - `completeTaskPrivate(...)` - `completeTaskPrivateWithPreflight(...)` +- `configureTaskValidation(...)` +- `submitTaskResult(...)` +- `acceptTaskResult(...)` +- `rejectTaskResult(...)` +- `autoAcceptTaskResult(...)` +- `validateTaskResult(...)` + +## Task Validation V2 + +The SDK exposes the full reviewed public-task surface introduced by protocol Task Validation V2. + +- `configureTaskValidation(...)` enables creator review, validator quorum, or external attestation on an open public task +- `submitTaskResult(...)` records a reviewed submission without paying out immediately +- `acceptTaskResult(...)`, `rejectTaskResult(...)`, and `autoAcceptTaskResult(...)` resolve creator-review tasks +- `validateTaskResult(...)` records validator-quorum votes and external attestations + +Important: raw SDK `completeTask(...)` still calls on-chain `complete_task` directly. It does not auto-route manual-validation tasks into `submit_task_result`. That auto-routing exists in the runtime wrapper, not in the SDK. ### Preflight validation diff --git a/docs/DOCS_INDEX.md b/docs/DOCS_INDEX.md index 4389114..c66495b 100644 --- a/docs/DOCS_INDEX.md +++ b/docs/DOCS_INDEX.md @@ -19,6 +19,6 @@ This is the developer-documentation entrypoint for `agenc-sdk`. - I need the repo layout: [CODEBASE_MAP.md](./CODEBASE_MAP.md) - I need the exported API families: [MODULE_INDEX.md](./MODULE_INDEX.md) +- I need reviewed task-validation helpers: [MODULE_INDEX.md](./MODULE_INDEX.md) - I need release or CI commands: [MAINTAINER_GUIDE.md](./MAINTAINER_GUIDE.md) - I need a runnable example: [examples/private-task-demo/README.md](../examples/private-task-demo/README.md) - diff --git a/docs/MODULE_INDEX.md b/docs/MODULE_INDEX.md index a4cdd10..c1e91d8 100644 --- a/docs/MODULE_INDEX.md +++ b/docs/MODULE_INDEX.md @@ -15,7 +15,7 @@ Everything else in the repo is support material, tests, examples, or release too - `generateProof`, `computeHashes`, `generateSalt` - `runProofSubmissionPreflight` -- `completeTaskPrivateSafe` +- `completeTaskPrivateWithPreflight`, `completeTaskPrivateSafe` - `ProverConfig`, `RemoteProverConfig`, `ProverError` Use this family for private completion payload construction, prover transport wiring, and client-side safety checks before submission. @@ -23,10 +23,14 @@ Use this family for private completion payload construction, prover transport wi ### Task lifecycle - `createTask`, `createDependentTask`, `claimTask`, `expireClaim` -- `completeTask`, `completeTaskPrivate`, `completeTaskPrivateSafe` +- `completeTask`, `completeTaskPrivate`, `completeTaskPrivateWithPreflight`, `completeTaskPrivateSafe` +- `configureTaskValidation`, `submitTaskResult` +- `acceptTaskResult`, `rejectTaskResult`, `autoAcceptTaskResult`, `validateTaskResult` - `cancelTask`, `getTask`, `getTasksByCreator` - `deriveTaskPda`, `deriveClaimPda`, `deriveEscrowPda` +Use the explicit Task Validation V2 helpers when a task has been configured for review or attestation. The low-level SDK `completeTask` helper still sends `complete_task` directly and does not auto-route reviewed tasks into `submit_task_result`. + ### Queries and replay-oriented reads - `getTasksByDependency`, `getDependentTaskCount`, `getRootTasks` @@ -62,6 +66,5 @@ Use `PrivacyClient` when you want one object to wrap common flows. Use the lower ## Deprecated And Compatibility Notes - `validateProofPreconditions` remains exported as a deprecated alias for `runProofSubmissionPreflight`. -- The canonical safe private-completion helper is `completeTaskPrivateSafe`. +- `completeTaskPrivateSafe` remains exported as a deprecated compatibility wrapper around `completeTaskPrivateWithPreflight`. - Version compatibility state is defined in `src/version.ts` and must stay aligned with `package.json` and released protocol expectations. - diff --git a/src/tasks.ts b/src/tasks.ts index 04d565d..cfb22c1 100644 --- a/src/tasks.ts +++ b/src/tasks.ts @@ -1422,7 +1422,7 @@ export async function configureTaskValidation( } /** - * Submit a worker result for Task Validation V2 creator review. + * Submit a worker result for Task Validation V2 manual validation. */ export async function submitTaskResult( connection: Connection,