Introducing Caveat "Scopes"

[hanzel98]

📝 Description

Refactors the caveat builder architecture to support scoped configurations, and declarative Delegation configuration.

🔄 What Changed?

List the specific changes made:

• Introduced "Scopes" to define a base Unit of Authority for a delegation
• Updated createDelegation and createOpenDelegation to require a scope configuration (and Delegator Environment)

See https://www.notion.so/metamask-consensys/Scopes-22cf86d67d68801b93bdfb50416b789e for the different scopes, and permutations

🚀 Why?

Scopes: There is a significant risk that developers will (accidentally) create delegations with insufficient restrictions. Scopes reduce this likelihood, by ensuring all delegations start with a single unit of authority, that may be restricted further.

Declarative API: By defining the createDelegation and createOpenDelegation apis declaratively, it reduces the overhead for the developer to first create the caveat builder, then the delegation, they simply describe the delegation .

🧪 How to Test?

Describe how to test these changes:

• Manual testing steps:

1. Create a caveat builder using the new configuration-based API
2. Test scope-based caveat building functionality
3. Verify that existing caveat builder functionality still works with the new API

• Automated tests added/updated
• All existing tests pass

⚠️ Breaking Changes

List any breaking changes:

• No breaking changes
• Breaking changes (describe below):
  • createDelegation and createOpenDelegation now require an environment and scope, delegations without a scope must be manually created (intentional friction to create insecure delegations
  • resolveCaveats function signature updated to require environment and scope parameters
  • Some internal types and utility functions removed from public API

📋 Checklist

Check off completed items:

• Code follows the project's coding standards
• Self-review completed
• Documentation updated (if needed)
• Tests added/updated
• Changelog updated (if needed)
• All CI checks pass

🔗 Related Issues

[jeffsmale90]

Looking great!

[hanzel98]

Old PR #31

[cursor]

🚨 Bugbot Trial Expired

Your team's Bugbot trial has expired. Please contact your team administrator to turn on the paid plan to continue using Bugbot.

A team admin can activate the plan in the Cursor dashboard.

[jeffsmale90]

👍