ceramicnetwork · PaulLeCam · Sep 24, 2024 · Sep 25, 2024 · Sep 25, 2024 · Sep 25, 2024
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -3,8 +3,12 @@ on:
   push:
     branches: ["main"]
   pull_request:
+
 env:
+  C1_REGISTRY: "public.ecr.aws/r5b3e0r5/3box/ceramic-one"
+  C1_VERSION: "0.37.0"
   CI: true
+
 jobs:
   test:
     name: Run integration tests
@@ -32,8 +36,8 @@ jobs:
         run: |
           echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
         with:
           path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
           key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
@@ -42,5 +46,20 @@ jobs:
       - name: Install dependencies and build
         run: pnpm install --frozen-lockfile
 
+      - name: Restore C1 Docker image if it exists
+        id: cache-docker-c1
+        uses: actions/cache@v4
+        with:
+          path: ci/cache/docker/c1
+          key: cache-docker-c1-${{ env.C1_VERSION }}
+
+      - name: Update C1 Docker image if cache miss
+        if: steps.cache-docker-c1.outputs.cache-hit != 'true'
+        run: docker pull ${{ env.C1_REGISTRY }}:${{ env.C1_VERSION }} && mkdir -p ci/cache/docker/c1 && docker image save ${{ env.C1_REGISTRY }}:${{ env.C1_VERSION }} --output ./ci/cache/docker/c1/${{ env.C1_VERSION }}.tar
+
+      - name: Use C1 Docker image if cache hit
+        if: steps.cache-docker-c1.outputs.cache-hit == 'true'
+        run: docker image load --input ./ci/cache/docker/c1/${{ env.C1_VERSION }}.tar
+
       - name: Test
         run: cd tests/c1-integration && pnpm run test
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ TypeScript client and utilities for [Ceramic One](https://github.com/ceramicnetw
 | [model-client](./packages/model-client)                       | Model streams client                         | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-client.svg)            |
 | [model-instance-protocol](./packages/model-instance-protocol) | ModelInstanceDocument streams protocol       | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-instance-protocol.svg) |
 | [model-instance-client](./packages/model-instance-client)     | ModelInstanceDocument streams client         | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/model-instance-client.svg)   |
+| [stream-client](./packages/stream-client)                     | Generic streams client                       | ![npm version](https://img.shields.io/npm/v/@ceramic-sdk/stream-client.svg)           |
 
 Other packages present in the `packages` folder are for internal use and may not be published to the npm registry.
 

diff --git a/apps/explorer/package.json b/apps/explorer/package.json
@@ -22,26 +22,26 @@
     "@mantine/hooks": "^7.12.2",
     "@tabler/icons-react": "^3.17.0",
     "@tanstack/react-query": "^5.56.2",
-    "@tanstack/react-router": "^1.58.3",
+    "@tanstack/react-router": "^1.58.9",
     "codeco": "^1.4.3",
-    "jotai": "^2.9.2",
+    "jotai": "^2.10.0",
     "multiformats": "^13.3.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
     "@ceramic-sdk/model-client": "workspace:^",
     "@ceramic-sdk/model-instance-client": "workspace:^",
-    "@tanstack/router-devtools": "^1.58.3",
+    "@tanstack/router-devtools": "^1.58.9",
     "@tanstack/router-plugin": "^1.58.4",
-    "@types/react": "^18.3.7",
+    "@types/react": "^18.3.9",
     "@types/react-dom": "^18.3.0",
     "@vitejs/plugin-react-swc": "^3.5.0",
     "postcss": "^8.4.47",
     "postcss-preset-mantine": "^1.17.0",
     "postcss-simple-vars": "^7.0.1",
     "ts-essentials": "^10.0.2",
     "typescript": "^5.6.2",
-    "vite": "^5.4.6"
+    "vite": "^5.4.8"
   }
 }
diff --git a/docs/@ceramic-sdk/events/functions/assertSignedEvent.md b/docs/@ceramic-sdk/events/functions/assertSignedEvent.md
@@ -17,7 +17,3 @@ Assert the provided `input` is a SignedEvent
 ## Returns
 
 `asserts input is MapIn<RequiredProps<Object>, $TypeOf> & MapIn<OptionalProps<Object>, $TypeOf>`
-
-## Defined in
-
-[packages/events/src/codecs.ts:70](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L70)
diff --git a/docs/@ceramic-sdk/events/functions/assertTimeEvent.md b/docs/@ceramic-sdk/events/functions/assertTimeEvent.md
@@ -17,7 +17,3 @@ Assert the provided `input` is a TimeEvent
 ## Returns
 
 `asserts input is MapIn<Object, $TypeOf>`
-
-## Defined in
-
-[packages/events/src/codecs.ts:94](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L94)
diff --git a/docs/@ceramic-sdk/events/functions/carFromString.md b/docs/@ceramic-sdk/events/functions/carFromString.md
@@ -19,7 +19,3 @@ Decode a CAR from a string, using the given base (defaults to base64)
 ## Returns
 
 `CAR`
-
-## Defined in
-
-[packages/events/src/encoding.ts:30](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L30)
diff --git a/docs/@ceramic-sdk/events/functions/carToString.md b/docs/@ceramic-sdk/events/functions/carToString.md
@@ -19,7 +19,3 @@ Encode a CAR into a string, using the given base (defaults to base64)
 ## Returns
 
 `string`
-
-## Defined in
-
-[packages/events/src/encoding.ts:25](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L25)
diff --git a/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md b/docs/@ceramic-sdk/events/functions/createSignedInitEvent.md
@@ -27,7 +27,3 @@ Create a signed init event using the provided DID, data and header
 ## Returns
 
 `Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\>
-
-## Defined in
-
-[packages/events/src/signing.ts:33](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L33)
diff --git a/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md b/docs/@ceramic-sdk/events/functions/decodeSignedEvent.md
@@ -17,7 +17,3 @@ Decode the provided `input` as a SignedEvent. Throws if decoding fails.
 ## Returns
 
 [`SignedEvent`](../type-aliases/SignedEvent.md)
-
-## Defined in
-
-[packages/events/src/codecs.ts:65](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L65)
diff --git a/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md b/docs/@ceramic-sdk/events/functions/decodeTimeEvent.md
@@ -17,7 +17,3 @@ Decode the provided `input` as a TimeEvent. Throws if decoding fails.
 ## Returns
 
 [`TimeEvent`](../type-aliases/TimeEvent.md)
-
-## Defined in
-
-[packages/events/src/codecs.ts:89](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L89)
diff --git a/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md b/docs/@ceramic-sdk/events/functions/encodeEventToCAR.md
@@ -19,7 +19,3 @@ Encode an unsigned event into a CAR using the provided codec
 ## Returns
 
 `CAR`
-
-## Defined in
-
-[packages/events/src/encoding.ts:72](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L72)
diff --git a/docs/@ceramic-sdk/events/functions/eventFromCAR.md b/docs/@ceramic-sdk/events/functions/eventFromCAR.md
@@ -25,7 +25,3 @@ Decode an event from a string using the provided codec for unsigned events
 ## Returns
 
 [`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload`
-
-## Defined in
-
-[packages/events/src/encoding.ts:98](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L98)
diff --git a/docs/@ceramic-sdk/events/functions/eventFromString.md b/docs/@ceramic-sdk/events/functions/eventFromString.md
@@ -25,7 +25,3 @@ Decode an event from a string using the provided codec for unsigned events and t
 ## Returns
 
 [`SignedEvent`](../type-aliases/SignedEvent.md) \| `Payload`
-
-## Defined in
-
-[packages/events/src/encoding.ts:128](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L128)
diff --git a/docs/@ceramic-sdk/events/functions/eventToCAR.md b/docs/@ceramic-sdk/events/functions/eventToCAR.md
@@ -19,7 +19,3 @@ Encode an event into a CAR using the provided codec for unsigned events
 ## Returns
 
 `CAR`
-
-## Defined in
-
-[packages/events/src/encoding.ts:82](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L82)
diff --git a/docs/@ceramic-sdk/events/functions/eventToContainer.md b/docs/@ceramic-sdk/events/functions/eventToContainer.md
@@ -25,7 +25,3 @@ Decode a Ceramic event into a container using the provided verifier DID and payl
 ## Returns
 
 `Promise`\<[`EventContainer`](../type-aliases/EventContainer.md)\<`Payload`\>\>
-
-## Defined in
-
-[packages/events/src/container.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L54)
diff --git a/docs/@ceramic-sdk/events/functions/eventToString.md b/docs/@ceramic-sdk/events/functions/eventToString.md
@@ -21,7 +21,3 @@ Encode an event into a string using the provided codec for unsigned events and t
 ## Returns
 
 `string`
-
-## Defined in
-
-[packages/events/src/encoding.ts:89](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L89)
diff --git a/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md b/docs/@ceramic-sdk/events/functions/getSignedEventPayload.md
@@ -23,7 +23,3 @@ Decode the payload of a signed event using the provided decoder
 ## Returns
 
 `Promise`\<`Payload`\>
-
-## Defined in
-
-[packages/events/src/signing.ts:53](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L53)
diff --git a/docs/@ceramic-sdk/events/functions/signEvent.md b/docs/@ceramic-sdk/events/functions/signEvent.md
@@ -21,7 +21,3 @@ Sign an event payload using the provided DID
 ## Returns
 
 `Promise`\<[`SignedEvent`](../type-aliases/SignedEvent.md)\>
-
-## Defined in
-
-[packages/events/src/signing.ts:15](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L15)
diff --git a/docs/@ceramic-sdk/events/functions/signedEventToCAR.md b/docs/@ceramic-sdk/events/functions/signedEventToCAR.md
@@ -17,7 +17,3 @@ Encode a signed event into a CAR
 ## Returns
 
 `CAR`
-
-## Defined in
-
-[packages/events/src/encoding.ts:39](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/encoding.ts#L39)
diff --git a/docs/@ceramic-sdk/events/functions/signedEventToContainer.md b/docs/@ceramic-sdk/events/functions/signedEventToContainer.md
@@ -25,7 +25,3 @@ Decode a signed Ceramic event into a container using the provided verifier DID a
 ## Returns
 
 `Promise`\<[`SignedEventContainer`](../type-aliases/SignedEventContainer.md)\<`Payload`\>\>
-
-## Defined in
-
-[packages/events/src/container.ts:37](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L37)
diff --git a/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md b/docs/@ceramic-sdk/events/functions/unsignedEventToContainer.md
@@ -23,7 +23,3 @@ Decode an unsigned Ceramic event into a container using the provided payload dec
 ## Returns
 
 [`UnsignedEventContainer`](../type-aliases/UnsignedEventContainer.md)\<`Payload`\>
-
-## Defined in
-
-[packages/events/src/container.ts:29](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L29)
diff --git a/docs/@ceramic-sdk/events/type-aliases/EventContainer.md b/docs/@ceramic-sdk/events/type-aliases/EventContainer.md
@@ -13,7 +13,3 @@ Container for a Ceramic event, providing additional metadata about the event
 ## Type Parameters
 
 • **Payload**
-
-## Defined in
-
-[packages/events/src/container.ts:24](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L24)
diff --git a/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md b/docs/@ceramic-sdk/events/type-aliases/InitEventHeader.md
@@ -7,7 +7,3 @@
 # Type Alias: InitEventHeader
 
 > **InitEventHeader**: `TypeOf`\<*typeof* [`InitEventHeader`](../variables/InitEventHeader.md)\>
-
-## Defined in
-
-[packages/events/src/codecs.ts:27](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L27)
diff --git a/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md b/docs/@ceramic-sdk/events/type-aliases/InitEventPayload.md
@@ -21,7 +21,3 @@
 ### header
 
 > **header**: [`InitEventHeader`](InitEventHeader.md)
-
-## Defined in
-
-[packages/events/src/codecs.ts:41](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L41)
diff --git a/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md b/docs/@ceramic-sdk/events/type-aliases/PartialInitEventHeader.md
@@ -13,7 +13,3 @@
 ### controllers?
 
 > `optional` **controllers**: [`DIDString`]
-
-## Defined in
-
-[packages/events/src/signing.ts:28](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/signing.ts#L28)
diff --git a/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md b/docs/@ceramic-sdk/events/type-aliases/SignedEvent.md
@@ -7,7 +7,3 @@
 # Type Alias: SignedEvent
 
 > **SignedEvent**: `TypeOf`\<*typeof* [`SignedEvent`](../variables/SignedEvent.md)\>
-
-## Defined in
-
-[packages/events/src/codecs.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L54)
diff --git a/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md b/docs/@ceramic-sdk/events/type-aliases/SignedEventContainer.md
@@ -35,7 +35,3 @@ Container for a signed Ceramic event
 ### verified
 
 > **verified**: `VerifyJWSResult`
-
-## Defined in
-
-[packages/events/src/container.ts:9](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L9)
diff --git a/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md b/docs/@ceramic-sdk/events/type-aliases/TimeEvent.md
@@ -7,7 +7,3 @@
 # Type Alias: TimeEvent
 
 > **TimeEvent**: `TypeOf`\<*typeof* [`TimeEvent`](../variables/TimeEvent.md)\>
-
-## Defined in
-
-[packages/events/src/codecs.ts:77](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L77)
diff --git a/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md b/docs/@ceramic-sdk/events/type-aliases/UnsignedEventContainer.md
@@ -23,7 +23,3 @@ Container for an unsigned Ceramic event
 ### signed
 
 > **signed**: `false`
-
-## Defined in
-
-[packages/events/src/container.ts:18](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/container.ts#L18)
diff --git a/docs/@ceramic-sdk/events/variables/InitEventHeader.md b/docs/@ceramic-sdk/events/variables/InitEventHeader.md
@@ -14,15 +14,15 @@ Header structure of Init events
 
 ### context
 
-> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\>
+> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\>
 
 ### controllers
 
 > **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\>
 
 ### model
 
-> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes`
+> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes`
 
 ### sep
 
@@ -35,7 +35,3 @@ Header structure of Init events
 ### unique
 
 > **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\>
-
-## Defined in
-
-[packages/events/src/codecs.ts:27](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L27)
diff --git a/docs/@ceramic-sdk/events/variables/InitEventPayload.md b/docs/@ceramic-sdk/events/variables/InitEventPayload.md
@@ -24,15 +24,15 @@ Payload structure of Init events
 
 ##### context
 
-> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\>\>
+> **context**: `OptionalCodec`\<`Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\>\>
 
 ##### controllers
 
 > **controllers**: `TupleCodec`\<[`RefinementCodec`\<`TrivialCodec`\<`string`\>, `string` & `WithOpaque`\<`"DIDString"`\>\>]\>
 
 ##### model
 
-> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, `Uint8Array`\> = `streamIDAsBytes`
+> **model**: `Type`\<[`StreamID`](../../identifiers/classes/StreamID.md), `Uint8Array`, [`StreamID`](../../identifiers/classes/StreamID.md) \| `Uint8Array`\> = `streamIDAsBytes`
 
 ##### sep
 
@@ -45,7 +45,3 @@ Payload structure of Init events
 ##### unique
 
 > **unique**: `OptionalCodec`\<`TrivialCodec`\<`Uint8Array`\>\>
-
-## Defined in
-
-[packages/events/src/codecs.ts:41](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L41)
diff --git a/docs/@ceramic-sdk/events/variables/SignedEvent.md b/docs/@ceramic-sdk/events/variables/SignedEvent.md
@@ -37,7 +37,3 @@ Signed event structure - equivalent to DagJWSResult in `dids` package
 ### linkedBlock
 
 > **linkedBlock**: `TrivialCodec`\<`Uint8Array`\> = `uint8array`
-
-## Defined in
-
-[packages/events/src/codecs.ts:54](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L54)
diff --git a/docs/@ceramic-sdk/events/variables/TimeEvent.md b/docs/@ceramic-sdk/events/variables/TimeEvent.md
@@ -9,7 +9,3 @@
 > `const` **TimeEvent**: `ExactCodec`\<`TypeCodec`\<`object`\>\>
 
 Time event structure
-
-## Defined in
-
-[packages/events/src/codecs.ts:77](https://github.com/ceramicstudio/ceramic-sdk/blob/a220cbca7950f690af7f3d03a0023681bb9f5426/packages/events/src/codecs.ts#L77)