Skip to content

Feat prettier#8

Merged
fanhousanbu merged 5 commits into
masterfrom
feat-prettier
Aug 26, 2025
Merged

Feat prettier#8
fanhousanbu merged 5 commits into
masterfrom
feat-prettier

Conversation

@fanhousanbu

Copy link
Copy Markdown
Collaborator

No description provided.

fanhousanbu and others added 5 commits August 26, 2025 19:10
Clean up unnecessary "Dynamic" prefixes and improve code readability:

- Simplified console output messages:
  • "Dynamic gas estimate" → "Gas estimate"
  • "Dynamic Gas Validator" → "Validator"
  • "Dynamic gas calculation optimization" → "Gas optimization"

- Updated configuration version naming:
  • "Dynamic Gas Version" → "v1.0"

- Maintained functionality while improving clarity
- Reduced verbosity in demo output
- Enhanced user experience with cleaner messages

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Simplified Foundry deployment scripts for better clarity:

Script Files:
- DeployDynamicGasValidator.s.sol → DeployValidator.s.sol
- RegisterKeysDynamicGas.s.sol → RegisterKeys.s.sol

Contract and Content Updates:
- DeployDynamicGasValidator → DeployValidator (contract name)
- RegisterKeysDynamicGas → RegisterKeys (contract name)
- Simplified console output messages
- Removed "Dynamic Gas" prefixes from descriptions

Documentation Updates:
- Updated README.md references to new script names
- Simplified forge command examples
- Updated project structure documentation
- Replaced "Dynamic Gas Calculation" → "Gas Optimization"

This maintains all functionality while improving code readability
and reducing unnecessary technical jargon in naming conventions.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Updated README.md to emphasize user responsibility for contract deployment:

Security & Responsibility:
- Added prominent security notice at the top
- Clarified that reference contracts are for testing only
- Emphasized users must deploy their own contracts for production

Documentation Changes:
- "Deployed Contracts" → "Contract Deployment"
- Separated "Required Contracts" from "Reference Deployment"
- Updated Quick Start to prioritize own deployment
- Enhanced Usage Guide with deployment emphasis
- Added environment variable setup instructions

User Guidance:
- Clear distinction between reference and production use
- Step-by-step deployment instructions
- Configuration guidance for own contracts
- Security best practices

This ensures users understand they should deploy their own contracts
rather than relying on the provided reference deployments.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Added comprehensive Prettier setup for the entire project:

Root Configuration:
- package.json: Added Prettier and prettier-plugin-solidity
- .prettierrc: Comprehensive formatting rules for all file types
- .prettierignore: Exclusions for generated files and configs

File-specific Rules:
- Solidity: 120 chars, 4-space tabs
- JavaScript/TypeScript: 100 chars, 2-space tabs
- Markdown: 80 chars, wrap always
- JSON: 80 chars, 2-space tabs

VS Code Integration:
- .vscode/settings.json: Auto-format on save
- .vscode/extensions.json: Recommended extensions

NPM Scripts:
- npm run format: Format all files
- npm run format:check: Check formatting
- npm run lint: Alias for format check
- npm run lint:fix: Alias for format

Benefits:
- Consistent code style across all languages
- Automated formatting in VS Code
- CI/CD integration ready
- Workspace configuration included

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
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.

1 participant