@graphprotocol/graph-cli
Version:
CLI for building for and deploying to The Graph
144 lines (143 loc) • 6.39 kB
JavaScript
import immutable from 'immutable';
import * as DataSourcesExtractor from '../../command-helpers/data-sources.js';
import ABI from './abi.js';
export default class EthereumSubgraph {
manifest;
resolveFile;
protocol;
constructor(options) {
this.manifest = options.manifest;
this.resolveFile = options.resolveFile;
this.protocol = options.protocol;
}
validateManifest() {
return this.validateAbis().concat(this.validateEvents()).concat(this.validateCallFunctions());
}
validateAbis() {
const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol);
return dataSourcesAndTemplates.reduce((errors, dataSourceOrTemplate) => errors.concat(this.validateDataSourceAbis(dataSourceOrTemplate.get('dataSource'), dataSourceOrTemplate.get('path'))), immutable.List());
}
validateDataSourceAbis(dataSource, path) {
// Validate that the "source > abi" reference of all data sources
// points to an existing ABI in the data source ABIs
const abiName = dataSource.getIn(['source', 'abi']);
const abiNames = dataSource.getIn(['mapping', 'abis']).map((abi) => abi.get('name'));
const nameErrors = abiNames.includes(abiName)
? immutable.List()
: immutable.fromJS([
{
path: [...path, 'source', 'abi'],
message: `\
ABI name '${abiName}' not found in mapping > abis.
Available ABIs:
${abiNames
.sort()
.map((name) => `- ${name}`)
.join('\n')}`,
},
]);
// Validate that all ABI files are valid
const fileErrors = dataSource
.getIn(['mapping', 'abis'])
.reduce((errors, abi, abiIndex) => {
try {
ABI.load(abi.get('name'), this.resolveFile(abi.get('file')));
return errors;
}
catch (e) {
return errors.push(immutable.fromJS({
path: [...path, 'mapping', 'abis', abiIndex, 'file'],
message: e.message,
}));
}
}, immutable.List());
return nameErrors.concat(fileErrors);
}
validateEvents() {
const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol);
return dataSourcesAndTemplates.reduce((errors, dataSourceOrTemplate) => {
return errors.concat(this.validateDataSourceEvents(dataSourceOrTemplate.get('dataSource'), dataSourceOrTemplate.get('path')));
}, immutable.List());
}
validateDataSourceEvents(dataSource, path) {
let abi;
try {
// Resolve the source ABI name into a real ABI object
const abiName = dataSource.getIn(['source', 'abi']);
const abiEntry = dataSource
.getIn(['mapping', 'abis'])
.find((abi) => abi.get('name') === abiName);
abi = ABI.load(abiEntry.get('name'), this.resolveFile(abiEntry.get('file')));
}
catch (_) {
// Ignore errors silently; we can't really say anything about
// the events if the ABI can't even be loaded
return immutable.List();
}
// Obtain event signatures from the mapping
const manifestEvents = dataSource
.getIn(['mapping', 'eventHandlers'], immutable.List())
.map((handler) => handler.get('event'));
// Obtain event signatures from the ABI
const abiEvents = abi.eventSignatures();
// Add errors for every manifest event signature that is not
// present in the ABI
return manifestEvents.reduce((errors, manifestEvent, index) => abiEvents.includes(manifestEvent)
? errors
: errors.push(immutable.fromJS({
path: [...path, 'eventHandlers', index],
message: `\
Event with signature '${manifestEvent}' not present in ABI '${abi.name}'.
Available events:
${abiEvents
.sort()
.map(event => `- ${event}`)
.join('\n')}`,
})), immutable.List());
}
validateCallFunctions() {
return this.manifest
.get('dataSources')
.filter((dataSource) => this.protocol.isValidKindName(dataSource.get('kind')))
.reduce((errors, dataSource, dataSourceIndex) => {
const path = ['dataSources', dataSourceIndex, 'callHandlers'];
let abi;
try {
// Resolve the source ABI name into a real ABI object
const abiName = dataSource.getIn(['source', 'abi']);
const abiEntry = dataSource
.getIn(['mapping', 'abis'])
.find((abi) => abi.get('name') === abiName);
abi = ABI.load(abiEntry.get('name'), this.resolveFile(abiEntry.get('file')));
}
catch (e) {
// Ignore errors silently; we can't really say anything about
// the call functions if the ABI can't even be loaded
return errors;
}
// Obtain event signatures from the mapping
const manifestFunctions = dataSource
.getIn(['mapping', 'callHandlers'], immutable.List())
.map((handler) => handler.get('function'));
// Obtain event signatures from the ABI
const abiFunctions = abi.callFunctionSignatures();
// Add errors for every manifest event signature that is not
// present in the ABI
return manifestFunctions.reduce((errors, manifestFunction, index) => abiFunctions.includes(manifestFunction)
? errors
: errors.push(immutable.fromJS({
path: [...path, index],
message: `\
Call function with signature '${manifestFunction}' not present in ABI '${abi.name}'.
Available call functions:
${abiFunctions
.sort()
.map(tx => `- ${tx}`)
.join('\n')}`,
})), errors);
}, immutable.List());
}
handlerTypes() {
return immutable.List(['blockHandlers', 'callHandlers', 'eventHandlers']);
}
}