Fixing broken tests from staking reward checks (Synthetixio#662)

Author: justin j. moses

bin.js

@@ -6,6 +6,7 @@ const {
 	getAST,
 	getSource,
 	getSuspensionReasons,
+	getStakingRewards,
 	getSynths,
 	getTarget,
 	getUsers,
@@ -48,6 +49,14 @@ program
 		console.log(networks);
 	});
 
+program
+	.command('rewards')
+	.description('Get staking rewards for an environment')
+	.option('-n, --network <value>', 'The network to run off.', x => x.toLowerCase(), 'mainnet')
+	.action(async ({ network }) => {
+		console.log(JSON.stringify(getStakingRewards({ network }), null, 2));
+	});
+
 program
 	.command('source')
 	.description('Get source files for an environment')

publish/deployed/mainnet/rewards.json

@@ -20,7 +20,7 @@
 		"rewardsToken": "0x330416C863f2acCE7aF9C9314B422d24c672534a"
 	},
 	{
-		"name": "iETH",
+		"name": "iETH3",
 		"stakingToken": "ProxyiETH",
 		"rewardsToken": "Synthetix"
 	},

test/deployments/index.js

@@ -58,16 +58,13 @@ describe('deployments', () => {
 									target: stakingRewardsName,
 								});
 
+								// these mappings are the getters for the legacy rewards contracts
 								const methodMappings = {
-									iETHRewards: {
-										stakingTokenMethod: 'token',
-										rewardsTokenMethod: 'snx',
-									},
-									Unipool: {
+									StakingRewardssETHUniswapV1: {
 										stakingTokenMethod: 'uni',
 										rewardsTokenMethod: 'snx',
 									},
-									CurveRewards: {
+									StakingRewardssUSDCurve: {
 										stakingTokenMethod: 'uni',
 										rewardsTokenMethod: 'snx',
 									},
@@ -78,7 +75,10 @@ describe('deployments', () => {
 
 								// Legacy contracts have a different method name
 								// to get staking tokens and rewards token
-								if (stakingRewardsTarget.source !== 'StakingRewards') {
+								if (
+									!(stakingTokenMethod in stakingRewardsContract.methods) ||
+									!(rewardsTokenMethod in stakingRewardsContract.methods)
+								) {
 									({ stakingTokenMethod, rewardsTokenMethod } = methodMappings[
 										stakingRewardsTarget.source
 									]);

test/etherscan/index.js

@@ -8,12 +8,14 @@ const program = new commander.Command();
 
 program
 	.option('-n, --network <value>', 'The network to run off.', x => x.toLowerCase(), 'mainnet')
-	.action(async ({ network }) => {
+	.option('-g, --grep <value>', 'Any grep string')
+	.action(async ({ network, grep }) => {
 		// setup the network as an env variable
 		process.env.ETH_NETWORK = network;
 
 		const mocha = new Mocha({
 			timeout: 10e3, // 10 secs
+			grep,
 		});
 
 		// Add each .js file to the mocha instance

test/etherscan/spec.js

@@ -98,6 +98,12 @@ describe(`Etherscan on ${network}`, () => {
 				const { encodeFunctionSignature, encodeEventSignature } = web3.eth.abi;
 
 				for (const { type, inputs, name, signature } of abi) {
+					// when the ABI has no signature for an entry, skip it
+					// this happens when the ABIs weren't generated in a build but
+					// rather taken from Etherscan as was the case with early StakingRewards
+					if (!signature) {
+						continue;
+					}
 					if (type === 'function') {
 						assert.strictEqual(
 							encodeFunctionSignature({ name, inputs }),