@frequency-chain/ethereum-utils 0.0.0-82b111 → 0.0.0-95dcbc

package/browser/frequency-ethereum-utils.esm.min.js

@@ -19823,13 +19823,27 @@ function createPasskeyPublicKey(publicKey) {
         publicKey: parsedNewPublicKey,
     };
 }
+/**
+ * Build AddAction payload for Itemized storage.
+ *
+ * @param data The data to be persisted on the Frequency chain
+ */
 function createItemizedAddAction(data) {
     const parsedData = typeof data === 'object' ? u8aToHex(data) : data;
     assert(isHexString(parsedData), 'itemized data should be valid hex');
+    // since Metamask does not support union types, we have to include all fields and have to set the `index` value to zero
+    // even though it is not used for Add action
     return { actionType: 'Add', data, index: 0 };
 }
+/**
+ * Build DeleteAction payload for Itemized storage.
+ *
+ * @param index The index of the item that we want to remove from the Frequency chain
+ */
 function createItemizedDeleteAction(index) {
     assert(isValidUint16(index), 'itemized index should be a valid uint16');
+    // since Metamask does not support union types, we have to include all fields and have to set the `data` value to 0x
+    // even though it is not used for Delete action
     return { actionType: 'Delete', data: '0x', index };
 }
 /**

package/browser/frequency-ethereum-utils.umd.min.js

@@ -11069,13 +11069,27 @@ function createPasskeyPublicKey(publicKey) {
         publicKey: parsedNewPublicKey,
     };
 }
+/**
+ * Build AddAction payload for Itemized storage.
+ *
+ * @param data The data to be persisted on the Frequency chain
+ */
 function createItemizedAddAction(data) {
     const parsedData = typeof data === 'object' ? u8aToHex(data) : data;
     assert(isHexString(parsedData), 'itemized data should be valid hex');
+    // since Metamask does not support union types, we have to include all fields and have to set the `index` value to zero
+    // even though it is not used for Add action
     return { actionType: 'Add', data, index: 0 };
 }
+/**
+ * Build DeleteAction payload for Itemized storage.
+ *
+ * @param index The index of the item that we want to remove from the Frequency chain
+ */
 function createItemizedDeleteAction(index) {
     assert(isValidUint16(index), 'itemized index should be a valid uint16');
+    // since Metamask does not support union types, we have to include all fields and have to set the `data` value to 0x
+    // even though it is not used for Delete action
     return { actionType: 'Delete', data: '0x', index };
 }
 /**

package/cjs/signature.js

@@ -247,13 +247,27 @@ function createPasskeyPublicKey(publicKey) {
         publicKey: parsedNewPublicKey,
     };
 }
+/**
+ * Build AddAction payload for Itemized storage.
+ *
+ * @param data The data to be persisted on the Frequency chain
+ */
 function createItemizedAddAction(data) {
     const parsedData = typeof data === 'object' ? (0, util_1.u8aToHex)(data) : data;
     (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedData), 'itemized data should be valid hex');
+    // since Metamask does not support union types, we have to include all fields and have to set the `index` value to zero
+    // even though it is not used for Add action
     return { actionType: 'Add', data, index: 0 };
 }
+/**
+ * Build DeleteAction payload for Itemized storage.
+ *
+ * @param index The index of the item that we want to remove from the Frequency chain
+ */
 function createItemizedDeleteAction(index) {
     (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(index), 'itemized index should be a valid uint16');
+    // since Metamask does not support union types, we have to include all fields and have to set the `data` value to 0x
+    // even though it is not used for Delete action
     return { actionType: 'Delete', data: '0x', index };
 }
 /**

package/esm/signature.js

@@ -218,13 +218,27 @@ export function createPasskeyPublicKey(publicKey) {
         publicKey: parsedNewPublicKey,
     };
 }
+/**
+ * Build AddAction payload for Itemized storage.
+ *
+ * @param data The data to be persisted on the Frequency chain
+ */
 export function createItemizedAddAction(data) {
     const parsedData = typeof data === 'object' ? u8aToHex(data) : data;
     assert(isHexString(parsedData), 'itemized data should be valid hex');
+    // since Metamask does not support union types, we have to include all fields and have to set the `index` value to zero
+    // even though it is not used for Add action
     return { actionType: 'Add', data, index: 0 };
 }
+/**
+ * Build DeleteAction payload for Itemized storage.
+ *
+ * @param index The index of the item that we want to remove from the Frequency chain
+ */
 export function createItemizedDeleteAction(index) {
     assert(isValidUint16(index), 'itemized index should be a valid uint16');
+    // since Metamask does not support union types, we have to include all fields and have to set the `data` value to 0x
+    // even though it is not used for Delete action
     return { actionType: 'Delete', data: '0x', index };
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frequency-chain/ethereum-utils",
-  "version": "0.0.0-82b111",
+  "version": "0.0.0-95dcbc",
   "bugs": {
     "url": "https://github.com/frequency-chain/frequency/issues"
   },

package/signature.d.ts

@@ -60,7 +60,17 @@ export declare function createClaimHandlePayload(handle: string, expirationBlock
  * @param publicKey The passkey’s public key (hex string or raw bytes)
  */
 export declare function createPasskeyPublicKey(publicKey: HexString | Uint8Array): PasskeyPublicKey;
+/**
+ * Build AddAction payload for Itemized storage.
+ *
+ * @param data The data to be persisted on the Frequency chain
+ */
 export declare function createItemizedAddAction(data: HexString | Uint8Array): AddItemizedAction;
+/**
+ * Build DeleteAction payload for Itemized storage.
+ *
+ * @param index The index of the item that we want to remove from the Frequency chain
+ */
 export declare function createItemizedDeleteAction(index: number): DeleteItemizedAction;
 /**
  * Build an ItemizedSignaturePayloadV2 for signing.