Merge pull request #7 from Layr-Labs/epociask--feat-fork-diff

feat: fork diff and refactors

.github/workflows/pages.yml

@@ -0,0 +1,48 @@
+name: Build, publish, & host forkdiff github-pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1000 # make sure to fetch the old commit we diff against
+
+      - name: Build forkdiff
+        uses: 'docker://protolambda/forkdiff:0.1.0'
+        with:
+          args: -repo=/github/workspace -fork=/github/workspace/fork.yaml -out=/github/workspace/index.html
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

fork.yaml

@@ -0,0 +1,69 @@
+title: "layr-labs/eigenda-orbit-sdk"  # Define the HTML page title
+logo: "logo.png"
+footer: |  # define the footer with markdown
+  [orbit-sdk](https://github.com/Layr-Labs/orbit-sdk) fork overview &middot created with [Forkdiff](https://github.com/protolambda/forkdiff)
+base:
+  name: OffchainLabs/orbit-sdk
+  url: https://github.com/OffchainLabs/orbit-sdk
+  hash: 8522dd838fe624422d20d9d2f085d8a29a1f5c4d
+fork:
+  name: Layr-Labs/eigenda-orbit-sdk
+  url: https://github.com/Layr-Labs/eigenda-orbit-sdk
+  ref: refs/heads/epociask--feat-fork-diff
+def:
+    title: "Orbit SDK Fork Overview"
+    description: | # description in markdown
+      The original orbit-sdk codebase can be found at [`github.com/OffchainLabs/orbit-sdk`](https://github.com/OffchainLabs/orbit-sdk).
+      And the fork at [`github.com/Layr-Labs/eigenda-orbit-sdk`](https://github.com/Layr-Labs/eigenda-orbit-sdk).
+
+    sub:
+      - title: "Custom Rollup Creators"
+        description: |
+          Deployed custom rollup creators using eigenda nitro-contracts.
+      
+        globs:
+          - src/contracts/RollupCreator/v2.1.0.ts
+
+      - title: "EigenDA default values"
+        description: |
+          Updated node config default values to use EigenDA. Also updated default deploy params
+          to reflect blob verifier contract.
+          
+        globs:
+          - src/prepareNodeConfig.ts
+          - src/types/NodeConfig.generated.ts
+          - src/types/ChainConfig.ts
+          - src/scripts/generateNodeConfigType.ts
+          - src/prepareChainConfig.unit.test.ts
+          - src/createRollupPrepareDeploymentParamsConfigDefaults.ts
+          - src/createRollupDefaults.ts
+          - src/contracts/SequencerInbox.ts
+
+
+
+      - title: "npm package"
+        description: |
+          Support new NPM package (i.e, `@eigenda/orbit-sdk`) for publishing and downloading
+          SDK artifacts. Updated all existing usage examples with new package references.
+
+        globs:
+          - README.md
+          - src/package.json
+
+
+      - title: "Multiple Batch Posters"
+        description: |
+          Updated the batch poster representation to be an array of addresses. This was done to align
+          with a recent `SequencerInbox` change which allowed for redundant posters using separate private
+          keys.
+
+        globs:
+          - src/getBatchPosters.ts
+          - src/decorators/sequencerInboxActions.integration.test.ts
+          - src/createRollupPrepareTransactionRequest.ts
+          - src/createRollup.integration.test.ts
+
+
+ignore:
+  - examples/**
+  - package.json