[ADHOC] feat(sdk,EventAction): add msgSenderClaimant utility, test #221
Conversation
🦋 Changeset detectedLatest commit: 230780e The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| @@ -516,6 +519,29 @@ export class EventAction extends DeployableTarget< | |||
| params: ValidateActionStepParams, | |||
| ): Promise<Address | undefined> { | |||
| const signature = claimant.signature; | |||
|
|
|||
| // find message sender and return it | |||
| // WARNING: this is error prone in bridged transactions, as from will be exit node | |||
There was a problem hiding this comment.
Maybe it should be a dev note in the jsdocs that bridging and internal transactions aren't yet supported
| /** | ||
| * Creates an ActionClaimant object that represents the msg.sender as the claimant. | ||
| * This function is useful when you want to set up an action where the transaction sender | ||
| * (msg.sender in Solidity terms) is always considered the valid claimant, regardless of |
There was a problem hiding this comment.
Explicitly we should refer to this as from - we don't want the msg.sender confusion occurring in any external facing docs/comments
| @@ -516,6 +519,29 @@ export class EventAction extends DeployableTarget< | |||
| params: ValidateActionStepParams, | |||
| ): Promise<Address | undefined> { | |||
| const signature = claimant.signature; | |||
|
|
|||
| // find message sender and return it | |||
| // WARNING: this is error prone in bridged transactions, as from will be exit node | |||
There was a problem hiding this comment.
bridged transactions and SCW transactions
| @@ -482,6 +483,8 @@ export class EventAction extends DeployableTarget< | |||
| /** | |||
| * Derives the action claimant address from a transaction based on the provided ActionClaimant configuration. | |||
| * This method supports both event-based and function-based claimant derivation. | |||
| * **Important**: The claimant is considered to be `msg.sender` or `transaction.from` when `claimant.signature` is `zeroHash` or `claimant.fieldIndex` is 255. | |||
There was a problem hiding this comment.
Let's tighten this up to explicitly transaction.from since it's technically not msg.sender
|
|
||
| // find message sender and return it | ||
| // WARNING: this is error prone in bridged transactions, as from will be exit node | ||
| if (signature === zeroHash || claimant.fieldIndex === 255) { |
There was a problem hiding this comment.
I think claimant.fieldIndex === 255 wll be more consistent since signature === zeroHash will be default state. Unless there's a reason we need to support both. Feels less error prone.
🚨 Please review the guidelines for contributing to this repository.
Description
add
msgSenderClaimantutility to event actionadd tsdoc
add test
some autoformatting hath occured
💔 Thank you!