Skip to content

Improve Script Naming and Documentation #404

@rjan90

Description

@rjan90

Summary

Improve script names in service_contracts/tools/ to be more self-documenting and enhance README documentation with a comprehensive script reference table.

Priority Order

1. More Verbose Script Names (Highest Priority)

Make script names more explicit about the contracts they impact:

  • upgrade.sh → needs more descriptive name (e.g., upgrade-warm-storage.sh)
  • deploy-registry.shdeploy-service-provider-registry.sh
  • Similar updates for other ambiguous script names

2. Hierarchical Script Naming (Medium Priority)

Reorganize script names with prefixes for better lexicographical sorting and grouping:

Warm Storage Scripts:

  • warm-storage-deploy-all.sh
  • warm-storage-deploy-implementation-only.sh
  • warm-storage-announce-upgrade.sh
  • warm-storage-execute-upgrade.sh
  • warm-storage-deploy-view.sh

Service Provider Registry Scripts:

  • service-provider-registry-deploy.sh
  • service-provider-registry-announce-upgrade.sh
  • service-provider-registry-execute-upgrade.sh

Other Scripts:

  • provider-id-set-deploy.sh
  • session-key-registry-deploy.sh

Notes

Extracted from the comment in the PR here: #384 (comment)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

⌚️ Issue awaiting PR merge

Relationships

None yet

Development

No branches or pull requests

Issue actions