Skip to content

Commit ead02d1

Browse files
committed
TSDOCs on patched function
1 parent f764fa3 commit ead02d1

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

patches/@metamask+controller-utils+11.7.0.patch

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
diff --git a/node_modules/@metamask/controller-utils/dist/util.d.cts b/node_modules/@metamask/controller-utils/dist/util.d.cts
2-
index f7e651b..ee30b81 100644
2+
index f7e651b..163b227 100644
33
--- a/node_modules/@metamask/controller-utils/dist/util.d.cts
44
+++ b/node_modules/@metamask/controller-utils/dist/util.d.cts
5-
@@ -114,7 +114,7 @@ export declare function safelyExecuteWithTimeout<Result>(operation: () => Promis
5+
@@ -113,8 +113,15 @@ export declare function safelyExecuteWithTimeout<Result>(operation: () => Promis
6+
*
67
* @param address - The address to convert.
78
* @returns The address in 0x-prefixed hexadecimal checksummed form if it is valid.
9+
+ *
10+
+ * PATCH NOTE: This patch change is meant to be temporary, so we don't require typecasting the return values for this function as Hex.
11+
+ * For more context on why this is necessary, check [following PR discussion](https://github.com/MetaMask/metamask-mobile/pull/13970#discussion_r2046580602).
12+
+ * Once the next steps are taken:
13+
+ * [Multichain API on Flask](https://github.com/MetaMask/metamask-extension/pull/27782)
14+
+ * [SIP-26 integration](https://github.com/MetaMask/metamask-extension/pull/29887)
15+
+ * We have an [issue](https://github.com/MetaMask/MetaMask-planning/issues/4694) in place to clean this up in controller-utils package
816
*/
917
-export declare function toChecksumHexAddress(address: string): string;
1018
+export declare function toChecksumHexAddress(address: string): Hex;

0 commit comments

Comments
 (0)