Rename Signatory to Signer #76
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Rename
signatory
tosigner
in MetaMaskSmartAccount configuration to improve developer experience and API clarity.🔄 What Changed?
List the specific changes made:
signatory
parameter tosigner
inToMetaMaskSmartAccountParameters
typeSignatoryConfigByImplementation
→SignerConfigByImplementation
,InternalSignatory
→InternalSigner
, etc.WalletSignatoryConfig
→WalletSignerConfig
,AccountSignatoryConfig
→AccountSignerConfig
,HybridSignatoryConfig
→HybridSignerConfig
,MultiSigSignatoryConfig
→MultiSigSignerConfig
,WebAuthnSignatoryConfig
→WebAuthnSignerConfig
,Stateless7702SignatoryConfig
→Stateless7702SignerConfig
signatory.ts
file tosigner.ts
and updated all importsresolveSignatory
→resolveSigner
,resolveSignatoryFromWalletConfig
→resolveSignerFromWalletConfig
, etc.signatory
tosigner
signatory.ts
file🚀 Why?
Explain the motivation behind these changes:
signer
is more commonly understood in the web3 ecosystem thansignatory
🧪 How to Test?
Describe how to test these changes:
yarn lint
to ensure code formatting is correctyarn test
to verify all tests passyarn build
to ensure successful compilationList any breaking changes:
signatory
parameter inToMetaMaskSmartAccountParameters
is nowsigner
*SignatoryConfig
types are now*SignerConfig
types./signer
instead of./signatory
resolveSignatory
is nowresolveSigner
📋 Checklist
Check off completed items:
🔗 Related Issues
Link to related issues:
Closes #267 https://app.zenhub.com/workspaces/readable-permissions-67982ce51eb4360029b2c1a1/issues/gh/metamask/delegator-readable-permissions/267
📚 Additional Notes
This is a comprehensive breaking change that affects the public API. While the functionality remains exactly the same, any code using the MetaMaskSmartAccount configuration will need to update:
signatory:
tosigner:
in configuration objects*SignatoryConfig
to*SignerConfig
resolveSignatory
toresolveSigner