Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion contracts/utils/structs/EnumerableMapExtended.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
// This file was procedurally generated from scripts/generate/templates/EnumerableMapExtended.js.
// This file was procedurally generated from scripts/generate/templates/EnumerableMapExtended.sol.eta.

pragma solidity ^0.8.24;

Expand Down
2 changes: 1 addition & 1 deletion contracts/utils/structs/EnumerableSetExtended.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
// This file was procedurally generated from scripts/generate/templates/EnumerableSetExtended.js.
// This file was procedurally generated from scripts/generate/templates/EnumerableSetExtended.sol.eta.

pragma solidity ^0.8.24;

Expand Down
15 changes: 15 additions & 0 deletions scripts/generate/data.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
export const TYPES = Object.fromEntries(
[
{ name: 'Uint', type: 'uint256', size: 0, memory: false },
{ name: 'String', type: 'string', size: 0, memory: true },
{ name: 'Bytes', type: 'bytes', size: 0, memory: true },
{ name: 'Bytes32x2', type: 'bytes32[2]', size: 2, memory: true, base: 'bytes32' },
].map(t => [t.name, { ...t, typeLoc: t.memory ? `${t.type} memory` : t.type }]),
);

export const SET_TYPES = [{ name: 'Bytes32x2Set', value: TYPES.Bytes32x2 }];

export const MAP_TYPES = [
{ name: 'BytesToUintMap', keySet: { name: 'BytesSet' }, key: TYPES.Bytes, value: TYPES.Uint },
{ name: 'StringToStringMap', keySet: { name: 'StringSet' }, key: TYPES.String, value: TYPES.String },
];
14 changes: 0 additions & 14 deletions scripts/generate/format-lines.js

This file was deleted.

63 changes: 31 additions & 32 deletions scripts/generate/run.js
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
#!/usr/bin/env node

import cp from 'child_process';
import fs from 'fs';
import path from 'path';
import format from './format-lines.js';
import prettier from 'prettier';
import { Eta } from 'eta';

function getVersion(path) {
try {
return fs.readFileSync(path, 'utf8').match(/\/\/ OpenZeppelin Contracts \(last updated v[^)]+\)/)[0];
} catch {
return null;
}
}
import * as context from './data.js';

const repoRoot = path.join(import.meta.dirname, '../..');
const templatesDir = path.join(import.meta.dirname, 'templates');
const eta = new Eta({ views: templatesDir, autoEscape: false, autoTrim: false, defaultExtension: '' });

async function generateFromTemplate(file, template, outputPrefix = '', lint = false) {
const script = path.relative(path.join(import.meta.dirname, '../..'), import.meta.filename);
const input = path.join(path.dirname(script), template);
const output = path.join(outputPrefix, file);
const version = getVersion(output);
const content = format(
for (const [filepath, needsPrettier] of Object.entries({
'contracts/utils/structs/EnumerableSetExtended.sol': false,
'contracts/utils/structs/EnumerableMapExtended.sol': true,
})) {
console.log(`Generating ${filepath}...`);
const template = `${path.basename(filepath)}.eta`;
const input = path.relative(repoRoot, path.join(templatesDir, template));
const version =
fs.existsSync(filepath) &&
fs.readFileSync(filepath, 'utf8').match(/^\/\/ OpenZeppelin Contracts \(last updated v[^)]+\) \([^)]+\)$/m)?.[0];
const content = [
'// SPDX-License-Identifier: MIT',
...(version ? [version + ` (${file})`] : []),
...(version ? [version] : []),
`// This file was procedurally generated from ${input}.`,
'',
(await import(template)).default.trimEnd(),
);
eta.render(template, context),
].join('\n');

fs.mkdirSync(path.dirname(output), { recursive: true });
fs.writeFileSync(output, content);
lint && cp.execFileSync('prettier', ['--write', output]);
}

// Some templates needs to go through the linter after generation
const needsLinter = ['utils/structs/EnumerableMapExtended.sol'];

// Contracts
for (const [file, template] of Object.entries({
'utils/structs/EnumerableSetExtended.sol': './templates/EnumerableSetExtended.js',
'utils/structs/EnumerableMapExtended.sol': './templates/EnumerableMapExtended.js',
})) {
await generateFromTemplate(file, template, './contracts/', needsLinter.includes(file));
await (
needsPrettier
? prettier
.resolveConfig(filepath)
.then(prettierConfig => prettier.format(content, { ...prettierConfig, filepath }))
: Promise.resolve(content)
).then(formatted => {
fs.mkdirSync(path.dirname(filepath), { recursive: true });
fs.writeFileSync(filepath, formatted);
});
}
32 changes: 0 additions & 32 deletions scripts/generate/templates/Enumerable.opts.js

This file was deleted.

212 changes: 0 additions & 212 deletions scripts/generate/templates/EnumerableMapExtended.js

This file was deleted.

Loading
Loading