Fix poa_getAllValidators endpoint

[Phanco]

What was the problem?

This PR resolves #8698

How was it solved?

Fix the line of comparing address

How was it tested?

Test cases passed

[codecov]

Codecov Report

Merging #8700 (bbd2052) into feature/6930-implement-poa-module (e5ee1a2) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@                        Coverage Diff                         @@
##           feature/6930-implement-poa-module    #8700   +/-   ##
==================================================================
  Coverage                              83.59%   83.59%           
==================================================================
  Files                                    610      610           
  Lines                                  22665    22667    +2     
  Branches                                3289     3289           
==================================================================
+ Hits                                   18946    18948    +2     
  Misses                                  3719     3719           

Impacted Files	Coverage Δ
framework/src/modules/poa/endpoint.ts	93.61% <100.00%> (+0.13%)	⬆️
framework/src/modules/poa/module.ts	96.94% <100.00%> (+0.02%)	⬆️

[sitetester]

• Data from getAllValidators endpoint is returning in unexpected sorting order on next execution. This can presumably cause build failure in future.
• Can modify like this to apply sorting

response.sort((v1, v2) => v1.name.localeCompare(v2.name, 'en'));
return { validators: response };

• Need one more test to differentiate between active & non active validator weight

it('should return json with empty weight for non active validator', async () => {
	await validatorStore.set(createStoreGetter(stateStore), address1, { name: 'validator1'});
	await validatorStore.set(createStoreGetter(stateStore), address2, { name: 'validator2' });
	const currentSnapshot = {
		threshold: BigInt(2),
		validators: [
			{
				address: address1,
				weight: BigInt(1),
			},
		],
	};
	await snapshotStore.set(createStoreGetter(stateStore), KEY_SNAPSHOT_0, currentSnapshot);

	const { validators: validatorsDataReturned } = await poaEndpoint.getAllValidators(
		createTransientModuleEndpointContext({ stateStore }),
	);

	expect(validatorsDataReturned[0].weight).toBe(currentSnapshot.validators[0].weight.toString());
	expect(validatorsDataReturned[1].weight).toBe('');
});

So the tests are passing anyway as both validators have same weight 1. If we change one of the weights, it will fail on next iteration.

- Also please add this comment above these lines

// Here we are checking against name sorted values
expect(validatorsDataReturned[0].weight).toBe(snapshot.validators[0].weight.toString());
expect(validatorsDataReturned[1].weight).toBe(snapshot.validators[1].weight.toString());

So 3 changes can be done in this PR

• Changing return type from ValidatorEndpoint to Validator
• Changing address2 weight to 2, here

const snapshot = {
		threshold: BigInt(2),
		validators: [
			{
				address: address1,
				weight: BigInt(1),
			},
			{
				address: address2,
				weight: BigInt(2), // ***
			},
		],
	};

& then removing unnecessary validatorsDataReturned from const { validators: validatorsDataReturned }

[sitetester]

Feedback submitted

[sitetester]

Comment updated with some more requested changes