release: v0.20.0

.algokit.toml

@@ -30,7 +30,7 @@ build = { commands = [
   'poetry run python -m smart_contracts build',
 ], description = 'Build all smart contracts in the project' }
 test = { commands = [
-  'poetry run pytest',
+  'poetry run pytest -m "not showcase"',
 ], description = 'Run smart contract tests' }
 audit = { commands = [
   'poetry run pip-audit',
@@ -48,5 +48,6 @@ audit-teal = { commands = [
 # Commands intented for CI only, prefixed with `ci-` by convention
 ci-teal-diff = { commands = [
   'git add -N ./smart_contracts/artifacts',
-  'git diff --exit-code --minimal ./smart_contracts/artifacts',
-], description = 'Check TEAL files for differences' }
+  'git add -N ./src/d_asa/artifacts',
+  'git diff --exit-code --minimal ./smart_contracts/artifacts ./src/d_asa/artifacts',
+], description = 'Check generated artifacts for differences' }

.dockerignore

@@ -0,0 +1,13 @@
+.git
+.github
+.idea
+.mypy_cache
+.pytest_cache
+.ruff_cache
+.vscode
+__pycache__
+book
+docs
+tests
+.env.localnet
+.env.testnet

.github/actions/docs-ci/action.yaml

@@ -8,6 +8,12 @@ runs:
       with:
         mdbook-version: '0.5.2'
 
+    - name: Install mdbook-mermaid
+      shell: bash
+      run: |
+        cargo install mdbook-mermaid --version 0.17.0 --locked
+        mdbook-mermaid install .
+
     - name: Test docs
       shell: bash
       run: mdbook test

.github/workflows/d-asa-ci.yaml

@@ -39,20 +39,10 @@ jobs:
       - name: Run deployer against LocalNet
         run: algokit project deploy localnet
 
-  test:
-    name: Test ${{ matrix.module }}
+  test-mock-module-rbac:
+    name: Test RBAC Module
     if: '! github.event.pull_request.draft'
     runs-on: "ubuntu-latest"
-    strategy:
-      matrix:
-        module:
-          # Mocked modules
-          - mock_module_rbac
-          - mock_module_accounting
-          # Contracts
-          - zero_coupon_bond
-          - fixed_coupon_bond
-          - perpetual_bond
     steps:
       - name: Checkout source code
         uses: actions/checkout@v6
@@ -65,22 +55,28 @@ jobs:
         id: filter
         with:
           filters: |
-            module:
-              - 'smart_contracts/artifacts/${{ matrix.module }}/**'
+            mock_module_rbac:
+              - 'smart_contracts/artifacts/mock_module_rbac/**'
               - 'tests/conftest.py'
-              - 'tests/${{ matrix.module }}/**'
+              - 'tests/mock_module_rbac/**'
 
       - name: Run tests
-        if: steps.filter.outputs.module == 'true'
+        if: steps.filter.outputs.mock_module_rbac == 'true'
         shell: bash
         run: |
           set -o pipefail
-          algokit project run test tests/${{ matrix.module }}
+          algokit project run test tests/mock_module_rbac
 
-  test-shared:
-    name: Test shared contracts
+  test-pam:
+    name: Test PAM ${{ matrix.subfolder }}
     if: '! github.event.pull_request.draft'
     runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        subfolder:
+          - fcb
+          - zcb
     steps:
       - name: Checkout source code
         uses: actions/checkout@v6
@@ -93,30 +89,23 @@ jobs:
         id: filter
         with:
           filters: |
-            shared:
-              - 'modules/**'
-              - 'smart_contracts/artifacts/zero_coupon_bond/**'
-              - 'smart_contracts/artifacts/fixed_coupon_bond/**'
-              - 'smart_contracts/artifacts/perpetual_bond/**'
+            pam:
+              - 'smart_contracts/artifacts/d_asa/**'
+              - 'src/artifacts/**'
               - 'tests/conftest.py'
               - 'tests/conftest_helpers.py'
-              - 'tests/shared/**'
-
-      - name: Run shared tests
-        if: steps.filter.outputs.shared == 'true'
-        shell: bash
-        run: |
-          set -o pipefail
-          algokit project run test tests/shared
+              - 'tests/pam/pam_test_support.py'
+              - 'tests/pam/${{ matrix.subfolder }}/**'
 
-      - name: Run helper tests
+      - name: Run tests
+        if: steps.filter.outputs.pam == 'true'
         shell: bash
         run: |
           set -o pipefail
-          algokit project run test tests/test_utils.py tests/test_mixin_composition_guards.py
+          algokit project run test tests/pam/${{ matrix.subfolder }}
 
-  test-events:
-    name: Test ACTUS events
+  test-sdk:
+    name: Test SDK and helpers
     if: '! github.event.pull_request.draft'
     runs-on: "ubuntu-latest"
     steps:
@@ -126,8 +115,20 @@ jobs:
       - name: Set up AlgoKit
         uses: ./.github/actions/algokit-setup
 
-      - name: Run Fixed Coupon Bond ACTUS events test
+      - name: Detect changes
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            sdk:
+              - 'src/**'
+              - 'smart_contracts/**'
+              - 'tests/sdk/**'
+              - 'tests/test_utils.py'
+
+      - name: Run tests
+        if: steps.filter.outputs.sdk == 'true'
         shell: bash
         run: |
           set -o pipefail
-          poetry run pytest -s -v tests/fixed_coupon_bond/test_actus_events.py
+          algokit project run test tests/sdk tests/test_utils.py

.gitignore

@@ -95,3 +95,8 @@ debug_traces/
 
 # mdBook
 book
+mermaid-init.js
+mermaid.min.js
+
+# Jupyter
+.ipynb_checkpoints/

.markdownlintignore

@@ -1,2 +1,3 @@
+CONTRIBUTIONS.md
 SUMMARY.md
 styles.md

.pre-commit-config.yaml

@@ -79,7 +79,7 @@ repos:
         minimum_pre_commit_version: 0.15.0
         types: [ markdown ]
         additional_dependencies: [ ]
-        files: '^(docs)/'
+        files: '^(docs/|[^/]+\.md$)'
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
@@ -92,4 +92,4 @@ repos:
         minimum_pre_commit_version: 3.2.0
         types: [ markdown ]
         additional_dependencies: [ ]
-        files: '^(docs)/'
+        files: '^(docs/|[^/]+\.md$)'