Make an option to make addresses lower case

Author: JasoonS

codegenerator/cli/npm/envio/src/Address.res

@@ -10,6 +10,28 @@ external unsafeFromString: string => t = "%identity"
 module Evm = {
   @module("viem")
   external fromStringOrThrow: string => t = "getAddress"
+
+  // NOTE: We could use a regex for this instead, not sure if it is faster/slower than viem's 'isAddress' function
+  //       `/^0x[a-fA-F0-9]{40}$/`
+  @module("viem") @private
+  external isAddress: string => bool = "isAddress"
+
+  // Validate that the string is a proper address but return a lowercased value
+  let fromStringLowercaseOrThrow = string => {
+    // NOTE: We could use a regex for this and make this function more strict, so it only accepts lower case addresses as input
+    //       eg this regex: `/^0x[a-f0-9]{40}$/`
+    if (isAddress(string)) {
+      unsafeFromString(string->Js.String2.toLowerCase)
+    } else {
+      Js.Exn.raiseError(
+        `Address "${string}" is invalid. Expected a 20-byte hex string starting with 0x.`,
+      )
+    }
+  }
+
+  let fromAddressLowercaseOrThrow = address =>
+    address->toString->fromStringLowercaseOrThrow
+
   // Reassign since the function might be used in the handler code
   // and we don't want to have a "viem" import there. It's needed to keep "viem" a dependency
   // of generated code instead of adding it to the indexer project dependencies.

codegenerator/cli/npm/envio/src/sources/HyperSyncClient.res

@@ -448,10 +448,16 @@ type t = {
 }
 
 @module("@envio-dev/hypersync-client") @scope("HypersyncClient") external make: cfg => t = "new"
-let make = (~url, ~apiToken, ~httpReqTimeoutMillis, ~maxNumRetries) =>
+let make = (
+  ~url,
+  ~apiToken,
+  ~httpReqTimeoutMillis,
+  ~maxNumRetries,
+  ~enableChecksumAddresses=true,
+) =>
   make({
     url,
-    enableChecksumAddresses: true,
+    enableChecksumAddresses,
     bearerToken: apiToken,
     httpReqTimeoutMillis,
     maxNumRetries,

codegenerator/cli/src/cli_args/init_config.rs

@@ -171,6 +171,7 @@ pub mod evm {
                 field_selection: None,
                 raw_events: None,
                 preload_handlers: Some(true),
+                lowercase_addresses: None,
             })
         }
 

codegenerator/cli/src/config_parsing/graph_migration/mod.rs

@@ -285,6 +285,7 @@ pub async fn generate_config_from_subgraph_id(
         field_selection: None,
         raw_events: None,
         preload_handlers: Some(true),
+        lowercase_addresses: None,
     };
     let mut networks: Vec<Network> = vec![];
 

codegenerator/cli/src/config_parsing/human_config.rs

@@ -209,6 +209,11 @@ pub mod evm {
             description = "Makes handlers run twice to enable preload optimisations. Removes handlerWithLoader API, since it's not needed. (recommended, default: false)"
         )]
         pub preload_handlers: Option<bool>,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        #[schemars(
+            description = "If true, Ethereum addresses are kept lowercase (no checksum) across the indexer (default: false)"
+        )]
+        pub lowercase_addresses: Option<bool>,
     }
 
     impl Display for HumanConfig {

codegenerator/cli/src/config_parsing/system_config.rs

@@ -414,6 +414,7 @@ pub struct SystemConfig {
     pub enable_raw_events: bool,
     pub preload_handlers: bool,
     pub human_config: HumanConfig,
+    pub lowercase_addresses: bool,
 }
 
 //Getter methods for system config
@@ -721,6 +722,7 @@ impl SystemConfig {
                     field_selection,
                     enable_raw_events: evm_config.raw_events.unwrap_or(false),
                     preload_handlers: evm_config.preload_handlers.unwrap_or(false),
+                    lowercase_addresses: evm_config.lowercase_addresses.unwrap_or(false),
                     human_config,
                 })
             }
@@ -858,6 +860,7 @@ impl SystemConfig {
                     field_selection: FieldSelection::fuel(),
                     enable_raw_events: fuel_config.raw_events.unwrap_or(false),
                     preload_handlers: fuel_config.preload_handlers.unwrap_or(false),
+                    lowercase_addresses: false,
                     human_config,
                 })
             }
@@ -2085,6 +2088,7 @@ mod test {
             field_selection: None,
             raw_events: None,
             preload_handlers: None,
+            lowercase_addresses: None,
         };
 
         let project_paths = ParsedProjectPaths::new(".", "generated", "config.yaml").unwrap();
@@ -2131,6 +2135,7 @@ mod test {
             field_selection: None,
             raw_events: None,
             preload_handlers: None,
+            lowercase_addresses: None,
         };
 
         let system_config_with_output = SystemConfig::from_human_config(

codegenerator/cli/src/hbs_templating/codegen_templates.rs

@@ -1123,7 +1123,8 @@ impl NetworkConfigTemplate {
                     format!(
                         "NetworkSources.evm(~chain, ~contracts=[{contracts_code}], ~hyperSync={hyper_sync_code}, \
                          ~allEventSignatures=[{all_event_signatures}]->Belt.Array.concatMany, \
-                         ~shouldUseHypersyncClientDecoder={is_client_decoder}, ~rpcs=[{rpcs}])"
+                         ~shouldUseHypersyncClientDecoder={is_client_decoder}, ~rpcs=[{rpcs}], ~lowercaseAddresses={})",
+                        if config.lowercase_addresses { "true" } else { "false" }
                     ),
                     deprecated_sync_source_code,
                 )
@@ -1278,6 +1279,7 @@ pub struct ProjectTemplate {
     envio_version: String,
     //Used for the package.json reference to handlers in generated
     relative_path_to_root_from_generated: String,
+    lowercase_addresses: bool,
 }
 
 impl ProjectTemplate {
@@ -1384,6 +1386,7 @@ impl ProjectTemplate {
             envio_version: get_envio_version()?,
             //Used for the package.json reference to handlers in generated
             relative_path_to_root_from_generated,
+            lowercase_addresses: cfg.lowercase_addresses,
         })
     }
 }

codegenerator/cli/templates/dynamic/codegen/src/ConfigYAML.res.hbs

@@ -27,6 +27,7 @@ type configYaml = {
   startBlock: int,
   confirmedBlockThreshold: int,
   contracts: dict<contract>,
+  lowercaseAddresses: bool,
 }
 
 let publicConfig = ChainMap.fromArrayUnsafe([
@@ -60,7 +61,8 @@ let publicConfig = ChainMap.fromArrayUnsafe([
         confirmedBlockThreshold: {{chain_config.network_config.confirmed_block_threshold}},
         syncSource: {{chain_config.deprecated_sync_source_code}},
         startBlock: {{chain_config.network_config.start_block}},
-        contracts
+        contracts,
+        lowercaseAddresses: {{#if ../lowercase_addresses}}true{{else}}false{{/if}}
       }
     )
   },

codegenerator/cli/templates/dynamic/codegen/src/RegisterHandlers.res.hbs

@@ -35,7 +35,11 @@ let registerContractHandlers = (
             addresses: [
               {{#each contract.addresses as | address |}}
               {{#if ../../../is_evm_ecosystem}}
+              {{#if ../../../../lowercase_addresses}}
+              "{{address}}"->Address.Evm.fromStringLowercaseOrThrow
+              {{else}}
               "{{address}}"->Address.Evm.fromStringOrThrow
+              {{/if}}
               {{else}}
               "{{address}}"->Address.unsafeFromString
               {{/if}},
@@ -71,6 +75,7 @@ let registerContractHandlers = (
       ~isUnorderedMultichainMode={{is_unordered_multichain_mode}},
       ~chains,
       ~enableRawEvents={{enable_raw_events}},
+      ~lowercaseAddresses={{lowercase_addresses}},
       {{#if chain_config.is_fuel}}
       ~ecosystem=Fuel,
       {{/if}}

codegenerator/cli/templates/static/codegen/src/Config.res

@@ -128,6 +128,7 @@ type t = {
   persistence: Persistence.t,
   addContractNameToContractNameMapping: dict<string>,
   maxAddrInPartition: int,
+  lowercaseAddresses: bool,
 }
 
 let make = (
@@ -138,6 +139,7 @@ let make = (
   ~enableRawEvents=false,
   ~persistence=codegenPersistence,
   ~ecosystem=Evm,
+  ~lowercaseAddresses=false,
 ) => {
   let chainMap =
     chains
@@ -172,6 +174,7 @@ let make = (
     ecosystem,
     addContractNameToContractNameMapping,
     maxAddrInPartition: Env.maxAddrInPartition,
+    lowercaseAddresses,
   }
 }