fix(sdk): use correct controller during stream creation

Author: smrz2001

sdk/packages/model-instance-client/src/client.ts

@@ -28,8 +28,8 @@ import type { DocumentState, UnknownContent } from './types.js'
 export type CreateSingletonParams = {
   /** The model's stream ID */
   model: StreamID
-  /** The controller of the stream (DID string or literal string) */
-  controller: DIDString | string
+  /** The controller of the stream */
+  controller: DID
   /** A unique value to ensure determinism of the event */
   uniqueValue?: Uint8Array
 }

sdk/packages/model-instance-client/src/events.ts

@@ -12,7 +12,6 @@ import {
   type EncodedDeterministicInitEventPayload,
   type JSONPatchOperation,
 } from '@ceramic-sdk/model-instance-protocol'
-import type { DIDString } from '@didtools/codecs'
 import type { DID } from 'dids'
 import type { CID } from 'multiformats/cid'
 
@@ -57,7 +56,7 @@ export async function createInitEvent<
   const { content, controller, ...headerParams } = params
   const header = createInitHeader({
     ...headerParams,
-    controller: controller.id,
+    controller,
     unique: false, // non-deterministic event
   })
   return await createSignedInitEvent(controller, content, header)
@@ -77,7 +76,7 @@ export async function createInitEvent<
  */
 export function getDeterministicInitEventPayload(
   model: StreamID,
-  controller: DIDString | string,
+  controller: DID,
   uniqueValue?: Uint8Array,
 ): DeterministicInitEventPayload {
   return {
@@ -100,7 +99,7 @@ export function getDeterministicInitEventPayload(
  */
 export function getDeterministicInitEvent(
   model: StreamID,
-  controller: DIDString | string,
+  controller: DID,
   uniqueValue?: Uint8Array,
 ): EncodedDeterministicInitEventPayload {
   const { header } = getDeterministicInitEventPayload(

sdk/packages/model-instance-client/src/utils.ts

@@ -3,7 +3,8 @@ import {
   DocumentInitEventHeader,
   type JSONPatchOperation,
 } from '@ceramic-sdk/model-instance-protocol'
-import { type DIDString, asDIDString } from '@didtools/codecs'
+import { asDIDString } from '@didtools/codecs'
+import type { DID } from 'dids'
 import jsonpatch from 'fast-json-patch'
 import type { CID } from 'multiformats/cid'
 
@@ -38,8 +39,8 @@ export type CreateInitHeaderParams = {
   /** CID of specific model version to use when validating this instance.
    * When empty the the init commit of the model is used */
   modelVersion?: CID
-  /** The DID string or literal string representing the controller of the document. */
-  controller: DIDString | string
+  /** The controller of the document. */
+  controller: DID
   /** A unique value to ensure determinism, or a boolean to indicate uniqueness type. */
   unique?: Uint8Array | boolean
   /** Optional context for the document. */
@@ -68,8 +69,9 @@ export type CreateInitHeaderParams = {
 export function createInitHeader(
   params: CreateInitHeaderParams,
 ): DocumentInitEventHeader {
+  const did = params.controller.hasParent ? params.controller.parent : params.controller.id
   const header: DocumentInitEventHeader = {
-    controllers: [asDIDString(params.controller)],
+    controllers: [asDIDString(did)],
     model: params.model,
     sep: 'model',
   }

tests/suite/src/__tests__/correctness/fast/model-mid-singleType.test.ts

@@ -78,7 +78,7 @@ describe('model integration test for single model and MID', () => {
     })
     const documentStream = await modelInstanceClient.createSingleton({
       model: modelStream,
-      controller: authenticatedDID.id,
+      controller: authenticatedDID,
     })
 
     // Use the flightsql stream behavior to ensure the events states have been process before querying their states.
@@ -97,7 +97,7 @@ describe('model integration test for single model and MID', () => {
     })
     const documentStream = await modelInstanceClient.createSingleton({
       model: modelStream,
-      controller: authenticatedDID.id,
+      controller: authenticatedDID,
     })
     // Use the flightsql stream behavior to ensure the events states have been process before querying their states.
     await waitForEventState(flightClient, documentStream.commit)
@@ -117,11 +117,11 @@ describe('model integration test for single model and MID', () => {
     })
     const documentStream1 = await modelInstanceClient.createSingleton({
       model: modelStream,
-      controller: authenticatedDID.id,
+      controller: authenticatedDID,
     })
     const documentStream2 = await modelInstanceClient.createSingleton({
       model: modelStream,
-      controller: authenticatedDID.id,
+      controller: authenticatedDID,
     })
     expect(documentStream1.baseID).toEqual(documentStream2.baseID)
   })
@@ -138,11 +138,11 @@ describe('model integration test for single model and MID', () => {
     })
     const documentStream1 = await modelInstanceClient1.createSingleton({
       model: modelStream,
-      controller: authenticatedDID1.id,
+      controller: authenticatedDID1,
     })
     const documentStream2 = await modelInstanceClient2.createSingleton({
       model: modelStream,
-      controller: authenticatedDID2.id,
+      controller: authenticatedDID2,
     })
     expect(documentStream1.baseID).not.toEqual(documentStream2.baseID)
   })