add: transaction handling & zyfi AA

.dockerignore

@@ -0,0 +1,5 @@
+build
+node_modules
+docker-compose.yaml
+Dockerfile
+README.md

.github/actions/setup-repo/action.yml

@@ -0,0 +1,18 @@
+name: Setup repo
+description: Runs all steps to setup the repo (install node_modules, build, etc...)
+inputs:
+  registry-token:
+    description: 'PAT to access registries'
+runs:
+  using: 'composite'
+  steps:
+    - uses: actions/checkout@v3
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v1
+      with:
+        bun-version: latest
+    - name: Install dependencies
+      run: bun install
+      env:
+        SDK_READ_ACCESS_TOKEN: ${{ secrets.SDK_READ_ACCESS_TOKEN }}
+      shell: bash

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: test code quality
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  check-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install dependencies
+        run: bun install
+        env:
+          SDK_READ_ACCESS_TOKEN: ${{ secrets.SDK_READ_ACCESS_TOKEN }}
+      - name: Lint merkl-api codebase
+        run: bun lint:ci

.github/workflows/update_production.yml

@@ -0,0 +1,56 @@
+name: Trigger production deployment
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  tag-image:
+    runs-on: ubuntu-latest
+    env:
+      IMAGE_URL: europe-west1-docker.pkg.dev/angle-artifacts/angle-docker-registry/merkl-app
+    steps:
+      - uses: 'google-github-actions/auth@v0'
+        with:
+          credentials_json: '${{ secrets.GCLOUD_SECRET_ARTIFACTS }}'
+      - name: Login to Docker
+        run: gcloud auth configure-docker europe-west1-docker.pkg.dev
+      - name: Pull and tag image
+        run: |
+          export SHORT_SHA=${GITHUB_SHA:0:7}
+          export VERSION=${GITHUB_REF#refs/tags/}
+          docker pull $IMAGE_URL:$SHORT_SHA
+          docker tag $IMAGE_URL:$SHORT_SHA $IMAGE_URL:$VERSION
+          docker push $IMAGE_URL:$VERSION
+  trigger-production-deployment:
+    runs-on: ubuntu-latest
+    needs: tag-image
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo snap install yq
+      - name: Clone deployments repo
+        uses: actions/checkout@v3
+        with:
+          repository: AngleProtocol/deployments
+          token: ${{ secrets.ACCESS_TOKEN }}
+          path: deployments
+      - name: Modify config.production.yaml and push to deployments
+        run: |
+          cd deployments
+
+          export VERSION=${GITHUB_REF#refs/tags/}
+          yq -i '.merkl-app.version = strenv(VERSION)' ./config.production.yaml
+
+          git config --global user.email "[email protected]"
+          git config --global user.name "BaptistG"
+
+          git add ./config.production.yaml
+          git commit -m "Update config.production.yaml with merkl-app version $VERSION"
+
+          git push

.github/workflows/update_staging.yml

@@ -0,0 +1,68 @@
+name: Build image and trigger staging deployment
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build-image:
+    runs-on: ubuntu-latest
+    env:
+      IMAGE_URL: europe-west1-docker.pkg.dev/angle-artifacts/angle-docker-registry/merkl-app
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          token: '${{ secrets.ACCESS_TOKEN }}'
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - uses: 'google-github-actions/auth@v0'
+        with:
+          credentials_json: '${{ secrets.GCLOUD_SECRET_ARTIFACTS }}'
+      - name: Login to Docker
+        run: gcloud auth configure-docker europe-west1-docker.pkg.dev
+      - name: Build image
+        run: |
+          export SHORT_SHA=${GITHUB_SHA:0:7}
+          docker pull $IMAGE_URL:latest || true
+          docker build --build-arg SDK_READ_ACCESS_TOKEN=${{ secrets.SDK_READ_ACCESS_TOKEN }} --cache-from $IMAGE_URL:latest --tag $IMAGE_URL:$SHORT_SHA --tag $IMAGE_URL:latest .
+      - name: Push image
+        run: |
+          export SHORT_SHA=${GITHUB_SHA:0:7}
+          docker push $IMAGE_URL:$SHORT_SHA
+
+  trigger-staging-deployment:
+    runs-on: ubuntu-latest
+    needs: build-image
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo snap install yq
+      - name: Clone deployments repo
+        uses: actions/checkout@v3
+        with:
+          repository: AngleProtocol/deployments
+          token: ${{ secrets.ACCESS_TOKEN }}
+          path: deployments
+      - name: Modify config.staging.yaml and push to deployments
+        run: |
+          cd deployments
+
+          export SHORT_SHA=${GITHUB_SHA:0:7}
+
+          yq -i '.merkl-app.version = strenv(SHORT_SHA)' ./config.staging.yaml
+
+          git config --global user.email "[email protected]"
+          git config --global user.name "BaptistG"
+
+          git add ./config.staging.yaml
+          git commit -m "Update config.staging.yaml with merkl-app version $SHORT_SHA"
+
+          git push

.gitignore

@@ -3,3 +3,5 @@ node_modules
 /.cache
 /build
 .env
+**/.DS_Store
+.DS_Store

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "libs/dappkit"]
-	path = libs/dappkit
+[submodule "packages/dappkit"]
+	path = packages/dappkit
 	url = https://github.com/AngleProtocol/dappkit

Dockerfile

@@ -0,0 +1,29 @@
+FROM oven/bun:1.1.24-debian
+ARG SDK_READ_ACCESS_TOKEN
+
+RUN apt-get -y update
+RUN apt-get -y install python3 make g++ ca-certificates curl
+
+WORKDIR /app
+
+COPY bunfig.toml .
+COPY package.json .
+COPY packages packages
+COPY bun.lockb .
+RUN bun install
+
+COPY vite.config.ts ./
+COPY merkl.config.ts ./
+COPY tailwind.config.ts ./
+COPY postcss.config.js ./
+
+COPY tsconfig.json ./
+
+COPY src src
+COPY public public
+
+RUN bun run build
+
+EXPOSE 5173
+
+CMD ["bun", "serve"]

LICENSE.md

@@ -0,0 +1,50 @@
+BSD 3-Clause License with Specific Usage Restrictions
+
+Copyright (c) 2024 - Angle Labs, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimers and restrictions in the documentation and/or other materials provided with the distribution.
+- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+DEFINITIONS:
+
+- "Frontend application": A user-facing application that interacts with the original backend via the documented API endpoints.
+- "Original backend application": The Merkl incentive distribution solution as developed and maintained by Angle Labs, Inc, including its associated smart contracts and API endpoints.
+- "Competitive backend services or applications": Any service or application that replicates or provides similar functionality to the Merkl incentive distribution solution.
+
+USAGE RESTRICTIONS:
+
+This Software may ONLY be used for developing an application (frontend, backend or combining both) that directly interfaces with the original backend application.
+
+PROHIBITED USES INCLUDE:
+
+a) Developing standalone applications unrelated to the original backend
+b) Creating competitive backend services or applications
+c) Reverse engineering the core backend logic
+d) Developing alternative backend implementations
+
+COMMERCIAL USE:
+
+Commercial use of this Software, including but not limited to incorporating the Software into paid products or services, requires explicit prior written approval from Angle Labs, Inc. To seek approval for commercial use, please contact [[email protected]]([email protected]). Any unauthorized commercial use is strictly prohibited.
+
+API USAGE:
+
+Use of the API endpoints provided by the original backend application is limited to purposes that directly align with developing and maintaining applications as described in the Usage Restrictions. Unauthorized scraping, bulk data extraction, or any use of the API for unrelated purposes is strictly prohibited.
+
+ENFORCEMENT:
+
+Use of this software in violation of the above conditions will result in an immediate termination of the license. The copyright holder reserves the right to take legal action to protect its intellectual property and enforce these terms.
+
+GOVERNING LAW:
+
+This license shall be governed by and construed in accordance with the laws of France, without regard to its conflict of laws principles.
+
+RESERVATION OF RIGHTS:
+
+All rights not expressly granted under this license are reserved by Angle Labs, Inc.
+
+DISCLAIMER:
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.