Merge pull request #6 from 0KnowledgeNetwork/5-use-local-protokit-framework

build: use local path to @proto-kit dependency

Author: xendarboh

.github/workflows/docker.yml

@@ -21,8 +21,8 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      APPCHAIN_REF: main
       APPCHAIN_REPO: ${{ github.repository_owner }}/appchain
+      PROTOKIT_REPO: ${{ github.repository_owner }}/protokit
       IMAGE: ghcr.io/${{ github.repository_owner }}/appchain-agent
       IMAGE_TEST: zkn/appchain-agent
 
@@ -32,6 +32,12 @@ jobs:
         with:
           path: appchain-agent
 
+      - name: Read dependencies versions
+        run: |
+          source appchain-agent/deps.env
+          echo "APPCHAIN_REF=${APPCHAIN}" >> $GITHUB_ENV
+          echo "PROTOKIT_REF=${PROTOKIT}" >> $GITHUB_ENV
+
       - name: Checkout appchain repository
         uses: actions/checkout@v4
         with:
@@ -40,6 +46,13 @@ jobs:
           repository: ${{ env.APPCHAIN_REPO }}
           ssh-key: ${{ secrets.APPCHAIN_DEPLOY_KEY }}
 
+      - name: Checkout protokit repository
+        uses: actions/checkout@v4
+        with:
+          path: protokit
+          ref: ${{ env.PROTOKIT_REF }}
+          repository: ${{ env.PROTOKIT_REPO }}
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
 
@@ -69,7 +82,7 @@ jobs:
 
       # https://docs.docker.com/build/ci/github-actions/reproducible-builds/
       - name: Set source build date from git commit timestamp
-        run: echo "SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)" >> $GITHUB_ENV
+        run: echo "SOURCE_DATE_EPOCH=$(cd appchain-agent && git log -1 --pretty=%ct)" >> $GITHUB_ENV
 
       - name: Build and export to Docker
         uses: docker/build-push-action@v6
@@ -78,6 +91,7 @@ jobs:
         with:
           build-contexts: |
             context-appchain=./appchain
+            context-protokit=./protokit
           cache-from: type=gha
           cache-to: type=gha,mode=max
           context: ./appchain-agent
@@ -92,6 +106,7 @@ jobs:
         with:
           build-contexts: |
             context-appchain=./appchain
+            context-protokit=./protokit
           context: ./appchain-agent
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -12,13 +12,22 @@ FROM base AS builder
 
 COPY package.json pnpm-lock.yaml ./
 
+COPY --from=context-protokit / /app/protokit
+RUN --mount=type=cache,id=npm,target=/root/.npm \
+  cd /app/protokit \
+  && npm set cache /root/.npm \
+  && npm ci \
+  && npm run build
+
 COPY --from=context-appchain / /app/appchain
 RUN --mount=type=cache,id=pnpm,target=${PNPM_HOME}/store \
   cd /app/appchain/packages/chain \
   && pnpm install --frozen-lockfile \
   && pnpm build
 
-RUN --mount=type=cache,id=pnpm,target=${PNPM_HOME}/store pnpm install --frozen-lockfile
+RUN --mount=type=cache,id=pnpm,target=${PNPM_HOME}/store \
+  cd /app/appchain-agent \
+  && pnpm install --frozen-lockfile
 
 COPY . .
 RUN pnpm run build
@@ -35,8 +44,6 @@ RUN apk add --no-cache \
 COPY --from=builder /app/appchain/packages/chain/dist /app/appchain/packages/chain/dist
 COPY --from=builder /app/appchain/packages/chain/package.json /app/appchain/packages/chain/
 COPY --from=builder /app/appchain/package.json /app/appchain/pnpm-lock.yaml /app/appchain/
-RUN --mount=type=cache,id=pnpm,target=${PNPM_HOME}/store cd /app/appchain && pnpm install --prod --frozen-lockfile
-
 COPY --from=builder /app/appchain-agent/dist ./dist
 COPY --from=builder /app/appchain-agent/package.json /app/appchain-agent/pnpm-lock.yaml ./
 RUN --mount=type=cache,id=pnpm,target=${PNPM_HOME}/store pnpm install --prod --frozen-lockfile

Makefile

@@ -4,6 +4,7 @@ docker_image ?= zkn/agent:latest
 image:
 	docker build \
 		--build-context context-appchain=../appchain \
+		--build-context context-protokit=../protokit \
 		--file Dockerfile \
 		--tag $(docker_image) \
 		.

README.md

@@ -12,20 +12,53 @@ with the data's Content Identifier indexed within the appchain.
 
 ## Installation
 
-Place this repo next to the `appchain` monorepo.
+This project uses local `file:` references to 0KN's
+[appchain](https://github.com/0KnowledgeNetwork/appchain) and
+[protokit](https://github.com/0KnowledgeNetwork/protokit).
+
+Place the projects in the same directory and ensure alignment of their git refs:
 
 ```
 .
 ├── appchain/
-└── appchain-agent/
+├── appchain-agent/
+└── protokit/
 ```
 
 Refer to appchain requirements including Node.js version.
 
-Install dependencies:
+### Build Deps & Start Appchain
 
 ```sh
+cd protokit
+npm install
+npm run build
+
+
+cd ../appchain
+pnpm install
+
+# build appchain for appchain-agent
+pnpm run build --filter=chain
+
+# run appchain sequencer, for example
+pnpm env:inmemory dev --filter chain -- --logLevel DEBUG
+
+
+cd ../appchain-agent
 pnpm install
+pnpm run build
+```
+
+## Development
+
+Set `appchain` and `protokit` versions within [deps.env](deps.env) for the
+working branch so that automated workflows use the correct dependency verions.
+For example, for an `appchain-agent` `release/0.1` branch:
+
+```env
+APPCHAIN=release/0.1
+PROTOKIT=zkn/release/0.1
 ```
 
 ## Usage

deps.env

@@ -0,0 +1,2 @@
+APPCHAIN=main
+PROTOKIT=zkn/main

package.json

@@ -36,5 +36,21 @@
     "multiformats": "13.2.2",
     "o1js": "1.6.0"
   },
+  "resolutions": {
+    "@proto-kit/api": "*",
+    "@proto-kit/common": "*",
+    "@proto-kit/deployment": "*",
+    "@proto-kit/library": "*",
+    "@proto-kit/module": "*",
+    "@proto-kit/persistance": "*",
+    "@proto-kit/protocol": "*",
+    "@proto-kit/sdk": "*",
+    "@proto-kit/sequencer": "*"
+  },
+  "pnpm": {
+    "overrides": {
+      "react-native": "never"
+    }
+  },
   "packageManager": "[email protected]+sha512.dc09430156b427f5ecfc79888899e1c39d2d690f004be70e05230b72cb173d96839587545d09429b55ac3c429c801b4dc3c0e002f653830a420fa2dd4e3cf9cf"
 }