Merge pull request HyperSafeD#732 from EbukaMoses/Add_integration

contracts/*: Add integration/e2e coverage in CI (ABI / interface docs…

Author: Gbangbolaoluwagbemiga

.github/workflows/benchmarks.yml

@@ -33,6 +33,13 @@ jobs:
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
 
+      - name: Install System Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libdbus-1-dev pkg-config
+          export PKG_CONFIG_PATH=/usr/lib/x86_64-linux-gnu/pkgconfig:/usr/share/pkgconfig:$PKG_CONFIG_PATH
+          echo "PKG_CONFIG_PATH=$PKG_CONFIG_PATH" >> $GITHUB_ENV
+
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
 

.github/workflows/ci.yml

@@ -143,7 +143,7 @@ jobs:
           echo 'module.exports = {};' > tooling/sanctifier-wasm/pkg/index.js
 
       - name: Install frontend dependencies
-        run: cd frontend && npm ci
+        run: cd frontend && npm install
 
       - name: Run unit tests
         run: cd frontend && npm test
@@ -223,7 +223,7 @@ jobs:
           echo 'module.exports = {};' > tooling/sanctifier-wasm/pkg/index.js
 
       - name: Install frontend dependencies
-        run: cd frontend && npm ci
+        run: cd frontend && npm install
 
       - name: Install Playwright browsers
         run: cd frontend && npx playwright install --with-deps chromium
@@ -263,14 +263,63 @@ jobs:
           echo 'module.exports = {};' > tooling/sanctifier-wasm/pkg/index.js
 
       - name: Install frontend dependencies
-        run: cd frontend && npm ci
+        run: cd frontend && npm install
 
       - name: Install Playwright browsers
         run: cd frontend && npx playwright install --with-deps chromium
 
       - name: Run schema rendering e2e suite
         run: cd frontend && npm run test:e2e:schema
 
+  contract-docs:
+    name: Contract ABI / Interface Docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install stable Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache cargo registry & build artifacts
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-contract-docs-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-contract-docs-
+
+      - name: Generate contract docs and interface summary
+        run: make contract-docs
+
+      - name: Verify interface summary is up-to-date
+        run: |
+          # Run extraction-only check (rustdoc already generated above)
+          SKIP_RUSTDOC=1 bash scripts/gen-contract-docs.sh --check
+
+      - name: Run ABI surface stability tests (amm-pool)
+        run: cargo test -p amm-pool --test integration_tests abi_ -- --nocapture
+
+      - name: Upload rustdoc artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: contract-rustdoc
+          path: target/doc/
+          retention-days: 14
+
+      - name: Upload interface JSON artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: contract-interfaces-json
+          path: docs/generated/contract-interfaces.json
+          retention-days: 14
+
   commitlint:
     name: Lint Commit Messages
     runs-on: ubuntu-latest

.github/workflows/soroban-deploy.yml

@@ -65,6 +65,8 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libdbus-1-dev pkg-config
+          export PKG_CONFIG_PATH=/usr/lib/x86_64-linux-gnu/pkgconfig:/usr/share/pkgconfig:$PKG_CONFIG_PATH
+          echo "PKG_CONFIG_PATH=$PKG_CONFIG_PATH" >> $GITHUB_ENV
           cargo install --locked soroban-cli || true
           soroban --version
 
@@ -166,6 +168,10 @@ jobs:
 
       - name: Install Soroban CLI
         run: |
+          sudo apt-get update
+          sudo apt-get install -y libdbus-1-dev pkg-config
+          export PKG_CONFIG_PATH=/usr/lib/x86_64-linux-gnu/pkgconfig:/usr/share/pkgconfig:$PKG_CONFIG_PATH
+          echo "PKG_CONFIG_PATH=$PKG_CONFIG_PATH" >> $GITHUB_ENV
           cargo install --locked soroban-cli || true
 
       - name: Run continuous validation checks

Cargo.lock

@@ -6,10 +6,17 @@ members = [
     "contracts/vulnerable-contract",
     "contracts/token-with-bugs",
     "contracts/amm-pool",
+    "contracts/governance",
+    "contracts/multisig",
+    "contracts/timelock",
     "contracts/reentrancy-guard",
     "contracts/runtime-guard-wrapper",
     "contracts/kani-poc",
     "contracts/my-contract",
+    "contracts/flashloan-token",
+    "contracts/proxy",
+    "contracts/vesting",
+    "contracts/benchmark",
 
 ]
 resolver = "2"
@@ -20,6 +27,9 @@ soroban-sdk = { version = "21.7.6" }
 [workspace.package]
 rust-version = "1.78"
 
+[workspace.lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(kani)'] }
+
 [profile.release]
 opt-level = "z"
 overflow-checks = true

Cargo.toml

@@ -85,6 +85,13 @@
 
 ## 🛠️ Component Documentation
 
+### Contract ABI / Interface Reference
+**[docs/contract-interfaces.md](docs/contract-interfaces.md)** - Public ABI for all contracts in `contracts/*`
+- Function signatures and descriptions for every contract
+- Error code tables
+- Machine-readable JSON at `docs/generated/contract-interfaces.json`
+- Regenerate with `make contract-docs`; CI enforces freshness via `make contract-docs-check`
+
 ### Runtime Guard Wrapper Contract
 
 **[contracts/runtime-guard-wrapper/README.md](contracts/runtime-guard-wrapper/README.md)**

DOCUMENTATION_INDEX.md

@@ -1,4 +1,4 @@
-.PHONY: build test lint fmt audit release clean docs
+.PHONY: build test lint fmt audit release clean docs contract-docs contract-docs-check
 
 ## Build all workspace crates (debug).
 build:
@@ -35,3 +35,11 @@ docs:
 ## Remove all build artefacts.
 clean:
 	cargo clean
+
+## Generate ABI / interface docs for all contracts (rustdoc + JSON summary).
+contract-docs:
+	bash scripts/gen-contract-docs.sh
+
+## Verify contract-interfaces.json is up-to-date (used in CI).
+contract-docs-check:
+	bash scripts/gen-contract-docs.sh --check

Makefile

@@ -0,0 +1,32 @@
+{
+  "generated_at_epoch_ms": 1777332857449,
+  "metrics": [
+    {
+      "bytes": 6140,
+      "max_pattern_len": 72,
+      "parse_ms": 0.08494299981975928,
+      "path": "data/vulnerability-db.json",
+      "read_ms": 0.7110500000635511,
+      "total_pattern_len": 628,
+      "vulnerabilities": 12
+    },
+    {
+      "bytes": 2591,
+      "max_pattern_len": 91,
+      "parse_ms": 0.042007000047306065,
+      "path": "tooling/sanctifier-cli/data/vulnerability-db.json",
+      "read_ms": 0.36192899960951763,
+      "total_pattern_len": 209,
+      "vulnerabilities": 5
+    },
+    {
+      "bytes": 2380,
+      "max_pattern_len": null,
+      "parse_ms": 0.05150400011189049,
+      "path": "schemas/vulnerability-db.json",
+      "read_ms": 0.4795800000465533,
+      "total_pattern_len": null,
+      "vulnerabilities": null
+    }
+  ]
+}

benchmarks/data_schemas_perf.json

@@ -1,8 +1,8 @@
 {
   "file": "DOCUMENTATION_INDEX.md",
-  "size_bytes": 11542,
-  "total_links": 63,
-  "internal_links": 57,
+  "size_bytes": 14324,
+  "total_links": 83,
+  "internal_links": 77,
   "dead_links_count": 0,
   "dead_links": [],
   "max_nesting_depth": 0