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

docs: update README with deployment instructions #20

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Conversation

0x-r4bbit
Copy link
Contributor

Also point to MiniMeToken fork to avoid confusion.

Checklist

Ensure you completed all of the steps below before submitting your pull request:

  • Added natspec comments?
  • Ran forge snapshot?
  • Ran pnpm lint?
  • Ran forge test?

@0x-r4bbit 0x-r4bbit requested a review from 3esmit October 5, 2023 13:59
README.md Outdated

To everything work, .env needs to be created out of .env.example.
You can omit the `--broadcast` option to simulate the deployment before actually performing it.
`npx hardhat run scripts/deploySNT.js --network <network>` -> deploy to Optimism chain with the `contracts.json`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this one we can remove no?
There's no hardhat in this repo anymore.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, hardhat stuff can be removed, or updated to forge equivalents.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, so for the deploySNT script I've removed the instructions as I don't think this repo needs to deploy SNT.
A deployment script of the OptimismMintableMiniMeToken lives under script now.

I kept the index.js file around for reference. I'm not sure our friends at Certora are actually running deploy scripts for the audit.

README.md Outdated

To everything work, .env needs to be created out of .env.example.
You can omit the `--broadcast` option to simulate the deployment before actually performing it.
`npx hardhat run scripts/deploySNT.js --network <network>` -> deploy to Optimism chain with the `contracts.json`
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, hardhat stuff can be removed, or updated to forge equivalents.

@0x-r4bbit 0x-r4bbit force-pushed the refactor/rename-placeholder branch from a77dda5 to 54a761b Compare October 6, 2023 06:40
Base automatically changed from refactor/rename-placeholder to master October 6, 2023 08:03
Also point to MiniMeToken fork to avoid confusion.
@0x-r4bbit 0x-r4bbit merged commit 20a97c2 into master Oct 6, 2023
4 checks passed
@0x-r4bbit 0x-r4bbit deleted the docs/readme branch October 6, 2023 08:40
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.

2 participants