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

chore(claim_contracts): update README #1620

Open
wants to merge 3 commits into
base: testnet
Choose a base branch
from

Conversation

ManuelBilbao
Copy link
Contributor

@ManuelBilbao ManuelBilbao commented Dec 16, 2024

Update README

Description

Updated the README with new deployment instructions using Makefile

Type of change

Please delete options that are not relevant.

  • New feature
  • Bug fix
  • Optimization
  • Refactor

Checklist

  • “Hotfix” to testnet, everything else to staging
  • Linked to Github Issue
  • This change depends on code or research by an external entity
    • Acknowledgements were updated to give credit
  • Unit tests added
  • This change requires new documentation.
    • Documentation has been added/updated.
  • This change is an Optimization
    • Benchmarks added/run
  • Has a known issue
  • If your PR changes the Operator compatibility (Ex: Upgrade prover versions)
    • This PR adds compatibility for operator for both versions and do not change batcher/docs/examples
    • This PR updates batcher and docs/examples to the newer version. This requires the operator are already updated to be compatible

Copy link
Collaborator

@JuArce JuArce left a comment

Choose a reason for hiding this comment

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

I left some comments. But the functionality is ok

To deploy the token, modify the file `script-config/config.example.json` and set the following values:

- `safe`: The address of the safe that's going to own the Proxy admin that in turn owns the token and airdrop contracts.
- `salt`: The salt used to generate CREATE2 addresses.
Copy link
Collaborator

Choose a reason for hiding this comment

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

How should the salt be generated?


- `safe`: The address of the safe that's going to own the Proxy admin that in turn owns the token and airdrop contracts.
- `salt`: The salt used to generate CREATE2 addresses.
- `deployer`: The address of the account that's going to deploy the contracts.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Specify that deployer must be a CREATE2 deterministic deploy factory

- `foundation`: The address of the Aligned Foundation account.
- `claimSupplier`: The address of the account that's going to supply the tokens.
- `limitTimestampToClaim`: The claim time limit timestamp.
- `claimMerkleRoot`: The merkle root of all valid token claims.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The json file includes claimSupplierPrivateKey. Should we have it?

@ManuelBilbao
Copy link
Contributor Author

I think #1629 already solved this

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.

5 participants