Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KA Validation fix + Provider init fix + Additional logs #2761

Merged
merged 5 commits into from
Nov 6, 2023
Merged

KA Validation fix + Provider init fix + Additional logs #2761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
893f310
Fix KA validation on publish/update to check if assertion ID is 0x0, …
u-hubar Nov 6, 2023
edeb4b4
Removed hotfix suffix from the version
u-hubar Nov 6, 2023
b80eb28
Updated provider debugging
u-hubar Nov 6, 2023
1ee2d09
Only try to get contract instance for call/estimateGas inside provide…
u-hubar Nov 6, 2023
702aa54
Turned off provider debugging
u-hubar Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "origintrail_node",
"version": "6.0.18+hotfix.1",
"version": "6.0.18",
"description": "OTNode V6",
"main": "index.js",
"type": "module",
Expand Down
9 changes: 7 additions & 2 deletions src/commands/common/validate-asset-command.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import Command from '../command.js';
import { ERROR_TYPE, OPERATION_ID_STATUS, LOCAL_STORE_TYPES } from '../../constants/constants.js';
import {
ERROR_TYPE,
OPERATION_ID_STATUS,
LOCAL_STORE_TYPES,
ZERO_BYTES32,
} from '../../constants/constants.js';

class ValidateAssetCommand extends Command {
constructor(ctx) {
Expand Down Expand Up @@ -43,7 +48,7 @@ class ValidateAssetCommand extends Command {
tokenId,
);
}
if (!blockchainAssertionId) {
if (!blockchainAssertionId || blockchainAssertionId === ZERO_BYTES32) {
return Command.retry();
}
const cachedData = await this.operationIdService.getCachedOperationIdData(operationId);
Expand Down
155 changes: 110 additions & 45 deletions src/modules/blockchain/implementation/web3-service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ class Web3Service {
await this.initializeWeb3();
this.startBlock = await this.getBlockNumber();
await this.initializeContracts();
// this.initializeProviderDebugging();
}

initializeTransactionQueue(concurrency) {
Expand Down Expand Up @@ -92,24 +93,26 @@ class Web3Service {
}

async initializeWeb3() {
const rpcProviders = [];
const providers = [];
for (const rpcEndpoint of this.config.rpcEndpoints) {
const isWebSocket = rpcEndpoint.startsWith('ws');
const Provider = isWebSocket
? ethers.providers.WebSocketProvider
: ethers.providers.JsonRpcProvider;
const priority = isWebSocket ? WS_RPC_PROVIDER_PRIORITY : HTTP_RPC_PROVIDER_PRIORITY;

try {
if (rpcEndpoint.startsWith('ws')) {
rpcProviders.push({
provider: new ethers.providers.WebSocketProvider(rpcEndpoint),
priority: WS_RPC_PROVIDER_PRIORITY,
weight: 1,
stallTimeout: RPC_PROVIDER_STALL_TIMEOUT,
});
} else {
rpcProviders.push({
provider: new ethers.providers.JsonRpcProvider(rpcEndpoint),
priority: HTTP_RPC_PROVIDER_PRIORITY,
weight: 1,
stallTimeout: RPC_PROVIDER_STALL_TIMEOUT,
});
}
const provider = new Provider(rpcEndpoint);
// eslint-disable-next-line no-await-in-loop
await provider.getNetwork();

providers.push({
provider,
priority,
weight: 1,
stallTimeout: RPC_PROVIDER_STALL_TIMEOUT,
});

this.logger.debug(`Connected to the blockchain RPC: ${rpcEndpoint}.`);
} catch (e) {
this.logger.warn(`Unable to connect to the blockchain RPC: ${rpcEndpoint}.`);
Expand All @@ -118,22 +121,24 @@ class Web3Service {

try {
this.provider = new ethers.providers.FallbackProvider(
rpcProviders,
providers,
FALLBACK_PROVIDER_QUORUM,
);

// eslint-disable-next-line no-await-in-loop
await this.providerReady();
} catch (e) {
throw Error(
`RPC Fallback Provider initialization failed. Fallback Provider quorum: ${FALLBACK_PROVIDER_QUORUM}. Error: ${e.message}.`,
);
}

// eslint-disable-next-line no-await-in-loop
await this.providerReady();

this.wallet = new ethers.Wallet(this.getPrivateKey(), this.provider);
}

async initializeContracts() {
this.contractAddresses = {};

this.logger.info(
`Initializing contracts with hub contract address: ${this.config.hubContractAddress}`,
);
Expand All @@ -142,6 +147,7 @@ class Web3Service {
ABIs.Hub,
this.wallet,
);
this.contractAddresses[this.config.hubContractAddress] = this.HubContract;

const contractsArray = await this.callContractFunction(
this.HubContract,
Expand Down Expand Up @@ -178,12 +184,55 @@ class Web3Service {
await this.logBalances();
}

initializeProviderDebugging() {
this.provider.on('debug', (info) => {
const { method } = info.request;

if (['call', 'estimateGas'].includes(method)) {
const contractInstance = this.contractAddresses[info.request.params.to];
const inputData = info.request.params.data;
const decodedInputData = this._decodeInputData(
inputData,
contractInstance.interface,
);

if (info.backend.error) {
const decodedErrorData = this._decodeErrorData(
info.backend.error,
contractInstance.interface,
);
this.logger.debug(
`${decodedInputData} ${method} has failed; Error: ${decodedErrorData}; ` +
`RPC: ${info.backend.provider.connection.url}.`,
);
} else if (info.backend.result !== undefined) {
let message = `${decodedInputData} ${method} has been successfully executed; `;

if (info.backend.result !== null) {
const decodedResultData = this._decodeResultData(
inputData.slice(0, 10),
info.backend.result,
contractInstance.interface,
);
message += `Result: ${decodedResultData} `;
}

message += `RPC: ${info.backend.provider.connection.url}.`;

this.logger.debug(message);
}
}
});
}

initializeAssetStorageContract(assetStorageAddress) {
this.assetStorageContracts[assetStorageAddress.toLowerCase()] = new ethers.Contract(
assetStorageAddress,
ABIs.ContentAssetStorage,
this.wallet,
);
this.contractAddresses[assetStorageAddress] =
this.assetStorageContracts[assetStorageAddress.toLowerCase()];
}

initializeScoringContract(id, contractAddress) {
Expand All @@ -195,6 +244,7 @@ class Web3Service {
ABIs[contractName],
this.wallet,
);
this.contractAddresses[contractAddress] = this.scoringFunctionsContracts[id];
} else {
this.logger.trace(
`Skipping initialisation of contract with id: ${id}, address: ${contractAddress}`,
Expand All @@ -209,6 +259,7 @@ class Web3Service {
ABIs[contractName],
this.wallet,
);
this.contractAddresses[contractAddress] = this[`${contractName}Contract`];
} else {
this.logger.trace(
`Skipping initialisation of contract: ${contractName}, address: ${contractAddress}`,
Expand Down Expand Up @@ -343,8 +394,12 @@ class Web3Service {
// eslint-disable-next-line no-await-in-loop
result = await contractInstance[functionName](...args);
} catch (error) {
const decodedErrorData = this._decodeErrorData(error, contractInstance.interface);
// eslint-disable-next-line no-await-in-loop
await this.handleError(error, functionName);
await this.handleError(
Error(`Call failed, reason: ${decodedErrorData}`),
functionName,
);
}
}

Expand All @@ -363,19 +418,19 @@ class Web3Service {
/* eslint-disable no-await-in-loop */
gasLimit = await contractInstance.estimateGas[functionName](...args);
} catch (error) {
const decodedReturnData = this._decodeReturnData(error, contractInstance.interface);
const decodedErrorData = this._decodeErrorData(error, contractInstance.interface);
await this.handleError(
Error(`gas estimation failed, reason: ${decodedReturnData}`),
Error(`Gas estimation failed, reason: ${decodedErrorData}`),
functionName,
);
}

gasLimit = gasLimit ?? this.convertToWei(900, 'kwei');

this.logger.info(
'Sending signed transaction to blockchain, calling method: ' +
`${functionName} with gas limit: ${gasLimit.toString()} and gasPrice ${gasPrice.toString()}. ` +
`Transaction queue length: ${this.getTransactionQueueLength()}`,
this.logger.debug(
`Sending signed transaction ${functionName} to the blockchain ` +
`with gas limit: ${gasLimit.toString()} and gasPrice ${gasPrice.toString()}. ` +
`Transaction queue length: ${this.getTransactionQueueLength()}.`,
);

try {
Expand All @@ -393,23 +448,17 @@ class Web3Service {
await this.provider.call(tx, tx.blockNumber);
}
} catch (error) {
const decodedReturnData = this._decodeReturnData(error, contractInstance.interface);
this.logger.warn(
`Failed executing smart contract function ${functionName}. Error: ${decodedReturnData}`,
);
const decodedErrorData = this._decodeErrorData(error, contractInstance.interface);
if (
!transactionRetried &&
(error.message.includes(`timeout exceeded`) ||
error.message.includes(`Pool(TooLowPriority`))
) {
gasPrice = Math.ceil(gasPrice * 1.2);
this.logger.warn(
`Retrying to execute smart contract function ${functionName} with gasPrice: ${gasPrice}`,
);
transactionRetried = true;
} else {
await this.handleError(
Error(`transaction reverted, reason: ${decodedReturnData}`),
Error(`Transaction reverted, reason: ${decodedErrorData}`),
functionName,
);
}
Expand All @@ -418,7 +467,7 @@ class Web3Service {
return result;
}

_getReturnData(error) {
_getErrorData(error) {
let nestedError = error;
while (nestedError && nestedError.error) {
nestedError = nestedError.error;
Expand All @@ -442,23 +491,31 @@ class Web3Service {
return returnData;
}

_decodeReturnData(evmError, contractInterface) {
let returnData;
_decodeInputData(inputData, contractInterface) {
if (inputData === ZERO_PREFIX) {
return 'Empty input data.';
}

return contractInterface.decodeFunctionData(inputData.slice(0, 10), inputData);
}

_decodeErrorData(evmError, contractInterface) {
let errorData;

try {
returnData = this._getReturnData(evmError);
errorData = this._getErrorData(evmError);
} catch (error) {
return error.message;
}

// Handle empty error data
if (returnData === ZERO_PREFIX) {
if (errorData === ZERO_PREFIX) {
return 'Empty error data.';
}

// Handle standard solidity string error
if (returnData.startsWith(SOLIDITY_ERROR_STRING_PREFIX)) {
const encodedReason = returnData.slice(SOLIDITY_ERROR_STRING_PREFIX.length);
if (errorData.startsWith(SOLIDITY_ERROR_STRING_PREFIX)) {
const encodedReason = errorData.slice(SOLIDITY_ERROR_STRING_PREFIX.length);
try {
return ethers.utils.defaultAbiCoder.decode(['string'], `0x${encodedReason}`)[0];
} catch (error) {
Expand All @@ -467,8 +524,8 @@ class Web3Service {
}

// Handle solidity panic code
if (returnData.startsWith(SOLIDITY_PANIC_CODE_PREFIX)) {
const encodedReason = returnData.slice(SOLIDITY_PANIC_CODE_PREFIX.length);
if (errorData.startsWith(SOLIDITY_PANIC_CODE_PREFIX)) {
const encodedReason = errorData.slice(SOLIDITY_PANIC_CODE_PREFIX.length);
let code;
try {
[code] = ethers.utils.defaultAbiCoder.decode(['uint256'], `0x${encodedReason}`);
Expand All @@ -481,7 +538,7 @@ class Web3Service {

// Try parsing a custom error using the contract ABI
try {
const decodedCustomError = contractInterface.parseError(returnData);
const decodedCustomError = contractInterface.parseError(errorData);
const formattedArgs = decodedCustomError.errorFragment.inputs
.map((input, i) => {
const argName = input.name;
Expand All @@ -495,6 +552,14 @@ class Web3Service {
}
}

_decodeResultData(fragment, resultData, contractInterface) {
if (resultData === ZERO_PREFIX) {
return 'Empty input data.';
}

return contractInterface.decodeFunctionResult(fragment, resultData);
}

_formatCustomErrorArgument(value) {
if (value === null || value === undefined) {
return 'null';
Expand Down