Skip to content

Provider Storage Protocol

Provides scoped KV records and blob objects for provider-owned state.

Provider Storage Protocol

Provides scoped KV records and blob objects for provider-owned state.

FieldValue
Protocol IDaster.provider-storage
Version1.1.0
Compatibility range^1.1.0
Requirement helperaster.provider-storage.require(settings?) via the protocol module
Provider helperAvailable through Protocol.provide(...).

Settings

DefaultProtocolSettingsSchema (Record<string, unknown> | null).

Operations

OperationSummaryRequestResponse
kvGetRead one provider-scoped KV record.Effect Schema (Objects)Effect Schema (Union)
kvSetWrite one provider-scoped KV record.Effect Schema (Objects)Effect Schema (Void)
kvDeleteDelete one provider-scoped KV record.Effect Schema (Objects)Effect Schema (Void)
kvListList provider-scoped KV records by optional key prefix.Effect Schema (Objects)Effect Schema (Arrays)
blobPutWrite provider-scoped blob content into the object store.Effect Schema (Objects)Effect Schema (Objects)
blobGetRead provider-scoped blob content from the object store.Effect Schema (Objects)Effect Schema (Union)
blobPutBytesWrite exact provider-scoped binary blob bytes.Effect Schema (Objects)Effect Schema (Objects)
blobGetBytesRead exact provider-scoped binary blob bytes.Effect Schema (Objects)Effect Schema (Union)

Conformance Expectations

  • Register with aster.provider-storage at 1.1.0 inside ^1.1.0.
  • Implement every operation: kvGet, kvSet, kvDelete, kvList, blobPut, blobGet, blobPutBytes, blobGetBytes.
  • Decode requests and responses against the operation schemas listed above.
  • Run the protocol conformance kit where one exists: No named kit yet; providers are still expected to satisfy the registry schemas..

Declared Authority

None declared. This protocol grants no authority by itself.