@feelyourprotocol/statemanager 8141.0.0

package/src/types.ts

@@ -0,0 +1,103 @@
+import { type PrefixedHexString } from '@feelyourprotocol/util'
+
+import type { BinaryTree } from '@feelyourprotocol/binarytree'
+import type { Common } from '@feelyourprotocol/common'
+import type { MerklePatriciaTrie } from '@feelyourprotocol/mpt'
+import type { Caches } from './index.ts'
+/**
+ * Basic state manager options (not to be used directly)
+ */
+interface BaseStateManagerOpts {
+  /**
+   * The common to use
+   */
+  common?: Common
+}
+
+/**
+ * Options for constructing a {@link SimpleStateManager}.
+ */
+export interface SimpleStateManagerOpts extends BaseStateManagerOpts {
+  // Keep this as an alias so that it might be able to extend in the future
+}
+
+export interface RPCStateManagerOpts extends BaseStateManagerOpts {
+  provider: string
+  blockTag: bigint | 'earliest'
+}
+
+/**
+ * Options for constructing a {@link StateManager}.
+ */
+export interface MerkleStateManagerOpts extends BaseStateManagerOpts {
+  /**
+   * A {@link MerklePatriciaTrie} instance
+   */
+  trie?: MerklePatriciaTrie
+  /**
+   * Option to prefix codehashes in the database. This defaults to `true`.
+   * If this is disabled, note that it is possible to corrupt the trie, by deploying code
+   * which code is equal to the preimage of a trie-node.
+   * E.g. by putting the code `0x80` into the empty trie, will lead to a corrupted trie.
+   */
+  prefixCodeHashes?: boolean
+
+  /**
+   * Option to prefix the keys for the storage tries with the first 7 bytes from the
+   * associated account address. Activating this option gives a noticeable performance
+   * boost for storage DB reads when operating on larger tries.
+   *
+   * Note: Activating/deactivating this option causes continued state reads to be
+   * incompatible with existing databases.
+   *
+   * Default: false (for backwards compatibility reasons)
+   */
+  prefixStorageTrieKeys?: boolean
+
+  /**
+   * Options to enable and configure the use of a cache account, code and storage
+   * This can be useful for speeding up reads, especially when the trie is large.
+   * The cache is only used for reading from the trie and is not used for writing to the trie.
+   *
+   * Default: false
+   */
+  caches?: Caches
+}
+
+/**
+ * Options dictionary.
+ */
+export interface StatelessVerkleStateManagerOpts extends BaseStateManagerOpts {
+  common: Common // Common required since it provides verkleCrypto through customCrypto
+  caches?: Caches
+}
+
+export interface StatefulBinaryTreeStateManagerOpts extends BaseStateManagerOpts {
+  hashFunction?: (data: Uint8Array) => Uint8Array
+  tree?: BinaryTree
+  caches?: Caches
+}
+
+export interface BinaryTreeState {
+  [key: PrefixedHexString]: PrefixedHexString | null
+}
+
+export interface EncodedBinaryTreeState {
+  [key: PrefixedHexString]: PrefixedHexString | null
+}
+
+export type StorageProof = {
+  key: PrefixedHexString
+  proof: PrefixedHexString[]
+  value: PrefixedHexString
+}
+
+export type Proof = {
+  address: PrefixedHexString
+  balance: PrefixedHexString
+  codeHash: PrefixedHexString
+  nonce: PrefixedHexString
+  storageHash: PrefixedHexString
+  accountProof: PrefixedHexString[]
+  storageProof: StorageProof[]
+}

package/src/util.ts

@@ -0,0 +1,28 @@
+import { Account, bytesToHex } from '@feelyourprotocol/util'
+
+import type { AccountFields, StateManagerInterface } from '@feelyourprotocol/common'
+import type { Address } from '@feelyourprotocol/util'
+
+export async function modifyAccountFields(
+  stateManager: StateManagerInterface,
+  address: Address,
+  accountFields: AccountFields,
+): Promise<void> {
+  const account = (await stateManager.getAccount(address)) ?? new Account()
+
+  account.nonce = accountFields.nonce ?? account.nonce
+  account.balance = accountFields.balance ?? account.balance
+  account.storageRoot = accountFields.storageRoot ?? account.storageRoot
+  account.codeHash = accountFields.codeHash ?? account.codeHash
+  account.codeSize = accountFields.codeSize ?? account.codeSize
+  //@ts-expect-error -- Checking for an instantiated property that is not part of the interface
+  if (stateManager['_debug'] !== undefined) {
+    for (const [field, value] of Object.entries(accountFields)) {
+      //@ts-expect-error -- Accessing an instantiated property that is not part of the interface
+      stateManager['_debug'](
+        `modifyAccountFields address=${address.toString()} ${field}=${value instanceof Uint8Array ? bytesToHex(value) : value} `,
+      )
+    }
+  }
+  await stateManager.putAccount(address, account)
+}