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.

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

Repository Initialization #1

Merged
merged 11 commits into from
Sep 27, 2024
Merged

Repository Initialization #1

merged 11 commits into from
Sep 27, 2024

Conversation

0xjei
Copy link
Member

@0xjei 0xjei commented Sep 21, 2024

The idea here is to get the Excubiae project up and running with a basic boilerplate to test the configs. As a general rule, we look to the best-maintained and best-configured TS projects in PSE as guidance. Some examples include semaphore and zk-kit.

The contracts package supports both hardhat and foundry. Therefore, the contracts package needs to be renamed for the necessary remappings, and so some configs have been moved around to minimise duplication.

@0xjei 0xjei self-assigned this Sep 21, 2024
@0xjei 0xjei requested a review from ctrlc03 September 23, 2024 14:43
Copy link
Member

@cedoor cedoor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't gone into deep but the overall structure looks great! 🚀

.github/workflows/pull-requests.yml Outdated Show resolved Hide resolved
.github/workflows/pull-requests.yml Outdated Show resolved Hide resolved
Copy link

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just left some questions

@@ -0,0 +1,61 @@
{
"name": "excubiae",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no version?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's no need for a version on the root package.json since is a monorepo.

@@ -0,0 +1,10 @@
# core
DEFAULT_NETWORK=hardhat
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where's this used? iirc in hardhat the hardhat network is the default already

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can be helpful for custom default networks (running nodes different from current hardhat environment / network).

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh right thought it'd be more convenient to pass --network $NETWORK to the command so you don't have to switch env var but this works too

@@ -0,0 +1,30 @@
{
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why two package.json in this package?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this makes easy to release just the contracts and avoid carrying on a huge bundle of configs & other dev env packages. This is the default project structure when using hardhat.

@0xjei 0xjei requested a review from ctrlc03 September 26, 2024 17:30
Copy link

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go!!! 🚀

@0xjei 0xjei merged commit fe1c502 into dev Sep 27, 2024
2 checks passed
@0xjei 0xjei deleted the chore/boilerplate branch September 27, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants