The protocol source and its supporting developer stack span a small set of repositories. Use this page to understand where the agreement data standard, EVM execution engine, and TypeScript API client live.Documentation Index
Fetch the complete documentation index at: https://docs.shodai.network/llms.txt
Use this file to discover all available pages before exploring further.
Repository map
| Repository | Owns | Use it when |
|---|---|---|
| CNSLabs/agreements-standard | The agreement data standard, source diagrams, and examples that describe protocol semantics. | You are working on the canonical agreement JSON shape, agreement examples, or standard-level diagrams. |
| CNSLabs/agreements-protocol-evm | The EVM/onchain execution engine, Solidity contracts, execution tests, deployment artifacts, and the SDK in agreements-protocol-evm/sdk. The SDK is published as @cns-labs/agreements-protocol-evm. | You are working on AgreementFactory, AgreementEngine, input payload encoding, contract deployments, or direct execution-engine SDK behavior. |
| CNSLabs/agreements-api-sdk | The published Agreements API TypeScript client package, @cns-labs/agreements-api-client, and the agreements-api-playground sample application. | You are working on typed API methods, signing helpers, path helpers, diagnostics, package publishing, or the sample API playground. |
How the repositories fit together
The data standard defines protocol semantics and the agreement definition. The EVM repository provides the first concrete execution engine. The API SDK makes the hosted API usable from TypeScript application code. The API remains an application layer around the protocol, not part of the protocol semantics.| System layer | Primary repository |
|---|---|
| Definition and protocol semantics | CNSLabs/agreements-standard |
| Onchain execution engine | CNSLabs/agreements-protocol-evm |
| API client integration | CNSLabs/agreements-api-sdk |
| Supporting API / application layer | Hosted API and product services. Use Agreements API and the API Reference group in the sidebar. |
https://developers.shodai.network/api-playground is powered by both npm packages: @cns-labs/agreements-api-client for API calls and @cns-labs/agreements-protocol-evm for onchain agreement interactions.