Skip to content

Commit

Permalink
Fix Flaky Validator Messaging Test (#394)
Browse files Browse the repository at this point in the history 
* adds more logging and messaging.test.ts

* refactor test cases

* adds logging

* moving feed deployment out of beforeEach

* combining test files again
  • Loading branch information
@chris-de-leon-cll
chris-de-leon-cll authored Mar 28, 2024
1 parent 90cdc16 commit d42f061
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 34 deletions.
119 changes: 85 additions & 34 deletions contracts/test/emergency/StarknetValidator.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { abi as starknetMessagingAbi } from '../../artifacts/vendor/starkware-libs/cairo-lang/src/starkware/starknet/solidity/IStarknetMessaging.sol/IStarknetMessaging.json'
import { abi as accessControllerAbi } from '../../artifacts/@chainlink/contracts/src/v0.8/interfaces/AccessControllerInterface.sol/AccessControllerInterface.json'
import { abi as aggregatorAbi } from '../../artifacts/@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol/AggregatorV3Interface.json'
import { fetchStarknetAccount, getStarknetContractArtifacts, waitForTransactions } from '../utils'
import { Contract as StarknetContract, RpcProvider, CallData, Account, hash } from 'starknet'
import { deployMockContract, MockContract } from '@ethereum-waffle/mock-contract'
import { BigNumber, Contract as EthersContract, ContractFactory } from 'ethers'
import { fetchStarknetAccount, getStarknetContractArtifacts } from '../utils'
import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'
import * as l1l2messaging from '../l1-l2-messaging'
import { STARKNET_DEVNET_URL } from '../constants'
Expand Down Expand Up @@ -494,13 +494,20 @@ describe('StarknetValidator', () => {
)

// Simulate L1 transmit + validate
await starknetValidator.addAccess(eoaValidator.address)
// by default the gas config is 0, we need to change it or we will submit a 0 fee
const newGasEstimate = 1
await starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100)
await starknetValidator.connect(eoaValidator).validate(0, 0, 1, 1) // gasPrice (1) * newGasEstimate (1)
const receipts = await waitForTransactions([
// Add access
() => starknetValidator.addAccess(eoaValidator.address),

// By default the gas config is 0, we need to change it or we will submit a 0 fee
() =>
starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100),

// gasPrice (1) * newGasEstimate (1)
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 1),
])

// Simulate the L1 - L2 comms
const resp = await l1l2messaging.flush()
Expand All @@ -513,6 +520,20 @@ describe('StarknetValidator', () => {

// Assert L2 effects
const result = await l2Contract.latest_round_data()

// Logging (to help debug potential flaky test)
console.log(
JSON.stringify(
{
latestRoundData: result,
flushResponse: resp,
txReceipts: receipts,
},
(_, value) => (typeof value === 'bigint' ? value.toString() : value),
2,
),
)

expect(result['answer']).to.equal('1')
})

Expand All @@ -530,13 +551,20 @@ describe('StarknetValidator', () => {
)

// Simulate L1 transmit + validate
await starknetValidator.addAccess(eoaValidator.address)
// by default the gas config is 0, we need to change it or we will submit a 0 fee
const newGasEstimate = 1
await starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100)
await starknetValidator.connect(eoaValidator).validate(0, 0, 1, 127) // incorrect value
const receipts = await waitForTransactions([
// Add access
() => starknetValidator.connect(deployer).addAccess(eoaValidator.address),

// By default the gas config is 0, we need to change it or we will submit a 0 fee
() =>
starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100),

// Incorrect value
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 127),
])

// Simulate the L1 - L2 comms
const resp = await l1l2messaging.flush()
Expand All @@ -549,6 +577,20 @@ describe('StarknetValidator', () => {

// Assert L2 effects
const result = await l2Contract.latest_round_data()

// Logging (to help debug potential flaky test)
console.log(
JSON.stringify(
{
latestRoundData: result,
flushResponse: resp,
txReceipts: receipts,
},
(_, value) => (typeof value === 'bigint' ? value.toString() : value),
2,
),
)

expect(result['answer']).to.equal('0') // status unchanged - incorrect value treated as false
})

Expand All @@ -566,28 +608,23 @@ describe('StarknetValidator', () => {
)

// Simulate L1 transmit + validate
let tx: Awaited<ReturnType<typeof ethers.provider.sendTransaction>>
await starknetValidator.addAccess(eoaValidator.address)
const c = starknetValidator.connect(eoaValidator)
// by default the gas config is 0, we need to change it or we will submit a 0 fee
const newGasEstimate = 1
tx = await starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100)
await tx.wait()

// To ensure that these transactions are sent in the order we expect, we'll use `.wait()`:
//
// https://docs.ethers.org/v5/api/contract/contract/#contract-functionsSend
//
tx = await c.validate(0, 0, 1, 1)
await tx.wait()
tx = await c.validate(0, 0, 1, 1)
await tx.wait()
tx = await c.validate(0, 0, 1, 127) // incorrect value
await tx.wait()
tx = await c.validate(0, 0, 1, 0) // final status
await tx.wait()
const receipts = await waitForTransactions([
// Add access
() => starknetValidator.connect(deployer).addAccess(eoaValidator.address),

// By default the gas config is 0, we need to change it or we will submit a 0 fee
() =>
starknetValidator
.connect(deployer)
.setGasConfig(newGasEstimate, mockGasPriceFeed.address, 100),

// Validate
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 1),
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 1),
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 127), // incorrect value
() => starknetValidator.connect(eoaValidator).validate(0, 0, 1, 0), // final status
])

// Simulate the L1 - L2 comms
const resp = await l1l2messaging.flush()
Expand All @@ -600,6 +637,20 @@ describe('StarknetValidator', () => {

// Assert L2 effects
const result = await l2Contract.latest_round_data()

// Logging (to help debug potential flaky test)
console.log(
JSON.stringify(
{
latestRoundData: result,
flushResponse: resp,
txReceipts: receipts,
},
(_, value) => (typeof value === 'bigint' ? value.toString() : value),
2,
),
)

expect(result['answer']).to.equal('0') // final status 0
})
})
Expand Down
18 changes: 18 additions & 0 deletions contracts/test/utils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { STARKNET_DEVNET_URL } from './constants'
import { execSync } from 'node:child_process'
import { Account } from 'starknet'
import * as path from 'node:path'
import { ethers } from 'hardhat'
import { json } from 'starknet'
import * as fs from 'node:fs'

Expand Down Expand Up @@ -36,6 +37,23 @@ export const getStarknetContractArtifacts = (name: string) => {
}
}

export const waitForTransaction = async (
tx: () => ReturnType<typeof ethers.provider.sendTransaction>,
) => {
const result = await tx()
return await result.wait()
}

export const waitForTransactions = async (
txs: (() => ReturnType<typeof ethers.provider.sendTransaction>)[],
) => {
const results = new Array<Awaited<ReturnType<typeof waitForTransaction>>>()
for (const tx of txs) {
results.push(await waitForTransaction(tx))
}
return results
}

const getRootDir = () => {
const result = execSync('git rev-parse --show-toplevel').toString()
return result.replace(/\n/g, '')
Expand Down

0 comments on commit d42f061

Please sign in to comment.