Merge pull request #364 from smartcontractkit/feat/BCI-2538-update-ex…

…amples Updates Examples Directory
smartcontractkit · Mar 12, 2024 · 021f7fd · 021f7fd
2 parents 29434ab + 1015270
commit 021f7fd
Show file tree

Hide file tree

Showing 62 changed files with 385 additions and 1,484 deletions.
diff --git a/.github/actions/install-starknet-foundry/action.yml b/.github/actions/install-starknet-foundry/action.yml
@@ -0,0 +1,19 @@
+name: Install Starknet Foundry (snforge and sncast)
+description: A composite action that installs the snforge and sncast binaries
+
+inputs:
+  starknet_foundry_version:
+    description: Starknet Foundry release version
+    default: "0.18.0"
+    required: false
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Starknet Foundry for Linux
+      id: install-starknet-foundry
+      shell: bash
+      run: |
+        curl -L https://raw.githubusercontent.com/foundry-rs/starknet-foundry/master/scripts/install.sh | sh 
+        snfoundryup -v ${{ inputs.starknet_foundry_version }}
+
diff --git a/.github/workflows/integration_contracts.yml → .github/workflows/examples.yml b/.github/workflows/integration_contracts.yml → .github/workflows/examples.yml
@@ -1,4 +1,4 @@
-name: Integration Contracts (Vendor, Examples)
+name: Example Contracts
 
 on:
   push:
@@ -8,7 +8,7 @@ on:
   pull_request:
 
 jobs:
-  integration_contracts_run_tests:
+  run_examples_tests:
     name: Run Tests
     runs-on: ubuntu-latest
     steps:
@@ -23,5 +23,8 @@ jobs:
       - name: Install Cairo
         uses: ./.github/actions/install-cairo
 
+      - name: Install Starknet Foundry
+        uses: ./.github/actions/install-starknet-foundry
+
       - name: Test
-        run: nix develop -c make test-integration-contracts
+        run: nix develop -c make test-examples
diff --git a/Makefile b/Makefile
@@ -213,16 +213,10 @@ test-integration-soak-ci:
 	cd integration-tests/ && \
 		go test --timeout=1h -v -count=1 -json ./soak
 
-.PHONY: test-integration-contracts
-# TODO: better network lifecycle setup - requires external network (L1 + L2)
-# TODO: readd test examples
-#       cd examples/contracts/aggregator-consumer/ && \
-#         yarn test
-test-integration-contracts: build-ts env-devnet-hardhat
-	echo "Tests currently broken because of starknet-hardhat-plugin"
-	exit 1
-	cd packages-ts/starknet/ && \
-		yarn test
+.PHONY: test-examples
+test-examples:
+	cd ./examples/contracts/aggregator_consumer && \
+		snforge test
 
 .PHONY: test-integration-gauntlet
 # TODO: fix example

diff --git a/contracts/package.json b/contracts/package.json
@@ -24,7 +24,6 @@
   },
   "dependencies": {
     "@chainlink/contracts": "^0.4.2",
-    "@chainlink/starknet": "^1.0.0",
     "@openzeppelin/contracts": "^4.7.3",
     "axios": "^0.24.0"
   }

diff --git a/packages-ts/starknet/src/account.ts → contracts/test/account.ts b/packages-ts/starknet/src/account.ts → contracts/test/account.ts
diff --git a/contracts/test/emergency/StarknetValidator.test.ts b/contracts/test/emergency/StarknetValidator.test.ts
@@ -1,6 +1,6 @@
 import { ethers, starknet, network } from 'hardhat'
 import { BigNumber, Contract, ContractFactory } from 'ethers'
-import { hash, number } from 'starknet'
+import { hash } from 'starknet'
 import {
   Account,
   StarknetContractFactory,
@@ -13,7 +13,8 @@ import { abi as aggregatorAbi } from '../../artifacts/@chainlink/contracts/src/v
 import { abi as accessControllerAbi } from '../../artifacts/@chainlink/contracts/src/v0.8/interfaces/AccessControllerInterface.sol/AccessControllerInterface.json'
 import { abi as starknetMessagingAbi } from '../../artifacts/vendor/starkware-libs/cairo-lang/src/starkware/starknet/solidity/IStarknetMessaging.sol/IStarknetMessaging.json'
 import { deployMockContract, MockContract } from '@ethereum-waffle/mock-contract'
-import { account, addCompilationToNetwork, expectSuccessOrDeclared } from '@chainlink/starknet'
+import * as account from '../account'
+import { addCompilationToNetwork, expectSuccessOrDeclared } from '../utils'
 
 describe('StarknetValidator', () => {
   /** Fake L2 target */

diff --git a/contracts/test/ocr2/aggregator.test.ts b/contracts/test/ocr2/aggregator.test.ts
@@ -3,7 +3,8 @@ import { starknet } from 'hardhat'
 import { ec, hash, num } from 'starknet'
 import { Account, StarknetContract, StarknetContractFactory } from 'hardhat/types/runtime'
 import { TIMEOUT } from '../constants'
-import { account, expectInvokeError, expectSuccessOrDeclared } from '@chainlink/starknet'
+import { expectInvokeError, expectSuccessOrDeclared } from '../utils'
+import * as account from '../account'
 import { bytesToFelts } from '@chainlink/starknet-gauntlet'
 
 interface Oracle {

diff --git a/packages-ts/starknet/src/utils.ts → contracts/test/utils.ts b/packages-ts/starknet/src/utils.ts → contracts/test/utils.ts
diff --git a/examples/contracts/aggregator-consumer/.gitignore b/examples/contracts/aggregator-consumer/.gitignore
diff --git a/examples/contracts/aggregator-consumer/README.md b/examples/contracts/aggregator-consumer/README.md
diff --git a/examples/contracts/aggregator-consumer/Scarb.toml b/examples/contracts/aggregator-consumer/Scarb.toml
diff --git a/examples/contracts/aggregator-consumer/cairo_project.toml b/examples/contracts/aggregator-consumer/cairo_project.toml
diff --git a/examples/contracts/aggregator-consumer/example.env b/examples/contracts/aggregator-consumer/example.env
diff --git a/examples/contracts/aggregator-consumer/hardhat.config.ts b/examples/contracts/aggregator-consumer/hardhat.config.ts
diff --git a/examples/contracts/aggregator-consumer/package.json b/examples/contracts/aggregator-consumer/package.json