Skip to main content
Factory function for creating BrandedStorageKey instances from contract address and storage slot.

​
Signature

function StorageKey(
  address: AddressType,
  slot: bigint
): BrandedStorageKey

​
Parameters

  • address (AddressType) - 20-byte contract address owning the storage slot
  • slot (bigint) - 256-bit storage slot number within the contract’s storage space

​
Returns

BrandedStorageKey - Composite key uniquely identifying the storage location

​
Examples

​
Basic Usage

    ​
    Multiple Slots

    import * as State from 'tevm/State';
import * as Address from 'tevm/Address';

const usdcAddress = Address("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48");

// Storage layout
const totalSupplyKey = State.StorageKey(usdcAddress, 0n);  // Slot 0
const balancesBaseKey = State.StorageKey(usdcAddress, 1n); // Slot 1
const allowancesKey = State.StorageKey(usdcAddress, 2n);   // Slot 2
const ownerKey = State.StorageKey(usdcAddress, 3n);        // Slot 3
const pausedKey = State.StorageKey(usdcAddress, 4n);       // Slot 4

    ​
    Storage Map Usage

    import * as State from 'tevm/State';

// Track storage across multiple contracts
const storage = new Map<string, bigint>();

// Store values using storage keys
const key1 = State.StorageKey(contractAddr, 0n);
const key2 = State.StorageKey(contractAddr, 1n);

storage.set(State.StorageKey.toString(key1), 1000000000n);
storage.set(State.StorageKey.toString(key2), 2000000000n);

// Retrieve values
const value1 = storage.get(State.StorageKey.toString(key1)); // 1000000000n
const value2 = storage.get(State.StorageKey.toString(key2)); // 2000000000n

    ​
    Computed Mapping Slots

    import * as State from 'tevm/State';
import * as Address from 'tevm/Address';
import { Keccak256 } from 'tevm/crypto';

// Compute storage slot for mapping: balances[userAddress]
function computeMappingSlot(key: Uint8Array, baseSlot: bigint): bigint {
  const encoded = Bytes64();
  encoded.set(new Uint8Array(32 - key.length).fill(0), 0);
  encoded.set(key, 32 - key.length);
  encoded.set(encodeBigInt(baseSlot, 32), 32);

  const hash = Keccak256.hash(encoded);
  return BigInt(Hex.fromBytes(hash));
}

const tokenAddress = Address("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48");
const userAddress = Address("0x742d35Cc6634C0532925a3b844Bc9e7595f51e3e");

// balances mapping at slot 1
const userBalanceSlot = computeMappingSlot(userAddress, 1n);
const userBalanceKey = State.StorageKey(tokenAddress, userBalanceSlot);

console.log(`User balance at slot: ${userBalanceSlot}`);