Developer reference
SDK Reference
ENTITY's SDK layer is the preferred application boundary. Applications should use SDK/runtime surfaces to request scoped actions rather than directly editing state files or impersonating sovereign identity.
SDK areas
| Area | Use |
|---|---|
sdk/simple_sdk/ | Minimal developer facade for common ENTITY operations. |
sdk/global_passport_sdk/ | Global Passport construction/verification and profile/package workflows. |
| Principal/device/application binding | Separates the producer application from the asset controller and requires explicit binding before canonical ingestion. |
Integration principles
- Keep the Entity identity and application identity separate.
- Request explicit, scoped authorization for mutations.
- Pass rights/evidence/provenance references instead of relying on ambient filesystem/account context.
- Preserve canonical serialization and versioned schemas.
- Return precise verification outcomes rather than a generic “trusted” boolean.
BTDU
BTDU currently exposes an operator CLI and Python runtime under src/40_BTDU. Applications integrating BTDU should keep ENTITY authorization as the mutation gate and treat ADAM/BTDU as state/information infrastructure rather than authority.
Version pinning
Production applications should pin to the supported v3.4.2 release or to a separately qualified subsequent release. Do not depend on moving main for immutable behavior.