chore: scaffolding

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.github/actions/use-algokit/action.yml

@@ -0,0 +1,43 @@
+name: "Use AlgoKit"
+
+description: "Checks if the dependencies have been cached with the hash of the package-lock.json file."
+
+inputs:
+  algokit_version:
+    description: "The version of AlgoKit to install"
+    required: false
+    default: "latest"
+
+runs:
+  using: "composite"
+  steps:
+    - name: "🔑 Set up cache key"
+      id: cache-key
+      run: echo "CACHE_KEY=algokit-${{ inputs.algokit_version }}-$(python --version | cut -d' ' -f2)" >> $GITHUB_ENV
+      shell: bash
+    - name: "💾 Cache dependencies"
+      id: algokit-cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ env.CACHE_KEY }}
+        restore-keys: |
+          ${{ runner.os }}-algokit-${{ inputs.algokit_version }}
+          ${{ runner.os }}-algokit-
+          ${{ runner.os }}-
+    - name: "🔧 Setup"
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'
+    - name: "📤 Upgrade pip"
+      run: python -m pip install --upgrade pip
+      shell: bash
+    - name: "📦 Install"
+      if: steps.algokit-cache.outputs.cache-hit != 'true'
+      run: |
+        if [ "${{ inputs.algokit_version }}" = "latest" ]; then
+          pip install algokit  # Install the latest version
+        else
+          pip install algokit==${{ inputs.algokit_version }}
+        fi
+      shell: bash

.github/actions/use-npm-dependencies/action.yml

@@ -0,0 +1,27 @@
+name: "Use npm Dependencies"
+
+description: "Checks if the npm dependencies have been cached with the hash of the package-lock.json file."
+
+runs:
+  using: "composite"
+  steps:
+    - name: "🔧 Setup"
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.18.0'
+    - name: "💾 Cache dependencies"
+      uses: actions/cache@v4
+      id: npm-cache
+      with:
+        path: |
+          node_modules
+          ~/.cache/Cypress
+        key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+          ${{ runner.os }}-npm-
+          ${{ runner.os }}-
+    - name: "📦 Install"
+      if: steps.npm-cache.outputs.cache-hit != 'true'
+      run: npm install
+      shell: bash

.github/pull_request_template.md

@@ -0,0 +1,23 @@
+<!--
+The title should summarise the purpose of this change.
+
+⚠️**NOTE:** The title must conform to the conventional commit message format outlined in CONTRIBUTING.md document, at the root of the project. This is to ensure the merge commit to the main branch is picked up by the CI and creates an entry in the CHANGELOG.md.
+-->
+
+# Description
+<!-- Describe your changes in detail -->
+
+# Type of change
+<!-- What type of change does this change introduce? Put an 'x' in all the boxes that apply. -->
+
+- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] 🏗️ Build configuration (CI configuration, scaffolding etc.)
+- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
+- [ ] 📝 Documentation update(s)
+- [ ] 📦 Dependency update(s)
+- [ ] 👩🏽‍💻 Improve developer experience
+- [ ] ⚡ Improve performance
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] ♻ Refactor
+- [ ] ⏪ Revert changes
+- [ ] 🧪 New tests or updates to existing tests

.github/workflows/pull_request_checks.yml

@@ -0,0 +1,126 @@
+name: "Pull Request Checks"
+
+on:
+  pull_request:
+
+jobs:
+  ##
+  # setup
+  ##
+
+  install:
+    name: "Install"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+
+  get_changed_files:
+    name: "Get Changed Files"
+    runs-on: ubuntu-latest
+    outputs:
+      changed_files: ${{ steps.get_changed_files.outputs.result }}
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "📥 Get List"
+        id: get_changed_files
+        uses: actions/github-script@v7
+        with:
+          debug: true
+          result-encoding: string
+          script: |
+            const changedFiles = await github.rest.pulls.listFiles({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.pull_request.number,
+            });
+            return changedFiles.data.map(f => f.filename).join(',');
+
+  ##
+  # validation
+  ##
+
+  validate_pr_title:
+    name: "Validate PR Title"
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "📥 Get PR Title"
+        id: get_pr_title
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const { data } = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.pull_request.number
+            });
+            return data.title;
+      - name: "✅ Validate"
+        run: echo "${{ steps.get_pr_title.outputs.result }}" | npx commitlint
+
+  ##
+  # lint, type check and test
+  ##
+
+  check_types_js_client:
+    name: "Types Check: js-client"
+    needs: [install, get_changed_files, validate_pr_title]
+    runs-on: ubuntu-latest
+    if: contains(needs.get_changed_files.outputs.changed_files, 'packages/js-client/')
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔍 Type Check"
+        run: npm run check:types --workspace=@kibisis/pinakion-js-client
+
+  lint_contract:
+    name: "Lint: contract"
+    needs: [install, get_changed_files, validate_pr_title]
+    runs-on: ubuntu-latest
+    if: contains(needs.get_changed_files.outputs.changed_files, 'packages/contract/')
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "👕 Lint"
+        run: npm run lint:contract
+
+  lint_js_client:
+    name: "Lint: js-client"
+    needs: [install, get_changed_files, validate_pr_title]
+    runs-on: ubuntu-latest
+    if: contains(needs.get_changed_files.outputs.changed_files, 'packages/js-client/')
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "👕 Lint"
+        run: npm run lint:js-client
+
+  test_js_client:
+    name: "Test: js-client"
+    needs: [install, get_changed_files, validate_pr_title]
+    runs-on: ubuntu-latest
+    if: contains(needs.get_changed_files.outputs.changed_files, 'packages/js-client/')
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup npm Dependencies"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
+      - name: "🧪 Test"
+        run: npm run test:js-client

.github/workflows/release.yml

@@ -0,0 +1,71 @@
+name: "Release"
+
+on:
+  push:
+    branches:
+      - beta
+      - main
+
+permissions:
+  contents: write # to be able to publish a github release
+  issues: write # to be able to comment on released issues
+  packages: write  # to be able to publish packages
+  pull-requests: write # to be able to comment on released pull requests
+
+jobs:
+  release_contract:
+    name: "🔖 Release - contract"
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
+      - name: "🏗️ Build"
+        run: npm run build:contract
+      - name: "🔖 Release"
+        env:
+          HUSKY: 0 # disable husky
+          # appears on the release commits
+          GIT_AUTHOR_NAME: kibi-bot
+          GIT_AUTHOR_EMAIL: [email protected]
+          GIT_COMMITTER_NAME: kibi-bot
+          GIT_COMMITTER_EMAIL: [email protected]
+          # used to push the release commit and create the tags
+          GITHUB_TOKEN: ${{ secrets.READ_AND_WRITE_REPOS_TOKEN }}
+        run: npx semantic-release -e semantic-release-monorepo
+        working-directory: ./packages/contract
+
+  release_js_client:
+    name: "🔖 Release - js-client"
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🔧 Setup"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
+      - name: "📝 Create .npmrc"
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_PUBLISH_PACKAGES_ACCESS_TOKEN }}" >> .npmrc
+          echo "@kibisis:registry=https://registry.npmjs.org" >> .npmrc
+          echo "access=public" >> .npmrc
+      - name: "🏗️ Build"
+        run: npm run build:js-client
+      - name: "🔖 Release"
+        env:
+          HUSKY: 0 # disable husky
+          # appears on the release commits
+          GIT_AUTHOR_NAME: kibi-bot
+          GIT_AUTHOR_EMAIL: [email protected]
+          GIT_COMMITTER_NAME: kibi-bot
+          GIT_COMMITTER_EMAIL: [email protected]
+          # used to push the release commit and create the tags
+          GITHUB_TOKEN: ${{ secrets.READ_AND_WRITE_REPOS_TOKEN }}
+        run: npx semantic-release -e semantic-release-monorepo
+        working-directory: ./packages/js-client

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc.mjs

@@ -0,0 +1,4 @@
+export default {
+  '**/*.{js,json,ts}': (filenames) =>
+    `prettier --write ${filenames.join(' ')}`,
+};

.prettierignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "printWidth": 120,
+  "singleQuote": true,
+  "trailingComma": "es5"
+}