smartcontractkit · archseer · Aug 11, 2023 · Apr 12, 2023 · Mar 30, 2023 · Mar 30, 2023
diff --git a/Makefile b/Makefile
@@ -146,9 +146,8 @@ format-cairo:
 format-cairo-check:
 	find ./contracts/src -name "*.cairo" -type f \
 		-exec cairo-format -c {} +
-	# TODO: re-enable once examples are rewritten
-	# find ./examples -name "*.cairo" -type f \
-	# 	-exec cairo-format -c {} +
+	find ./examples -name "*.cairo" -type f \
+		-exec cairo-format -c {} +
 
 .PHONY: format-ts
 format-ts:

diff --git a/contracts/Scarb.toml b/contracts/Scarb.toml
@@ -15,4 +15,11 @@ test = "cairo-test --starknet ."
 # quaireaux = { git = "https://github.com/keep-starknet-strange/quaireaux.git" }
 
 [[target.starknet-contract]]
+# note these two options only work on scarb 0.2.0 and forward
+casm = true
+# Emit Python-powered hints in order to run compiled CASM class with legacy Cairo VM.
+casm-add-pythonic-hints = true
 
+[lib]
+sierra = true  # Enable Sierra codegen.
+casm = true   # Enable CASM codegen.
diff --git a/contracts/cairo_project.toml b/contracts/cairo_project.toml
@@ -1,2 +1,2 @@
 [crate_roots]
-chainlink = "src"
+chainlink = "src"
diff --git a/contracts/src/ocr2/mocks/mock_aggregator.cairo b/contracts/src/ocr2/mocks/mock_aggregator.cairo
@@ -25,6 +25,9 @@ mod MockAggregator {
         answer: u128, block_num: u64, observation_timestamp: u64, transmission_timestamp: u64
     ) {
         let new_round_id = _latest_aggregator_round_id::read() + 1_u128;
+
+        // update both storage variables
+        _latest_aggregator_round_id::write(new_round_id);
         _transmissions::write(
             new_round_id,
             Transmission {

diff --git a/contracts/test/ocr2/aggregator.test.ts b/contracts/test/ocr2/aggregator.test.ts
@@ -399,7 +399,7 @@ describe('aggregator.cairo', function () {
           proposed: proposed_payee,
         })
         expect.fail()
-      } catch (err: any) {}
+      } catch (err: any) { }
 
       // successful transfer
       await oracle.invoke(aggregator, 'transfer_payeeship', {
@@ -411,7 +411,7 @@ describe('aggregator.cairo', function () {
       try {
         await oracle.invoke(aggregator, 'accept_payeeship', { transmitter })
         expect.fail()
-      } catch (err: any) {}
+      } catch (err: any) { }
 
       // successful accept
       await proposed_oracle.invoke(aggregator, 'accept_payeeship', {

diff --git a/examples/contracts/aggregator-consumer/.gitignore b/examples/contracts/aggregator-consumer/.gitignore
@@ -1,2 +1,3 @@
+target
 cache/
-starknet-artifacts/
+starknet-artifacts/
diff --git a/examples/contracts/aggregator-consumer/README.md b/examples/contracts/aggregator-consumer/README.md
@@ -0,0 +1,70 @@
+This example demonstrates how consumer contracts can read from the aggregator, with and without consideration of the uptime feed address. Recall that the purpose of the uptime feed is to let consumer contracts know if the L2 layer is up and healthy.
+
+We demonstrate these examples by mocking an aggregator to return stubbed values.
+
+You can run this example on your local devnet or on goerli (up to you). NOTE: at the time of writing, the examples only work against devnet due to Starknet version incompatability.
+
+Note: `.env` will contain account details, such as DEPLOYER_ACCOUNT_ADDRESS and DEPLOYER_PRIVATE_KEY
+
+## Deploy on Devnet
+
+### 1. Install Local Dev Environment
+
+Follow [steps 1 and 2 here](../proxy_consumer/README.md)
+
+At this point, you should have starknet-devnet, cairo, and scarb installed. Your virtualenv will also have the starknet cli tool but we won't be using that to test against devnet
+
+All instructions begin at the root of this folder
+### 2. Compile cairo 1 contracts
+
+```
+    yarn compile:cairo
+```
+
+
+### 3. Setup Starknet Devnet
+
+In a seperate terminal, run:
+```
+    starknet-devnet --cairo-compiler-manifest ../../vendor/cairo/Cargo.toml --seed 0 --lite-mode ../../../vendor/cairo/Cargo.toml 
+```
+This will start up the devnet and enable you to deploy and run cairo 1 contracts against it
+
+### 4. Deploy Devnet Account
+
+This command will deploy a devnet account onto devnet and write the DEPLOYER_ACCOUNT_ADDRESS and DEPLOYER_PRIVATE_KEY into a .env file in the current directory (it will create .env if it doesn't exist). This account will be utilized for deploying and interacting with the rest of the contracts in this section.
+
+```
+    yarn deployAccount
+```
+
+## 5. Deploy Contracts
+
+This will deploy the following contracts:
+* SequencerUptimeFeed: Displays the status of the L2 layer. If it is up, then it is safe to read from the aggregator contract. For more information please see this [document](../../../docs/emergency-protocol/README.md). 
+* MockAggregator: A mocked version of the aggregator with limited functionality. It gives the reader the ability to set and view the latest round data in order so the reader can familiarize themselves for testing purposes.
+* AggregatorConsumer: Simply reads the mocked aggregator's latest values
+* AggregatorPriceConsumerWithSequencer: Reads the mocked aggregator's values but also queries the SequencerUptimeFeed to determine if the value should be used or not. If the SequencerUptimeFeed is too stale, then that means the L2 layer is down. We've arbitrarily chosen the threshold of 60 seconds.
+
+
+```
+    yarn deployContracts
+```
+
+## 6. Interact with Contracts
+
+```
+# deployer calls AggregatorConsumer to read the decimals method of the MockAggregator
+yarn readDecimals
+
+# deployer calls AggregatorConsumer to read the latest round of the MockAggregator
+yarn readLatestRound
+
+# deployer calls Aggregator Consumer to poll decimals AND latest round of MockAggregator 
+yarn readContinuously
+
+# deployer calls MockAggregator to manually set the new round's data
+yarn updateLatestRound
+
+# deployer calls AggregatorPriceConsumerWithSequencer to read latest round or revert if uptime feed is stale
+yarn getLatestPriceSeqCheck
diff --git a/examples/contracts/aggregator-consumer/Scarb.toml b/examples/contracts/aggregator-consumer/Scarb.toml
@@ -0,0 +1,14 @@
+[package]
+name = "chainlink_examples"
+version = "0.1.0"
+
+# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
+
+[dependencies]
+ chainlink = { path = "../../../contracts" }
+
+[[target.starknet-contract]]
+# note these two options only work on scarb 0.2.0 and forward
+casm = true
+# Emit Python-powered hints in order to run compiled CASM class with legacy Cairo VM.
+casm-add-pythonic-hints = true
diff --git a/examples/contracts/aggregator-consumer/cairo_project.toml b/examples/contracts/aggregator-consumer/cairo_project.toml
@@ -0,0 +1,2 @@
+[crate_roots]
+chainlink_examples = "src"
diff --git a/examples/contracts/aggregator-consumer/contracts/Aggregator_consumer.cairo b/examples/contracts/aggregator-consumer/contracts/Aggregator_consumer.cairo
diff --git a/examples/contracts/aggregator-consumer/contracts/MockAggregator.cairo b/examples/contracts/aggregator-consumer/contracts/MockAggregator.cairo
diff --git a/examples/contracts/aggregator-consumer/contracts/Price_Consumer_With_Sequencer_Check.cairo b/examples/contracts/aggregator-consumer/contracts/Price_Consumer_With_Sequencer_Check.cairo
diff --git a/examples/contracts/aggregator-consumer/example.env b/examples/contracts/aggregator-consumer/example.env
@@ -0,0 +1,11 @@
+# This is a an example .env file that contains pre-deployed and pre-funded account that come with starknet-devnet
+# To see a complete list of pre-deployed starknet-devnet accounts just run `starknet-devnet`
+
+# hypothetical devnet account
+DEPLOYER_ACCOUNT_ADDRESS=<DEVNET_ACCOUNT_ADDRESS>
+DEPLOYER_PRIVATE_KEY=<DEVNET_ACCOUNT_PRIVATE_KEY>
+
+# Below is what you'd set to run these examples on GOERLI 
+# DEPLOYER_ACCOUNT_ADDRESS=<GOERLI_ACCOUNT_ADDRESS>
+# DEPLOYER_PRIVATE_KEY=<GOERLI_ACCOUNT_PRIVATE_KEY>
+# NETWORK=GOERLI
diff --git a/examples/contracts/aggregator-consumer/getting_start.md b/examples/contracts/aggregator-consumer/getting_start.md
diff --git a/examples/contracts/aggregator-consumer/hardhat.config.ts b/examples/contracts/aggregator-consumer/hardhat.config.ts
@@ -27,7 +27,7 @@ const config: HardhatUserConfig = {
     },
   },
   paths: {
-    cairoPaths: ['../../../contracts/src'],
+    cairoPaths: ['../../contracts/src'],
   },
 }
 

diff --git a/examples/contracts/aggregator-consumer/package.json b/examples/contracts/aggregator-consumer/package.json
@@ -1,28 +1,33 @@
 {
-  "name": "@chainlink/starknet-ocr2-consumer",
-  "version": "0.1.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "compile:cairo": "hardhat starknet-compile",
-    "compile": "yarn compile:cairo",
-    "test": "npx hardhat --network localhost test",
-    "readDecimals": "npx ts-node ./scripts/readDecimals.ts",
-    "readLatestRound": "npx ts-node ./scripts/readLatestRound.ts"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "devDependencies": {
-    "@nomiclabs/hardhat-ethers": "^2.1.0",
-    "@shardlabs/starknet-hardhat-plugin": "^0.8.0-alpha.0",
-    "@types/chai": "^4.3.3",
-    "@types/mocha": "^9.1.1",
-    "chai": "^4.3.6",
-    "hardhat": "^*"
-  },
-  "dependencies": {
-    "@chainlink/starknet": "^1.0.0",
-    "dotenv": "^16.0.1"
-  }
+    "name": "@chainlink/latest-starknet-ocr2-consumer",
+    "version": "0.1.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+        "compile:cairo": "scarb --profile release build",
+        "compile": "yarn compile:cairo",
+        "test": "yarn hardhat --network localhost test",
+        "deployAccount": "yarn ts-node ./scripts/deploy_accounts.ts",
+        "deployContracts": "yarn ts-node ./scripts/deploy_contracts.ts",
+        "readDecimals": "yarn ts-node ./scripts/readDecimals.ts",
+        "readLatestRound": "yarn ts-node ./scripts/readLatestRound.ts",
+        "readContinuously": "yarn ts-node ./scripts/readContinuously.ts",
+        "updateLatestRound": "yarn ts-node ./scripts/updateLatestRound.ts",
+        "getLatestPriceSeqCheck": "yarn ts-node ./scripts/getLatestPriceSeqCheck.ts"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "MIT",
+    "devDependencies": {
+        "@nomiclabs/hardhat-ethers": "^2.1.0",
+        "@shardlabs/starknet-hardhat-plugin": "^0.8.0-alpha.0",
+        "@types/chai": "^4.3.3",
+        "@types/mocha": "^9.1.1",
+        "chai": "^4.3.6",
+        "hardhat": "^*"
+    },
+    "dependencies": {
+        "@chainlink/starknet": "^1.0.0",
+        "dotenv": "^16.0.1"
+    }
 }