🪚 Add addChecksum utility to devtools-evm (#306)

LayerZero-Labs · Jan 30, 2024 · fac1c06 · fac1c06
1 parent b443aaa
commit fac1c06
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 1 deletion.
diff --git a/.changeset/khaki-nails-bow.md b/.changeset/khaki-nails-bow.md
@@ -0,0 +1,7 @@
+---
+"@layerzerolabs/build-lz-options": patch
+"@layerzerolabs/devtools-evm": patch
+"@layerzerolabs/toolbox-hardhat": patch
+---
+
+Add addChecksum utility
diff --git a/packages/build-lz-options/package.json b/packages/build-lz-options/package.json
@@ -32,6 +32,7 @@
     "yoga-layout-prebuilt": "^1.10.0"
   },
   "devDependencies": {
+    "@ethersproject/address": "~5.7.0",
     "@layerzerolabs/devtools": "~0.0.6",
     "@layerzerolabs/devtools-evm": "~0.0.7",
     "@layerzerolabs/io-devtools": "~0.0.5",

diff --git a/packages/devtools-evm/jest.config.js b/packages/devtools-evm/jest.config.js
@@ -2,6 +2,7 @@
 module.exports = {
     cache: false,
     testEnvironment: 'node',
+    setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
     moduleNameMapper: {
         '^@/(.*)$': '<rootDir>/src/$1',
     },

diff --git a/packages/devtools-evm/jest.setup.js b/packages/devtools-evm/jest.setup.js
@@ -0,0 +1,3 @@
+// add all jest-extended matchers
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+expect.extend(require('jest-extended'));
diff --git a/packages/devtools-evm/package.json b/packages/devtools-evm/package.json
@@ -41,6 +41,7 @@
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-provider": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
+    "@ethersproject/address": "~5.7.0",
     "@ethersproject/bignumber": "^5.7.0",
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
@@ -54,6 +55,7 @@
     "@types/jest": "^29.5.11",
     "fast-check": "^3.15.0",
     "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
     "ts-node": "^10.9.2",
     "tslib": "~2.6.2",
     "tsup": "~8.0.1",
@@ -64,6 +66,7 @@
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-provider": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
+    "@ethersproject/address": "~5.7.0",
     "@ethersproject/bignumber": "^5.7.0",
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",

diff --git a/packages/devtools-evm/src/address.ts b/packages/devtools-evm/src/address.ts
@@ -1,4 +1,5 @@
 import type { OmniAddress } from '@layerzerolabs/devtools'
+import { getAddress } from '@ethersproject/address'
 import { AddressZero } from '@ethersproject/constants'
 
 /**
@@ -9,3 +10,12 @@ import { AddressZero } from '@ethersproject/constants'
  * @returns {string}
  */
 export const makeZeroAddress = (address?: OmniAddress | null | undefined): string => address ?? AddressZero
+
+/**
+ * Applies checksum to a given address, lower/uppercasing
+ * necessary characters
+ *
+ * @param {OmniAddress} address
+ * @returns {OmniAddress}
+ */
+export const addChecksum = (address: OmniAddress): OmniAddress => getAddress(address)
diff --git a/packages/devtools-evm/test/address.test.ts b/packages/devtools-evm/test/address.test.ts
@@ -1,7 +1,10 @@
+/// <reference types="jest-extended" />
+
 import fc from 'fast-check'
 import { AddressZero } from '@ethersproject/constants'
 import { evmAddressArbitrary } from '@layerzerolabs/test-devtools'
-import { makeZeroAddress } from '@/address'
+import { addChecksum, makeZeroAddress } from '@/address'
+import { isAddress } from '@ethersproject/address'
 
 describe('address', () => {
     describe('makeZeroAddress', () => {
@@ -27,4 +30,22 @@ describe('address', () => {
             expect(makeZeroAddress(null)).toBe(AddressZero)
         })
     })
+
+    describe('addChecksum', () => {
+        it('should return the same address, just checksumed', () => {
+            fc.assert(
+                fc.property(evmAddressArbitrary, (address) => {
+                    expect(addChecksum(address)).toEqualCaseInsensitive(address)
+                })
+            )
+        })
+
+        it('should return a valid EVM address', () => {
+            fc.assert(
+                fc.property(evmAddressArbitrary, (address) => {
+                    expect(isAddress(addChecksum(address))).toBe(true)
+                })
+            )
+        })
+    })
 })
diff --git a/packages/toolbox-hardhat/package.json b/packages/toolbox-hardhat/package.json
@@ -30,6 +30,7 @@
   },
   "dependencies": {
     "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/address": "~5.7.0",
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/hash": "^5.7.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/ua-devtools-evm-hardhat-test/package.json b/tests/ua-devtools-evm-hardhat-test/package.json
@@ -19,6 +19,7 @@
     "@babel/core": "^7.23.7",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
+    "@ethersproject/address": "~5.7.0",
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",