Aptos address normalization (#121)

streamflow-finance · Jan 4, 2024 · 3b8c8c1 · 3b8c8c1
1 parent da5c995
commit 3b8c8c1
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/packages/stream/aptos/utils.ts b/packages/stream/aptos/utils.ts
@@ -17,7 +17,11 @@ function isAddressSpecial(address: string): boolean {
   return false;
 }
 
-// Per this: https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/core/accountAddress.ts#L115
+/**
+ * Aptos has inconsistencies in how it returns addresses.
+ * This method normalizes them to be 64 characters long, or leaves it as SPECIAL ADDRESS (0x0 - 0xf inclusive)
+ * Per this: https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/core/accountAddress.ts#L115
+ * */
 export function normalizeAptosAddress(address: string): string {
   if (isAddressSpecial(address)) {
     return address;