@relay-protocol/hub-utils 0.1.0

package/eslint.config.js

@@ -0,0 +1,2 @@
+const sharedConfig = require("@relay-protocol/eslint-config")
+module.exports = [...sharedConfig]

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@relay-protocol/hub-utils",
+  "version": "0.1.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --watch --dts",
+    "lint": "lint",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "@relay-protocol/eslint-config": "workspace:*",
+    "@relay-protocol/tsconfig": "workspace:*",
+    "eslint": "9.36.0",
+    "tsup": "8.5.0",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4"
+  },
+  "dependencies": {
+    "@relay-protocol/types": "workspace:*"
+  }
+}

package/src/address.test.ts

@@ -0,0 +1,21 @@
+import { describe, expect, test } from "vitest"
+import { generateAddress } from "./address"
+import { addressesTestCases } from "@relay-protocol/fixtures"
+import { ethers } from "ethers"
+
+describe("Virtual Addresses", () => {
+  test.each(addressesTestCases)("$name", ({ input, expectedAddress }) => {
+    const address = generateAddress(input)
+
+    const differentInput = {
+      ...input,
+      chainId: input.chainId + 1n,
+    }
+    const differentAddress = generateAddress(differentInput)
+    expect(address).not.toBe(differentAddress)
+    expect(address).toBe(expectedAddress)
+
+    // address with correct checksum
+    expect(ethers.getAddress(expectedAddress)).toBe(expectedAddress)
+  })
+})

package/src/address.ts

@@ -0,0 +1,27 @@
+import { VirtualAddress, VirtualAddressComponents } from "@relay-protocol/types"
+import { ethers } from "ethers"
+
+import { getCheckSummedAddress } from "./utils"
+
+/**
+ * Generates a virtual Ethereum address from token components
+ * @param components The token components (family, chainId, address)
+ * @returns A checksummed Ethereum address derived from the token ID
+ * @remarks This function first generates a token ID using the components,
+ * then converts the last 20 bytes of the hash to an Ethereum address.
+ * This is equivalent to the Solidity: address(uint160(uint256(addressHash)))
+ */
+
+export function generateAddress(
+  components: VirtualAddressComponents
+): VirtualAddress {
+  const { chainId, address, family } = components
+  const addressHash = ethers.keccak256(
+    ethers.solidityPacked(
+      ["string", "uint256", family === "ethereum-vm" ? "address" : "string"],
+      [family, chainId, getCheckSummedAddress(family, address)]
+    )
+  )
+  const addressBytes = addressHash.slice(2).slice(-40)
+  return ethers.getAddress("0x" + addressBytes) as `0x${string}`
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Collection of utility functions for the Relay Protocol Hub
+ */
+
+export * from "./token"
+export * from "./address"
+export * from "./intent"

package/src/intent.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from "vitest"
+import { intentTestCases } from "@relay-protocol/fixtures"
+import { generateIntentAddress } from "./intent"
+import { ethers } from "ethers"
+
+describe("Intent Ids", () => {
+  test.each(intentTestCases)("$name", ({ id, expectedAddress }) => {
+    const address = generateIntentAddress(id)
+    expect(address).toBe(expectedAddress)
+    // address with correct checksum
+    expect(ethers.getAddress(expectedAddress)).toBe(expectedAddress)
+  })
+})

package/src/intent.ts

@@ -0,0 +1,11 @@
+import { ethers } from "ethers"
+import { VirtualAddress } from "@relay-protocol/types"
+
+export const generateIntentAddress = (intentId: string): VirtualAddress => {
+  const addressHash = ethers.keccak256(
+    ethers.solidityPacked(["string"], [intentId])
+  )
+  return ethers.getAddress(
+    "0x" + addressHash.slice(2).slice(-40)
+  ) as `0x${string}`
+}

package/src/token.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, test } from "vitest"
+import { generateTokenId } from "./token"
+import { tokenIdTestCases } from "@relay-protocol/fixtures"
+import { TokenIdComponents } from "@relay-protocol/types"
+
+describe("Token ID Generation", () => {
+  test.each(tokenIdTestCases)("$name", ({ input, expectedValue }) => {
+    const tokenId = generateTokenId(input)
+
+    const differentInput = {
+      ...input,
+      chainId: input.chainId + 1n,
+    }
+    const differentTokenId = generateTokenId(differentInput)
+    expect(tokenId).not.toBe(differentTokenId)
+    expect(tokenId).toBe(expectedValue)
+  })
+
+  test("should handle case-insensitive EVM addresses", () => {
+    const addr = "0xdAC17F958D2ee523a2206206994597C13D831ec7"
+    const input1: TokenIdComponents = {
+      address: addr,
+      chainId: 1n,
+      family: "ethereum-vm",
+    }
+    const input2: TokenIdComponents = {
+      address: addr.toLowerCase(),
+      chainId: 1n,
+      family: "ethereum-vm",
+    }
+
+    expect(generateTokenId(input1)).toBe(generateTokenId(input2))
+  })
+})

package/src/token.ts

@@ -0,0 +1,17 @@
+import { ethers } from "ethers"
+import { TokenIdComponents, TokenId } from "@relay-protocol/types"
+import { getCheckSummedAddress } from "./utils"
+
+/**
+ * Generates a token ID based on the chain type, chain ID, and address
+ * @param components The token components (family, chainId, address)
+ * @returns The keccak256 hash of the token components
+ */
+export function generateTokenId(components: TokenIdComponents): TokenId {
+  const { family, chainId, address } = components
+  const packedData = ethers.solidityPacked(
+    ["string", "uint256", family === "ethereum-vm" ? "address" : "string"],
+    [family, chainId, getCheckSummedAddress(family, address)]
+  )
+  return BigInt(ethers.keccak256(packedData))
+}

package/src/utils.ts

@@ -0,0 +1,7 @@
+import { ethers } from "ethers"
+
+export const getCheckSummedAddress = (family: string, address: string) => {
+  const checksummedAddress =
+    family === "ethereum-vm" ? ethers.getAddress(address) : address
+  return checksummedAddress
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@relay-protocol/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config"
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    globals: true,
+    include: ["src/**/*.test.ts"],
+  },
+})