feat: initial import

Author: andreas-timm

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: andreas-timm

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  BASH_ENV: ~/.profile
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./scripts
+    steps:
+      - uses: actions/checkout@v4
+      - run: curl https://get.volta.sh | bash
+      - run: npm i ci
+      - run: npm run test

.gitignore

@@ -0,0 +1,4 @@
+/.idea/
+/node_modules/
+/dist/
+tmp/

LICENSE

@@ -0,0 +1,46 @@
+# Solidity preprocessor
+
+[![test](https://github.com/andreas-timm/solidity-preprocessor/actions/workflows/test.yml/badge.svg)](https://github.com/andreas-timm/solidity-preprocessor/actions/workflows/test.yml)
+
+## Motivation
+
+
+## Usage
+```solidity
+// TestNft1155.sol
+// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity ^0.8.25;
+
+import {ERC1155} from "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
+
+contract TestNft1155 is ERC1155 {
+    constructor(string memory uri_) ERC1155(uri_) {
+        _mint(address(0), 1, 100, "");
+    }
+}
+```
+
+```ts
+import { preprocessor } from "@andreas-timm/solidity-preprocessor";
+
+const res = await preprocessor({path: 'contracts/TestNft1155.sol', replace: [
+  ['_mint(address(0), 1, 100, "")', '_mint(0x630C6C3180d3b4B6912644D046f6769dA3e54843, 1, 10000, "")']
+]});
+
+console.log(res.bytecode);
+```
+
+## License
+[![CC BY 4.0][cc-by-shield]][cc-by]
+
+This work is licensed under a [Creative Commons Attribution 4.0 International License][cc-by].
+
+[![CC BY 4.0][cc-by-image]][cc-by]
+
+[cc-by]: http://creativecommons.org/licenses/by/4.0/
+[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
+[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
+
+- [LICENSE](https://github.com/andreas-timm//blob/main/LICENSE)
+- Author: [Andreas Timm](https://github.com/andreas-timm)

README.md

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity ^0.8.25;
+
+import {ERC1155} from "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
+
+contract TestNft1155 is ERC1155 {
+    constructor(string memory uri_) ERC1155(uri_) {
+        _mint(address(0), 1, 100, "");
+        _mint(address(1), 1, 100, "");
+    }
+}

contracts/TestNft1155.sol

@@ -0,0 +1,6 @@
+import { HardhatUserConfig } from 'hardhat/config'
+
+const hardhatConfig: HardhatUserConfig = {}
+
+// noinspection JSUnusedGlobalSymbols
+export default hardhatConfig

hardhat.config.ts

@@ -0,0 +1,40 @@
+{
+    "name": "@andreas-timm/solidity-preprocessor",
+    "description": "Solidity preprocessor",
+    "version": "0.1.5",
+    "keywords": [
+        "contract",
+        "hardhat",
+        "preprocessing",
+        "solidity",
+        "typescript",
+        "viem"
+    ],
+    "author": "Andreas Timm <info@andreas-timm.dev>",
+    "license": "CC-BY-4.0",
+    "homepage": "https://github.com/andreas-timm/solidity-preprocessor#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/andreas-timm/solidity-preprocessor.git"
+    },
+    "bugs": {
+        "url": "https://github.com/andreas-timm/solidity-preprocessor/issues"
+    },
+    "type": "module",
+    "devDependencies": {
+        "@openzeppelin/contracts": "^5.0.2",
+        "hardhat": "^2.22.6",
+        "solc": "^0.8.26",
+        "tsx": "^4.16.2",
+        "typescript": "^5.5.3",
+        "viem": "^2.17.3"
+    },
+    "scripts": {
+        "build": "scripts/build.sh",
+        "publish": "cd dist; npm publish --access public",
+        "test": "node --import tsx --test tests/*"
+    },
+    "volta": {
+        "node": "20.15.1"
+    }
+}

package-lock.json

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+set -e
+
+rm -rf dist
+tsc -p tsconfig.json
+tsc -p tsconfig-cjs.json
+
+cp README.md dist/
+mkdir dist/src
+cp src/preprocessor.ts dist/src/
+
+COPY_FIELDS=(
+    name
+    description
+    version
+    keywords
+    author
+    license
+    homepage
+    repository
+    bugs
+    publishConfig
+)
+
+cd dist
+npm init -y > /dev/null
+
+for field in "${COPY_FIELDS[@]}"; do
+    npm pkg set --json "${field}"="$(npm --prefix=.. pkg get --json "${field}")"
+done
+
+npm pkg delete scripts
+npm pkg delete directories
+npm pkg set main=./lib/cjs/preprocessor.js
+npm pkg set module=./lib/esm/preprocessor.js
+
+cat package.json

package.json

@@ -0,0 +1 @@
+declare module 'solc'

scripts/build.sh

@@ -0,0 +1,77 @@
+// SPDX-License-Identifier: CC-BY-4.0
+// This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.
+// To view a copy of this license, visit https://creativecommons.org/licenses/by/4.0/
+// Author: Andreas Timm
+// Repository: https://github.com/andreas-timm/solidity-preprocessor
+// Version: 0.1.0
+// @sha256sum 0x71568cb01d71b42d7e1ec017579f152776ddae32dfe46edcf4168e244e36998b
+// @eip191signature 0x7b4005a62ff7c445fafef58ccd0ebb20eca6d4bffe2ec7aa34aa8e285d643eb7682459f0b42d1dd759d6002362b3c2479b3c18917586934a01e74b6811627e981b
+import hre from 'hardhat'
+import { Abi } from 'viem'
+import solc from 'solc'
+import { basename } from 'path'
+
+export type PreprocessArgs = {
+    path: string
+    callback?: (input: string) => string
+    replaces?: [string | RegExp, string][]
+}
+
+export type PreprocessResult = {
+    output: Record<string, any>
+    flattened: string
+    abi: Abi
+    bytecode: `0x${string}`
+    size: number
+}
+
+export class PreprocessError extends Error {
+    errors: any[]
+
+    constructor(errors: any[]) {
+        super(errors.map((i) => i.formattedMessage).join('\n'))
+        this.name = this.constructor.name
+        this.errors = errors
+    }
+}
+
+export const preprocess = async (args: PreprocessArgs): Promise<PreprocessResult> => {
+    let flattened = await hre.run('flatten:get-flattened-sources', { files: [args.path] })
+
+    const name = basename(args.path)
+    const stem = name.split('.')[0]
+
+    if (args.replaces) {
+        flattened = args.replaces.reduce((acc, item) => acc.replace(item[0], item[1]), flattened)
+    }
+
+    if (args.callback) {
+        flattened = args.callback(flattened)
+    }
+
+    const input = {
+        language: 'Solidity',
+        sources: { [name]: { content: flattened } },
+        settings: {
+            outputSelection: {
+                '*': {
+                    '*': ['*'],
+                },
+            },
+        },
+    }
+
+    const output = JSON.parse(solc.compile(JSON.stringify(input)))
+
+    if (output.errors) {
+        throw new PreprocessError(output.errors)
+    }
+
+    return {
+        output,
+        flattened,
+        abi: output.contracts[name][stem].abi as Abi,
+        bytecode: `0x${output.contracts[name][stem].evm.bytecode.object}`,
+        size: output.contracts[name][stem].evm.deployedBytecode.object.length / 2,
+    }
+}

src/index.d.ts

@@ -0,0 +1,19 @@
+import { preprocess } from '../src/preprocessor'
+import test from 'node:test'
+import assert from 'node:assert'
+
+test('TestNft1155', async () => {
+  const addr = '0x630C6C3180d3b4B6912644D046f6769dA3e54843'
+  const replace_1 = `_mint(${addr}, 1, 10000, "")`
+  const replace_2 = `_mint(${addr}, 2, 11000, "")`
+
+  const res: any = await preprocess({
+    path: 'contracts/TestNft1155.sol',
+    replaces: [['_mint(address(0), 1, 100, "")', replace_1]],
+    callback: (input: string) => input.replace('_mint(address(1), 1, 100, "")', replace_2)
+  })
+
+  const assembly = res.output.contracts['TestNft1155.sol'].TestNft1155.evm.assembly
+  assert.notEqual(assembly.split('\n').findIndex((line: string) => line.includes(replace_1)), -1, 'replace 1')
+  assert.notEqual(assembly.split('\n').findIndex((line: string) => line.includes(replace_2)), -1, 'replace 2')
+})

src/preprocessor.ts

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "module": "CommonJS",
+        "outDir": "./dist/lib/cjs"
+    }
+}

tests/test.ts

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "module": "esnext",
+        "strict": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "moduleResolution": "node",
+        "skipLibCheck": true,
+        "outDir": "./dist/lib/esm",
+        "declaration": true
+    },
+    "include": [
+        "./src"
+    ]
+}