Skip to content

fix(sdk): Allow calculateAtomId to accept string | Hex for better DX #1194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeremie-olivier wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(sdk): Allow calculateAtomId to accept string | Hex for better DX #1194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
722bdf4
fix: Allow calculateAtomId to accept string | Hex instead of just Hex
jeremie-olivier Apr 17, 2026
3456c29
fix: Use isHex() instead of typeof to properly distinguish hex vs string
jeremie-olivier Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/protocol/tests/helpers/calculate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import type { Hex } from 'viem'
import { encodePacked, keccak256, toHex } from 'viem'
import { encodePacked, isHex, keccak256, stringToHex, toHex } from 'viem'

export function calculateAtomId(atomData: Hex) {
export function calculateAtomId(atomData: string | Hex) {
const salt = keccak256(toHex('ATOM_SALT'))
// Convert to hex if it's not already hex-encoded, ensuring safe input to keccak256
const hexData = isHex(atomData) ? atomData : stringToHex(atomData)
return keccak256(
encodePacked(['bytes32', 'bytes'], [salt, keccak256(atomData)]),
encodePacked(['bytes32', 'bytes'], [salt, keccak256(hexData)]),
)
}

Expand Down
10 changes: 6 additions & 4 deletions packages/sdk/src/utils/calculate-atom-id.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
import type { Hex } from 'viem'
import { encodePacked, keccak256, toHex } from 'viem'
import { encodePacked, isHex, keccak256, stringToHex, toHex } from 'viem'

/**
* Computes an atom ID by hashing the atom data with the ATOM_SALT.
* @param atomData Raw atom data as hex.
* @param atomData Raw atom data as string or hex.
* @returns Keccak256 hash representing the atom ID.
*/
export function calculateAtomId(atomData: Hex) {
export function calculateAtomId(atomData: string | Hex) {
const salt = keccak256(toHex('ATOM_SALT'))
// Convert to hex if it's not already hex-encoded, ensuring safe input to keccak256
const hexData = isHex(atomData) ? atomData : stringToHex(atomData)
return keccak256(
encodePacked(['bytes32', 'bytes'], [salt, keccak256(atomData)]),
encodePacked(['bytes32', 'bytes'], [salt, keccak256(hexData)]),
)
}
Loading