[BOOST-5212] [sdk] normalize UNIT hex to intended value (#378)

boostxyz · Jan 23, 2025 · 3ac1685 · 3ac1685
1 parent 23ceab9
commit 3ac1685
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 32 deletions.
diff --git a/.changeset/few-grapes-hug.md b/.changeset/few-grapes-hug.md
@@ -0,0 +1,5 @@
+---
+"@boostxyz/sdk": minor
+---
+
+normalize UINT hex to intended value
diff --git a/packages/sdk/src/Actions/EventAction.ts b/packages/sdk/src/Actions/EventAction.ts
@@ -28,6 +28,7 @@ import {
   isAddressEqual,
   pad,
   toEventSelector,
+  trim,
   zeroAddress,
   zeroHash,
 } from 'viem';
@@ -1407,6 +1408,43 @@ export function detectSignatureType(signature: Hex): SignatureType {
   throw new Error('Invalid signature format');
 }
 
+/**
+ * Normalizes a hex value to ensure proper byte padding.
+ * This prevents viem's automatic padding which can change the value.
+ * For example:
+ * - "0x1" -> "0x01"
+ * - "0xabc" -> "0x0abc"
+ * - "0xabcd" -> "0xabcd"
+ *
+ * @param {Hex} value - The hex value to normalize
+ * @returns {Hex} The normalized hex string
+ */
+function normalizeUintValue(value: Hex): Hex {
+  return trim(pad(value));
+}
+
+/**
+ * Helper function to prepare an action step for encoding
+ *
+ * @param {ActionStep} step - The action step to prepare
+ * @returns {ActionStep} The prepared action step
+ */
+function prepareActionStep(step: ActionStep) {
+  return {
+    ..._toRawActionStep(step),
+    signatureType: step.signatureType ?? detectSignatureType(step.signature),
+    signature: pad(step.signature),
+    actionType: step.actionType || 0,
+    actionParameter:
+      step.actionParameter.fieldType === PrimitiveType.UINT
+        ? {
+            ...step.actionParameter,
+            filterData: normalizeUintValue(step.actionParameter.filterData),
+          }
+        : step.actionParameter,
+  };
+}
+
 /**
  * Function to properly encode an event action payload.
  *
@@ -1539,38 +1577,10 @@ export function prepareEventActionPayload({
             detectSignatureType(actionClaimant.signature),
           signature: pad(actionClaimant.signature),
         },
-        actionStepOne: {
-          ..._toRawActionStep(actionStepOne),
-          signatureType:
-            actionStepOne.signatureType ??
-            detectSignatureType(actionStepOne.signature),
-          signature: pad(actionStepOne.signature),
-          actionType: actionStepOne.actionType || 0,
-        },
-        actionStepTwo: {
-          ..._toRawActionStep(actionStepTwo),
-          signatureType:
-            actionStepTwo.signatureType ??
-            detectSignatureType(actionStepTwo.signature),
-          signature: pad(actionStepTwo.signature),
-          actionType: actionStepTwo.actionType || 0,
-        },
-        actionStepThree: {
-          ..._toRawActionStep(actionStepThree),
-          signatureType:
-            actionStepThree.signatureType ??
-            detectSignatureType(actionStepThree.signature),
-          signature: pad(actionStepThree.signature),
-          actionType: actionStepThree.actionType || 0,
-        },
-        actionStepFour: {
-          ..._toRawActionStep(actionStepFour),
-          signatureType:
-            actionStepFour.signatureType ??
-            detectSignatureType(actionStepFour.signature),
-          signature: pad(actionStepFour.signature),
-          actionType: actionStepFour.actionType || 0,
-        },
+        actionStepOne: prepareActionStep(actionStepOne),
+        actionStepTwo: prepareActionStep(actionStepTwo),
+        actionStepThree: prepareActionStep(actionStepThree),
+        actionStepFour: prepareActionStep(actionStepFour),
       },
     ],
   );