Specifying a custom dir with "dirCircuits"

[cedoor]

If I specify a custom directory for my circuit templates (e.g. src) and run circomkit compile it still creates a circuits/main/circuit.circom folder for its component. It fails because the relative path generated within that circuit is wrong. "../circuit.circom" doesn't exist in that folder.

I think the right folder for components should be src/main/circuit.circom.

The following line could be the problem.

circomkit/src/utils/instantiate.ts

Line 42 in 0473d88

const targetDir = `./circuits/${directory}`;

Does it make sense? Or am I missing something?

[erhant]

Hello, thanks for the issue!

You are right, I believe I'd initially started as an opinionated repo where all circuits lay below circuits folder but then I added the configs, apparently forgot to connect this particular setting to instantiate.

There is a test for a custom path but there is no test for custom dir, so I think I will add a test for this as well.

I will fix it by exposing that directory config to instantiate + use that for targetDir. Probably tomorrow 🙏🏻
I will @ you when new version is published to NPM.

[cedoor]

@erhant Thanks for your quick reply, I'll wait for it. And great work, I really like this tool!

[erhant]

@cedoor heya, I believe the issue is fixed now & is published at v0.0.19

The test workflow failed because apparently the Circom installation fails in the workflow (#35 ) but the tests were passing locally™ for me. Please let me know if the issue is fixed on your end.

Also I wanted to ask for an opinion: the fix is as we have first discussed where Circomkit has a single dirCircuits and expects all circuits to be under there, and the rest of the path should be made via the file field of a circuit config. Would it make sense to also have an optional dirCircuits-like field for each circuit?

EDIT: Workflow bug is fixed & tests are pacito ✅

[cedoor]

@erhant It works 👍🏽 Thank you so much!

Also I wanted to ask for an opinion: the fix is as we have first discussed where Circomkit has a single dirCircuits and expects all circuits to be under there, and the rest of the path should be made via the file field of a circuit config. Would it make sense to also have an optional dirCircuits-like field for each circuit?

Yes, I think it makes sense and I'd probably need it soon :D

[erhant]

No problem!

Truly happy to hear that you enjoyed the lib & a pleasure to see PSE using it ❤️

I've created an issue about the aforementioned feature #37, I will look at it sometime soon, please @ me in that issue if you happen to need that urgently 👍🏻

[cedoor]

I've created an issue about the aforementioned feature #37, I will look at it sometime soon, please @ me in that issue if you happen to need that urgently 👍🏻

Sure! I think it's not urgent tho 👍🏽