Align recently added features with SDK v2 conventions #481
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jakub Dzikowski <[email protected]>
Signed-off-by: Jakub Dzikowski <[email protected]>
- Updated `BurnAndMintDto` to extend `SubmitCallDTO` instead of `ChainCallDTO`. - Made `roles` in `UserProfile` optional and updated related types to ensure consistency. - Changed `identityKey` in `ChainUserAPI` to use `UserAlias`. - Adjusted user role handling in various tests and services to accommodate the new optional roles structure. - Updated return types in `getUserProfile` functions to use `UserProfileWithRoles` for better type safety. These changes enhance type safety and align the code with the latest SDK conventions. Signed-off-by: Jakub Dzikowski <[email protected]>
Signed-off-by: Jakub Dzikowski <[email protected]>
- Updated multiple DTOs (RequestTokenBridgeOutDto, OraclePriceCrossRateAssertionDto, OracleBridgeFeeAssertionDto) to extend SubmitCallDTO instead of ChainCallDTO - Modified GalaTransaction authentication logic to handle default roles more flexibly - Adjusted condition order in burnTokens function for better readability - Removed unused import in validateMintRequest These changes continue the ongoing refactoring to align with SDK v2 conventions and improve type safety. Signed-off-by: Jakub Dzikowski <[email protected]>
- Introduced new `getCaIdentityAlias` function to extract user identity from CA certificates - Modified `fulfillMintRequest` to pass calling user explicitly - Updated `constructVerifiedMints` to accept calling user as a parameter - Refactored mint-related functions to improve user identity handling - Removed direct context user access in some functions This change improves the flexibility of user identity extraction and provides more explicit user context in mint-related operations. Signed-off-by: Jakub Dzikowski <[email protected]>
dzikowski
commented
Feb 3, 2025
| @@ -484,3 +484,17 @@ export class FetchTokenMintConfigurationsResponse extends ChainCallDTO { | |||
| @IsString() | |||
| bookmark: string; | |||
| } | |||
|
|
|||
| export class DeleteTokenMintConfigurationDto extends SubmitCallDTO { | |||
There was a problem hiding this comment.
It is required to provide some additional dtos, since the default used (like TokenClassKey does not have uniqueKey defined)
dzikowski
commented
Feb 3, 2025
Comment on lines
-183
to
+196
| // it means a request where authorization is not required. Intentionally misses alias field | ||
| ctx.callingUserData = { roles: [UserRole.EVALUATE] }; | ||
| // it means a request where authorization is not required. If there is org-based authorization, | ||
| // default roles are applied. If not, then only evaluate is possible. Alias is intentionally | ||
| // missing. | ||
| const roles = !options.allowedOrgs?.length ? [UserRole.EVALUATE] : [...UserProfile.DEFAULT_ROLES]; | ||
| ctx.callingUserData = { roles }; |
There was a problem hiding this comment.
it's related with Fulfill* calls. If we use org-based authorization, we can make authorization less strict, and allow submit calls, even if no signature is provided
dzikowski
commented
Feb 3, 2025
| * Get the client's account ID from CA user identity. Not recommended for new code. | ||
| * @deprecated | ||
| */ | ||
| export function getCaIdentityAlias(ctx: Context): UserAlias { |
There was a problem hiding this comment.
also related with FulfillMint and similar calls. If mint is performed, it requires some user to check for allowances. For FullfillMint, we are going to provide a user alias that is derived from the CA user, as it was for SDK v1. Also this method was present in SDK v2 in a similar form.
- Updated `fulfillMintRequest` to pass calling user explicitly - Modified `validateMintRequest` to accept calling user as a parameter - Removed an unnecessary test case in `fulfillMint.spec.ts` - Updated signature methods in test files to remove redundant parameters - Added fallback for generating signer public key in ChainCallDTO These changes enhance user context handling and improve the flexibility of mint-related operations. Signed-off-by: Jakub Dzikowski <[email protected]>
- Implemented `validateMintRequestDtoMatchesOriginal` function to verify mint request integrity - Added comprehensive field-level validation in `fulfillMintRequest` - Created a new test case to verify protection against owner tampering - Throws a `ValidationFailedError` if any mint request details are modified This change enhances security by preventing unauthorized modifications to mint requests. Signed-off-by: Jakub Dzikowski <[email protected]>
dzikowski
commented
Feb 3, 2025
| @@ -442,7 +442,7 @@ describe("FulfillMint", () => { | |||
| expect(getWrites()).toEqual({}); | |||
| }); | |||
|
|
|||
| it("prevents attackers from exploiting the lack of signing requirement", async () => { | |||
| it("prevents attackers from tampering with mint request", async () => { | |||
There was a problem hiding this comment.
The previous version of the test relied solely on authorization feature that resolved ctx.callingUser from the signature even if the signature was not required. The issue however is broader - we need to verify if the dto provided in the FulfillMint call is the same as the one that is saved on chain. That's why a new validation function was added to fulfillMint.ts file - validateMintRequestDtoMatchesOriginal - which verifies the saved dto to match the one provided in fulfill call parameter.
Signed-off-by: Jakub Dzikowski <[email protected]>
Jehosephat
approved these changes
Feb 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.